| Message ID | 20240510183622.77750-1-dov.murik@linux.dev (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | c81ffcff83f8dc6129aa6379ff269505919d0099 |
| Headers | show |
| Series | doc: git-update-index: add --show-index-version to synopsis | expand |
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. 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. ? > 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)
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)
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>...]
Fixes: 606e088d5d9a ("update-index: add --show-index-version") Signed-off-by: Dov Murik <dov.murik@linux.dev> --- Documentation/git-update-index.txt | 1 + 1 file changed, 1 insertion(+) base-commit: 3402c0e53fb798cb471dd6562eb5c938885b7295