From: Dov Murik <dov.murik@linux.dev>
To: Linus Arver <linusarver@gmail.com>, git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Linus Arver <linus@ucla.edu>,
dov.murik@linux.dev
Subject: Re: [PATCH] doc: git-update-index: add --show-index-version to synopsis
Date: Sat, 11 May 2024 21:52:00 -0400 [thread overview]
Message-ID: <ZkAgwBvwswcjZRrF@Transmit-DovM-Remote> (raw)
In-Reply-To: <CAMo6p=GuLtJtwiS+N366ArFB2ejrYxnsy3S9Ud4tCeW=R5R57g@mail.gmail.com>
Hi Linus,
Thank you for looking at this patch.
On Fri, May 10, 2024 at 10:18:36PM -0500, Linus Arver wrote:
> Hi Dov,
>
> Dov Murik <dov.murik@linux.dev> writes:
>
> > Fixes: 606e088d5d9a ("update-index: add --show-index-version")
>
> I don't think this trailer is a standard one.
I saw it in Linux kernel patches. From [1]:
A Fixes: tag indicates that the patch fixes an issue in a previous
commit. It is used to make it easy to determine where a bug
originated, which can help review a bug fix. This tag also assists
the stable kernel team in determining which stable kernel versions
should receive your fix. This is the preferred method for indicating
a bug fixed by the patch.
But I now understand it is not used in git patches; sorry about that.
[1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html
> Also, the "fixes" doesn't
> really explain much. Perhaps you meant something like
>
> In 606e088d5d (update-index: add --show-index-version, 2023-09-12),
> we added the new '--show-index-version' option and documented it,
> but forgot to add it to the synopsis section. Do so now.
>
> ?
Yes, the explicit explanation is clearer. Thank you.
I'll submit a v2 with a clearer commit message.
-Dov
>
> > Signed-off-by: Dov Murik <dov.murik@linux.dev>
> > ---
> > Documentation/git-update-index.txt | 1 +
> > 1 file changed, 1 insertion(+)
> >
> > diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
> > index 8c47890a6a..7128aed540 100644
> > --- a/Documentation/git-update-index.txt
> > +++ b/Documentation/git-update-index.txt
> > @@ -25,6 +25,7 @@ SYNOPSIS
> > [--really-refresh] [--unresolve] [--again | -g]
> > [--info-only] [--index-info]
> > [-z] [--stdin] [--index-version <n>]
> > + [--show-index-version]
> > [--verbose]
> > [--] [<file>...]
> >
> >
> > base-commit: 3402c0e53fb798cb471dd6562eb5c938885b7295
> > --
> > 2.39.3 (Apple Git-146)
prev parent reply other threads:[~2024-05-12 1:52 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-10 18:36 [PATCH] doc: git-update-index: add --show-index-version to synopsis Dov Murik
2024-05-11 3:18 ` Linus Arver
2024-05-12 1:52 ` Dov Murik [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZkAgwBvwswcjZRrF@Transmit-DovM-Remote \
--to=dov.murik@linux.dev \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=linus@ucla.edu \
--cc=linusarver@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).