Merge branch 'kh/doc-patch-id-markup-fix'

Documentation mark-up fix.

* kh/doc-patch-id-markup-fix:
  doc: patch-id: fix accidental literal blocks
This commit is contained in:
Junio C Hamano 2025-10-14 12:56:08 -07:00
commit ca5a44b15c

View File

@ -33,27 +33,30 @@ OPTIONS
--verbatim:: --verbatim::
Calculate the patch-id of the input as it is given, do not strip Calculate the patch-id of the input as it is given, do not strip
any whitespace. any whitespace.
+
This is the default if patchid.verbatim is true. This is the default if patchid.verbatim is true.
--stable:: --stable::
Use a "stable" sum of hashes as the patch ID. With this option: Use a "stable" sum of hashes as the patch ID. With this option:
- Reordering file diffs that make up a patch does not affect the ID. +
In particular, two patches produced by comparing the same two trees --
with two different settings for "-O<orderfile>" result in the same - Reordering file diffs that make up a patch does not affect the ID.
patch ID signature, thereby allowing the computed result to be used In particular, two patches produced by comparing the same two trees
as a key to index some meta-information about the change between with two different settings for "-O<orderfile>" result in the same
the two trees; 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;
- Result is different from the value produced by git 1.9 and older - Result is different from the value produced by git 1.9 and older
or produced when an "unstable" hash (see --unstable below) is or produced when an "unstable" hash (see --unstable below) is
configured - even when used on a diff output taken without any use configured - even when used on a diff output taken without any use
of "-O<orderfile>", thereby making existing databases storing such 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. +
This is the default if patchid.stable is set to true.
--unstable:: --unstable::
Use an "unstable" hash as the patch ID. With this option, Use an "unstable" hash as the patch ID. With this option,
@ -61,8 +64,8 @@ OPTIONS
by git 1.9 and older and whitespace is ignored. Users with pre-existing 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 databases storing patch-ids produced by git 1.9 and older (who do not deal
with reordered patches) may want to use this option. with reordered patches) may want to use this option.
+
This is the default. This is the default.
GIT GIT
--- ---