doc: patch-id: convert to the modern synopsis style

Convert this command documentation to the modern synopsis style based on similar work.[1] Concretely: • Change the Synopsis section from `verse` to a `synopsis` block which will automatically apply the correct formatting to various elements (although this Synopsis is very simple) • Use backticks (`) for code-like things which will also use the correct formatting for interior placeholders (`<orderfile>`) • Use inline-verbatim on options listing † 1: E.g., • 026f2e3b (doc: convert git-log to new documentation format, 2025-07-07) • b983aaab (doc: convert git-switch manpage to new synopsis style, 2025-05-25) • 16543967 (doc: convert git-mergetool manpage to new synopsis style, 2025-05-25) Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Kristoffer Haugsbakk committed Oct 13, 2025 at 17:42 UTC 8f487db07aa16e026fde0e3d11e4fbf31ab15636
1 file changed +11 -11
Documentation/git-patch-id.adoc
+11 -11
@@ -7,8 +7,8 @@ git-patch-id - Compute unique ID for a patch
7
8 SYNOPSIS
9 --------
10 -[verse]
11 -'git patch-id' [--stable | --unstable | --verbatim]
10 +[synopsis]
11 +git patch-id [--stable | --unstable | --verbatim]
12
13 DESCRIPTION
14 -----------
@@ -21,7 +21,7 @@ the same time also reasonably unique, i.e., two patches that have the same
21
22 The main usecase for this command is to look for likely duplicate commits.
23
24 -When dealing with 'git diff-tree' output, it takes advantage of
24 +When dealing with `git diff-tree` output, it takes advantage of
25 the fact that the patch is prefixed with the object name of the
26 commit, and outputs two 40-byte hexadecimal strings. The first
27 string is the patch ID, and the second string is the commit ID.
@@ -30,35 +30,35 @@ This can be used to make a mapping from patch ID to commit ID.
30 OPTIONS
31 -------
32
33 ---verbatim::
33 +`--verbatim`::
34 Calculate the patch-id of the input as it is given, do not strip
35 any whitespace.
36 +
37 -This is the default if patchid.verbatim is true.
37 +This is the default if `patchid.verbatim` is `true`.
38
39 ---stable::
39 +`--stable`::
40 Use a "stable" sum of hashes as the patch ID. With this option:
41 +
42 --
43 - Reordering file diffs that make up a patch does not affect the ID.
44 In particular, two patches produced by comparing the same two trees
45 - with two different settings for "-O<orderfile>" result in the same
45 + with two different settings for `-O<orderfile>` result in the same
46 patch ID signature, thereby allowing the computed result to be used
47 as a key to index some meta-information about the change between
48 the two trees;
49
50 - Result is different from the value produced by git 1.9 and older
51 - or produced when an "unstable" hash (see --unstable below) is
51 + or produced when an "unstable" hash (see `--unstable` below) is
52 configured - even when used on a diff output taken without any use
53 - of "-O<orderfile>", thereby making existing databases storing such
53 + of `-O<orderfile>`, thereby making existing databases storing such
54 "unstable" or historical patch-ids unusable.
55
56 - All whitespace within the patch is ignored and does not affect the id.
57 --
58 +
59 -This is the default if patchid.stable is set to true.
59 +This is the default if `patchid.stable` is set to `true`.
60
61 ---unstable::
61 +`--unstable`::
62 Use an "unstable" hash as the patch ID. With this option,
63 the result produced is compatible with the patch-id value produced
64 by git 1.9 and older and whitespace is ignored. Users with pre-existing