summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2026-01-16 12:40:28 -0800
committerJunio C Hamano <gitster@pobox.com>2026-01-16 12:40:28 -0800
commitffae4da0128e035acd1887654c98b4f02785adec (patch)
treeeccf4ae983063e15e2bac5be4be3043e5446005b
parent1cb041f795d1424a3e31feb94672d1a1fe06d0a2 (diff)
parent3f051fc9c9f9e719ad0e37b66737b466b82d17b3 (diff)
downloadgit-ffae4da0128e035acd1887654c98b4f02785adec.tar.xz
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
-rw-r--r--Documentation/git-patch-id.adoc20
-rw-r--r--builtin/patch-id.c4
2 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/git-patch-id.adoc b/Documentation/git-patch-id.adoc
index 92a1af36a2..013e1a6190 100644
--- a/Documentation/git-patch-id.adoc
+++ b/Documentation/git-patch-id.adoc
@@ -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.
diff --git a/builtin/patch-id.c b/builtin/patch-id.c
index d26e9d0c1e..2781598ede 100644
--- a/builtin/patch-id.c
+++ b/builtin/patch-id.c
@@ -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()