Skip to content

Commit ffae4da

Browse files
committed
Merge branch 'kh/doc-patch-id'
"git patch-id" documentation updates. * kh/doc-patch-id: doc: patch-id: --verbatim locks in --stable doc: patch-id: spell out the git-diff-tree(1) form doc: patch-id: use definite article for the result patch-id: use “patch ID” throughout doc: patch-id: capitalize Git version doc: patch-id: don’t use semicolon between bullet points
2 parents 1cb041f + 3f051fc commit ffae4da

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

Documentation/git-patch-id.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -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 --patch` 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.
@@ -31,8 +31,8 @@ OPTIONS
3131
-------
3232

3333
`--verbatim`::
34-
Calculate the patch-id of the input as it is given, do not strip
35-
any whitespace.
34+
Calculate the patch ID of the input as it is given, do not strip
35+
any whitespace. Implies `--stable` and forbids `--unstable`.
3636
+
3737
This is the default if `patchid.verbatim` is `true`.
3838

@@ -45,24 +45,24 @@ This is the default if `patchid.verbatim` is `true`.
4545
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
48-
the two trees;
48+
the two trees.
4949

50-
- Result is different from the value produced by git 1.9 and older
50+
- The result is different from the value produced by Git 1.9 and older
5151
or produced when an "unstable" hash (see `--unstable` below) is
5252
configured - even when used on a diff output taken without any use
5353
of `-O<orderfile>`, thereby making existing databases storing such
54-
"unstable" or historical patch-ids unusable.
54+
"unstable" or historical patch IDs unusable.
5555
56-
- All whitespace within the patch is ignored and does not affect the id.
56+
- All whitespace within the patch is ignored and does not affect the ID.
5757
--
5858
+
5959
This is the default if `patchid.stable` is set to `true`.
6060
6161
`--unstable`::
6262
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
65-
databases storing patch-ids produced by git 1.9 and older (who do not deal
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
65+
databases storing patch IDs produced by Git 1.9 and older (who do not deal
6666
with reordered patches) may want to use this option.
6767
+
6868
This is the default.

builtin/patch-id.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,9 @@ int cmd_patch_id(int argc,
228228
int opts = 0;
229229
struct option builtin_patch_id_options[] = {
230230
OPT_CMDMODE(0, "unstable", &opts,
231-
N_("use the unstable patch-id algorithm"), 1),
231+
N_("use the unstable patch ID algorithm"), 1),
232232
OPT_CMDMODE(0, "stable", &opts,
233-
N_("use the stable patch-id algorithm"), 2),
233+
N_("use the stable patch ID algorithm"), 2),
234234
OPT_CMDMODE(0, "verbatim", &opts,
235235
N_("don't strip whitespace from the patch"), 3),
236236
OPT_END()

0 commit comments

Comments
 (0)