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
This commit is contained in:
Junio C Hamano 2026-01-16 12:40:28 -08:00
commit ffae4da012
2 changed files with 12 additions and 12 deletions

View File

@ -21,7 +21,7 @@ the same time also reasonably unique, i.e., two patches that have the same
The main usecase for this command is to look for likely duplicate commits.
When dealing with `git diff-tree` output, it takes advantage of
When dealing with `git diff-tree --patch` output, it takes advantage of
the fact that the patch is prefixed with the object name of the
commit, and outputs two 40-byte hexadecimal strings. The first
string is the patch ID, and the second string is the commit ID.
@ -31,8 +31,8 @@ OPTIONS
-------
`--verbatim`::
Calculate the patch-id of the input as it is given, do not strip
any whitespace.
Calculate the patch ID of the input as it is given, do not strip
any whitespace. Implies `--stable` and forbids `--unstable`.
+
This is the default if `patchid.verbatim` is `true`.
@ -45,24 +45,24 @@ This is the default if `patchid.verbatim` is `true`.
with two different settings for `-O<orderfile>` result in the same
patch ID signature, thereby allowing the computed result to be used
as a key to index some meta-information about the change between
the two trees;
the two trees.
- Result is different from the value produced by git 1.9 and older
- The result is different from the value produced by Git 1.9 and older
or produced when an "unstable" hash (see `--unstable` below) is
configured - even when used on a diff output taken without any use
of `-O<orderfile>`, thereby making existing databases storing such
"unstable" or historical patch-ids unusable.
"unstable" or historical patch IDs unusable.
- All whitespace within the patch is ignored and does not affect the id.
- All whitespace within the patch is ignored and does not affect the ID.
--
+
This is the default if `patchid.stable` is set to `true`.
`--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
databases storing patch-ids produced by git 1.9 and older (who do not deal
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
databases storing patch IDs produced by Git 1.9 and older (who do not deal
with reordered patches) may want to use this option.
+
This is the default.

View File

@ -228,9 +228,9 @@ int cmd_patch_id(int argc,
int opts = 0;
struct option builtin_patch_id_options[] = {
OPT_CMDMODE(0, "unstable", &opts,
N_("use the unstable patch-id algorithm"), 1),
N_("use the unstable patch ID algorithm"), 1),
OPT_CMDMODE(0, "stable", &opts,
N_("use the stable patch-id algorithm"), 2),
N_("use the stable patch ID algorithm"), 2),
OPT_CMDMODE(0, "verbatim", &opts,
N_("don't strip whitespace from the patch"), 3),
OPT_END()