Re: [PATCH v2] doc: patch-id: convert to the modern synopsis style

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Oct 13, 2025, 16:53 UTC
Message-ID: <CAPig+cSQB0HbhY2L1Y4mkbaCMiZTH72AtQ+qRg=Z0U9_ggkcug@mail.gmail.com>
In-Reply-To: <v2-38645ea253c.1760369708.git.code@khaugsbakk.name>

On Mon, Oct 13, 2025 at 12:28 PM <kristofferhaugsbakk@fastmail.com> wrote:

Show 12 quoted lines

> Convert this command documentation to the modern synopsis style based on
> similar work.[1] Concretely: [...]
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
> diff --git a/Documentation/git-patch-id.adoc b/Documentation/git-patch-id.adoc
> @@ -7,8 +7,8 @@ git-patch-id - Compute unique ID for a patch
> ---unstable::
> +`--unstable`::
>         Use an "unstable" hash as the patch ID. With this option,
>         the result produced is compatible with the patch-id value produced
>         by git 1.9 and older and whitespace is ignored.  Users with pre-existing

Is the mix of "patch ID" and "patch-id" intentional? If so, should "patch-id" be wrapped in backticks?