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

3 messages from 2026-05-21 to 2026-05-21. Participants: Siddh Raman Pant, Kristoffer Haugsbakk.
Thread: https://gitlist.dev/t/65665

## Siddh Raman Pant, 2026-05-21 04:19

Subject: [PATCH] Documentation/git-range-diff: add missing notes options in synopsis
Message-ID: <20260521041908.41055-1-siddh.raman.pant@oracle.com>

```
git-range-diff supports note options which are also mentioned later in
the help, but they are missing from synopis. Let's fix that.

Fixes: bd3619188682 ("range-diff: pass through --notes to `git log`")
Signed-off-by: Siddh Raman Pant <siddh.raman.pant@oracle.com>
---
 Documentation/git-range-diff.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-range-diff.adoc b/Documentation/git-range-diff.adoc
index 880557084533..5cc5e2ed5673 100644
--- a/Documentation/git-range-diff.adoc
+++ b/Documentation/git-range-diff.adoc
@@ -11,7 +11,7 @@ SYNOPSIS
 git range-diff [--color=[<when>]] [--no-color] [<diff-options>]
 	[--no-dual-color] [--creation-factor=<factor>]
 	[--left-only | --right-only] [--diff-merges=<format>]
-	[--remerge-diff]
+	[--remerge-diff] [--no-notes | --notes[=<ref>]]
 	( <range1> <range2> | <rev1>...<rev2> | <base> <rev1> <rev2> )
 	[[--] <path>...]
 
-- 
2.53.0


```

## Kristoffer Haugsbakk, 2026-05-21 05:12

Subject: Re: [PATCH] Documentation/git-range-diff: add missing notes options in synopsis
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]

```

## Siddh Raman Pant, 2026-05-21 05:28

Subject: [PATCH v2] Documentation/git-range-diff: add missing notes options in synopsis
Message-ID: <20260521052841.73775-1-siddh.raman.pant@oracle.com>
In-Reply-To: <72839071-153f-4306-a705-3be0dc203109@app.fastmail.com>

```
git-range-diff supports note options which are also mentioned later in
the help, but they are missing from the synopsis. Let's fix that.

Signed-off-by: Siddh Raman Pant <siddh.raman.pant@oracle.com>
---
v1 -> v2: Fixed typo and removed fixes line.

 Documentation/git-range-diff.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-range-diff.adoc b/Documentation/git-range-diff.adoc
index 880557084533..5cc5e2ed5673 100644
--- a/Documentation/git-range-diff.adoc
+++ b/Documentation/git-range-diff.adoc
@@ -11,7 +11,7 @@ SYNOPSIS
 git range-diff [--color=[<when>]] [--no-color] [<diff-options>]
 	[--no-dual-color] [--creation-factor=<factor>]
 	[--left-only | --right-only] [--diff-merges=<format>]
-	[--remerge-diff]
+	[--remerge-diff] [--no-notes | --notes[=<ref>]]
 	( <range1> <range2> | <rev1>...<rev2> | <base> <rev1> <rev2> )
 	[[--] <path>...]
 
-- 
2.53.0


```