Skip to content

Commit ecf2f52

Browse files
committed
Merge branch 'kh/doc-patch-id-1'
* kh/doc-patch-id-1: doc: patch-id: convert to the modern synopsis style
2 parents 18a7988 + 8f487db commit ecf2f52

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/git-patch-id.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ git-patch-id - Compute unique ID for a patch
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git patch-id' [--stable | --unstable | --verbatim]
10+
[synopsis]
11+
git patch-id [--stable | --unstable | --verbatim]
1212

1313
DESCRIPTION
1414
-----------
@@ -21,7 +21,7 @@ the same time also reasonably unique, i.e., two patches that have the same
2121

2222
The main usecase for this command is to look for likely duplicate commits.
2323

24-
When dealing with 'git diff-tree' output, it takes advantage of
24+
When dealing with `git diff-tree` output, it takes advantage of
2525
the fact that the patch is prefixed with the object name of the
2626
commit, and outputs two 40-byte hexadecimal strings. The first
2727
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.
3030
OPTIONS
3131
-------
3232

33-
--verbatim::
33+
`--verbatim`::
3434
Calculate the patch-id of the input as it is given, do not strip
3535
any whitespace.
3636
+
37-
This is the default if patchid.verbatim is true.
37+
This is the default if `patchid.verbatim` is `true`.
3838

39-
--stable::
39+
`--stable`::
4040
Use a "stable" sum of hashes as the patch ID. With this option:
4141
+
4242
--
4343
- Reordering file diffs that make up a patch does not affect the ID.
4444
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
4646
patch ID signature, thereby allowing the computed result to be used
4747
as a key to index some meta-information about the change between
4848
the two trees;
4949

5050
- 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
5252
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
5454
"unstable" or historical patch-ids unusable.
5555
5656
- All whitespace within the patch is ignored and does not affect the id.
5757
--
5858
+
59-
This is the default if patchid.stable is set to true.
59+
This is the default if `patchid.stable` is set to `true`.
6060
61-
--unstable::
61+
`--unstable`::
6262
Use an "unstable" hash as the patch ID. With this option,
6363
the result produced is compatible with the patch-id value produced
6464
by git 1.9 and older and whitespace is ignored. Users with pre-existing

0 commit comments

Comments
 (0)