Re: [PATCH] Documentation/git-range-diff: add missing notes options in synopsis

From: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Date: May 21, 2026, 05:12 UTC
Message-ID: <72839071-153f-4306-a705-3be0dc203109@app.fastmail.com>
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]