search

gitgitgadget / git

GitGitGadget's Git fork. Open Pull Requests here to submit them to the Git mailing list
https://gitgitgadget.github.io/
Other
222 stars 133 forks source link

documentation: add missing word "ref" #1803

Closed mokibit closed 3 weeks ago

dscho commented 2 months ago

/allow

gitgitgadget[bot] commented 2 months ago

There are issues in commit 0db78ac1b278b6cc2188001b01f49baf348669df: documentation: Add missing word "ref" Prefixed commit message must be in lower case

dscho commented 2 months ago

@mokibit please edit this comment, as it will be sent as a "cover letter".

gitgitgadget[bot] commented 2 months ago

User mokibit is now allowed to use GitGitGadget.

WARNING: mokibit 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.

dscho commented 2 months ago

@mokibit also, since I /allowed you too early, GitGitGadget did not send you this:

Welcome to GitGitGadget

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

Please make sure that either:

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>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, because it will result in a malformed CC list on the mailing list. See example.

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:

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.

mokibit commented 2 months ago

@dscho thanks!

mokibit commented 2 months ago

/preview

gitgitgadget[bot] commented 2 months ago

Error: Could not determine full name of mokibit

mokibit commented 2 months ago

/preview

gitgitgadget[bot] commented 2 months ago

Preview email sent as pull.1803.git.1727622037316.gitgitgadget@gmail.com

mokibit commented 2 months ago

/preview

gitgitgadget[bot] commented 2 months ago

Preview email sent as pull.1803.git.1727622460515.gitgitgadget@gmail.com

mokibit commented 2 months ago

/preview

gitgitgadget[bot] commented 2 months ago

Preview email sent as pull.1803.git.1727622763404.gitgitgadget@gmail.com

mokibit commented 2 months ago

/submit

gitgitgadget[bot] commented 2 months ago

Submitted as pull.1803.git.1727623027242.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1803/mokibit/docs-add-missing-ref-word-v1

To fetch this version to local tag pr-1803/mokibit/docs-add-missing-ref-word-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1803/mokibit/docs-add-missing-ref-word-v1
gitgitgadget[bot] commented 2 months ago

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

"Monika Kairaitytė via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> When explaining about "the destination ref <dst>", word
> "ref" is included. Logically, it should be the same in the explanation
> of "the source <src>".

"Logically", if <src> and <dst> followed the same rules, but
otherwise, it is not a logical conclusion.

What makes me hesitate with this change is the following.

 - In "+refs/heads/*:refs/remotes/origin/*", <src> is "refs/heads/*"
   and <dst> is "refs/tags/*".  Neither is a ref.  So it could be
   argued that saying "ref" before <dst> is what is wrong in the
   current text, and adding "ref" before <src> makes it doubly
   wrong.

 - In addition, <src> can be a fully spelled object name, to fetch
   just a single object.  In such a case, it does not even remotely
   resemble a ref.

How about this text instead?  Would it solve the problem, i.e. 

> In the git-fetch documentation, description of <refspec> syntax is not
> entirely clear.

Thanks.

------- >8 -------
Subject: doc: clarify <src> in refspec syntax

We explicitly avoid saying "ref <src>" when introducing the source
side of a refspec, because it can be a fully-spelled hexadecimal
object name, and it also can be a pattern that is not quite a "ref".

But we are loose when we introduce <dst> and say "ref <dst>", even
though it can also be a pattern.  Let's omit "ref" also from the
destination side.

Clarify that <src> can be a ref, a (limited glob) pattern, or an
object name.

Even though the very original design of refspec expected that '*'
was used only at the end (e.g., "refs/heads/*" was expected, but not
"refs/heads/*-wip"), the code and its use evolved to handle a single
'*' anywhere in the pattern.  Update the text to remove the mention
of "the same prefix".  Anything that matches the pattern are named
by such a (limited glob) pattern in <src>.

Also put a bit more stress on the fact that we accept only one '*'
in the pattern by saying "one and only one `*`".

Helped-by: Monika Kairaitytė <monika@kibit.lt>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/pull-fetch-param.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git c/Documentation/pull-fetch-param.txt w/Documentation/pull-fetch-param.txt
index c718f7946f..d79d2f6065 100644
--- c/Documentation/pull-fetch-param.txt
+++ w/Documentation/pull-fetch-param.txt
@@ -25,14 +25,15 @@ endif::git-pull[]
 +
 The format of a <refspec> parameter is an optional plus
 `+`, followed by the source <src>, followed
-by a colon `:`, followed by the destination ref <dst>.
+by a colon `:`, followed by the destination <dst>.
 The colon can be omitted when <dst> is empty.  <src> is
-typically a ref, but it can also be a fully spelled hex object
+typically a ref, or a glob pattern with a single `*` that is used
+to match a set of refs, but it can also be a fully spelled hex object
 name.
 +
 A <refspec> may contain a `*` in its <src> to indicate a simple pattern
 match. Such a refspec functions like a glob that matches any ref with the
-same prefix. A pattern <refspec> must have a `*` in both the <src> and
+pattern. A pattern <refspec> must have one and only one `*` in both the <src> and
 <dst>. It will map refs to the destination by replacing the `*` with the
 contents matched from the source.
 +
gitgitgadget[bot] commented 1 month ago

On the Git mailing list, Monika Kairaityte wrote (reply to this):

Sorry for late response, it took a while to figure out replies to mailing list.

Thanks for review and suggested changes. I agree that it looks better.

Cheers,
Monika
dscho commented 3 weeks ago

@mokibit could you check whether the proposed patch made it into Git, and if so, close this here PR?

mokibit commented 3 weeks ago

@dscho, I see commit was merged into Git master, thanks!