Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup: fix function name #1255

Closed
wants to merge 1 commit into from

Conversation

clebergnu
Copy link

No description provided.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 8, 2022

Welcome to GitGitGadget

Hi @clebergnu, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that your Pull Request has a good description, as it will be used as cover letter. You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@gitgitgadget gitgitgadget bot added the new user label Jun 8, 2022
The reference given to users when the result of
setup_git_directory_gently_1() is unexpected is incorrect.

This fixes the name of the function when presenting the BUG message.

Signed-off-by: Cleber Rosa <crosa@redhat.com>
@dscho
Copy link
Member

dscho commented Jun 9, 2022

/allow

@dscho
Copy link
Member

dscho commented Jun 9, 2022

Interesting find. I am curious: how did you stumble over this? Did you hit that bug?

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 9, 2022

User clebergnu is now allowed to use GitGitGadget.

WARNING: clebergnu has no public email address set on GitHub;
GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@clebergnu
Copy link
Author

Interesting find. I am curious: how did you stumble over this? Did you hit that bug?

I stumbled over this while following the behavior of git config on "unsafe" repositories. I have a pet peeve with the current error message being given on git config --local on an unsafe repository:

$ ~/src/git/git-config --local user.email "foo@bar.com"
fatal: --local can only be used inside a git repository

And I'm looking into making the message the same one would get with other git commands:

$ ~/src/git/git-rev-parse HEAD
fatal: unsafe repository ('/tmp/t3' is owned by someone else)
To add an exception for this directory, call:

        git config --global --add safe.directory /tmp/t3

I just thought I'd get the "first time contributor" out of the way before sending that other work.

@clebergnu
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 9, 2022

Submitted as pull.1255.git.1654782920256.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1255/clebergnu/fix_function_name-v1

To fetch this version to local tag pr-1255/clebergnu/fix_function_name-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1255/clebergnu/fix_function_name-v1

@clebergnu
Copy link
Author

@dscho since I got your attention, would it possible for you to review the patch on the ML? Thanks a lot!

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 17, 2022

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Cleber Rosa via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Cleber Rosa <crosa@redhat.com>
> Subject: Re: [PATCH] setup: fix function name

I'd add "in a BUG() message" at the end.

> diff --git a/setup.c b/setup.c
> index faf5095e44d..b5a537258d2 100644
> --- a/setup.c
> +++ b/setup.c
> @@ -1402,7 +1402,7 @@ const char *setup_git_directory_gently(int *nongit_ok)
>  		 * find a repository.
>  		 */
>  	default:
> -		BUG("unhandled setup_git_directory_1() result");
> +		BUG("unhandled setup_git_directory_gently_1() result");
>  	}

Did you actually hit this BUG() and was sent to a wild goose chase
because of this typo?  Just checking, because BUG() that triggers
is a more serious issue itself.

Thanks.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 17, 2022

This branch is now known as cr/setup-bug-typo.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 17, 2022

This patch series was integrated into seen via git@cbb3d88.

@gitgitgadget gitgitgadget bot added the seen label Jun 17, 2022
@gitgitgadget
Copy link

gitgitgadget bot commented Jun 18, 2022

This patch series was integrated into seen via git@eb83aea.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 18, 2022

This patch series was integrated into next via git@8834ffe.

@gitgitgadget gitgitgadget bot added the next label Jun 18, 2022
@gitgitgadget
Copy link

gitgitgadget bot commented Jun 18, 2022

This patch series was integrated into seen via git@c0ef9f7.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 18, 2022

There was a status update in the "New Topics" section about the branch cr/setup-bug-typo on the Git mailing list:

Typofix in a BUG() message.

Will cook in 'next'.
source: <pull.1255.git.1654782920256.gitgitgadget@gmail.com>

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 21, 2022

This patch series was integrated into seen via git@129ff80.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 21, 2022

This patch series was integrated into seen via git@dc9fced.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 22, 2022

This patch series was integrated into seen via git@26b7127.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 22, 2022

There was a status update in the "Cooking" section about the branch cr/setup-bug-typo on the Git mailing list:

Typofix in a BUG() message.

Will cook in 'next'.
source: <pull.1255.git.1654782920256.gitgitgadget@gmail.com>

@dscho
Copy link
Member

dscho commented Jun 23, 2022

@dscho since I got your attention, would it possible for you to review the patch on the ML? Thanks a lot!

Sorry, I was too bogged down in other tasks.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 23, 2022

This patch series was integrated into seen via git@21e1980.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 23, 2022

This patch series was integrated into seen via git@54e0ca7.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 27, 2022

This patch series was integrated into seen via git@bd4351a.

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 27, 2022

There was a status update in the "Cooking" section about the branch cr/setup-bug-typo on the Git mailing list:

Typofix in a BUG() message.

Will cook in 'next'.
source: <pull.1255.git.1654782920256.gitgitgadget@gmail.com>

@gitgitgadget
Copy link

gitgitgadget bot commented Jun 29, 2022

This patch series was integrated into seen via git@659b99f.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 1, 2022

There was a status update in the "Cooking" section about the branch cr/setup-bug-typo on the Git mailing list:

Typofix in a BUG() message.

Will cook in 'next'.
source: <pull.1255.git.1654782920256.gitgitgadget@gmail.com>

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 3, 2022

This patch series was integrated into seen via git@08813ae.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 6, 2022

This patch series was integrated into seen via git@210b360.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 8, 2022

This patch series was integrated into seen via git@6980215.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 9, 2022

There was a status update in the "Cooking" section about the branch cr/setup-bug-typo on the Git mailing list:

Typofix in a BUG() message.

Will cook in 'next'.
source: <pull.1255.git.1654782920256.gitgitgadget@gmail.com>

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 10, 2022

This patch series was integrated into seen via git@2c22b2d.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 10, 2022

This patch series was integrated into seen via git@50ac024.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 11, 2022

This patch series was integrated into seen via git@6d65013.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 11, 2022

This patch series was integrated into master via git@6d65013.

@gitgitgadget
Copy link

gitgitgadget bot commented Jul 11, 2022

This patch series was integrated into next via git@6d65013.

@gitgitgadget gitgitgadget bot added the master label Jul 11, 2022
@gitgitgadget gitgitgadget bot closed this Jul 11, 2022
@gitgitgadget
Copy link

gitgitgadget bot commented Jul 11, 2022

Closed via 6d65013.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants