averello/git-mirror
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2025-12-12 20:36:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'kh/doc-patch-id-1'

Browse Source 
* kh/doc-patch-id-1:
  doc: patch-id: convert to the modern synopsis style
This commit is contained in:
Junio C Hamano
2025-11-03 06:49:54 -08:00
parent 18a7988898 8f487db07a
commit ecf2f52fe5
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/git-patch-id.adoc
View File

@@ -7,8 +7,8 @@ git-patch-id - Compute unique ID for a patch
SYNOPSIS SYNOPSIS
-------- --------
[verse] [synopsis]
'git patch-id' [--stable | --unstable | --verbatim] git patch-id [--stable | --unstable | --verbatim]
DESCRIPTION DESCRIPTION
----------- -----------
@@ -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. 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` output, it takes advantage of
the fact that the patch is prefixed with the object name of the the fact that the patch is prefixed with the object name of the
commit, and outputs two 40-byte hexadecimal strings. The first commit, and outputs two 40-byte hexadecimal strings. The first
string is the patch ID, and the second string is the commit ID. 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.
OPTIONS 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. - Reordering file diffs that make up a patch does not affect the ID.
In particular, two patches produced by comparing the same two trees In particular, two patches produced by comparing the same two trees
with two different settings for "-O<orderfile>" result in the same with two different settings for `-O<orderfile>` result in the same
patch ID signature, thereby allowing the computed result to be used patch ID signature, thereby allowing the computed result to be used
as a key to index some meta-information about the change between 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 - 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,
the result produced is compatible with the patch-id value produced 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 by git 1.9 and older and whitespace is ignored. Users with pre-existing