From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Siddh Raman Pant" <siddh.raman.pant@oracle•com>, git@vger•kernel.org
Cc: "Patrick Steinhardt" <ps@pks•im>,
"Junio C Hamano" <gitster@pobox•com>,
"Elijah Newren" <newren@gmail•com>
Subject: Re: [PATCH] Documentation/git-range-diff: add missing notes options in synopsis
Date: Thu, 21 May 2026 07:12:27 +0200 [thread overview]
Message-ID: <72839071-153f-4306-a705-3be0dc203109@app.fastmail.com> (raw)
In-Reply-To: <20260521041908.41055-1-siddh.raman.pant@oracle.com>
On Thu, May 21, 2026, at 06:19, Siddh Raman Pant wrote:
> git-range-diff supports note options which are also mentioned later in
> the help, but they are missing from synopis. Let's fix that.
s/synopis/synopsis/ or s/synopis/the synopsis/
>
> Fixes: bd3619188682 ("range-diff: pass through --notes to `git log`")
This project doesn’t use `Fixes` trailers. Mentions of commits go in the
commit message body (outside the trailers) using `git log -1
--format-reference <cmt>`.
The Linux project has uses for this structured information since there
is a lot of backporting of bugfixes. But I haven’t heard of a need for
that in this project.
> Signed-off-by: Siddh Raman Pant <siddh.raman.pant@oracle•com>
> ---
> Documentation/git-range-diff.adoc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
Okay, there is no need to update the synopsis in the source code since
git-range-diff(1) is excluded from `t/t0450-txt-doc-vs-help.sh`. So this
looks correct.
>
> diff --git a/Documentation/git-range-diff.adoc
>[snip]
next prev parent reply other threads:[~2026-05-21 5:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-21 4:19 [PATCH] Documentation/git-range-diff: add missing notes options in synopsis Siddh Raman Pant
2026-05-21 5:12 ` Kristoffer Haugsbakk [this message]
2026-05-21 5:28 ` [PATCH v2] " Siddh Raman Pant
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=72839071-153f-4306-a705-3be0dc203109@app.fastmail.com \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=newren@gmail$(echo .)com \
--cc=ps@pks$(echo .)im \
--cc=siddh.raman.pant@oracle$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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