summaryrefslogtreecommitdiffstats
path: root/man1/git-patch-id.1
diff options
context:
space:
mode:
Diffstat (limited to 'man1/git-patch-id.1')
-rw-r--r--man1/git-patch-id.140
1 files changed, 33 insertions, 7 deletions
diff --git a/man1/git-patch-id.1 b/man1/git-patch-id.1
index f2c46ca3c..15a2a0f55 100644
--- a/man1/git-patch-id.1
+++ b/man1/git-patch-id.1
@@ -2,12 +2,12 @@
.\" Title: git-patch-id
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 10/28/2022
+.\" Date: 11/04/2022
.\" Manual: Git Manual
-.\" Source: Git 2.38.1.280.g63bba4fdd8
+.\" Source: Git 2.38.1.385.g3b08839926
.\" Language: English
.\"
-.TH "GIT\-PATCH\-ID" "1" "10/28/2022" "Git 2\&.38\&.1\&.280\&.g63bba4" "Git Manual"
+.TH "GIT\-PATCH\-ID" "1" "11/04/2022" "Git 2\&.38\&.1\&.385\&.g3b0883" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -32,20 +32,35 @@ git-patch-id \- Compute unique ID for a patch
.SH "SYNOPSIS"
.sp
.nf
-\fIgit patch\-id\fR [\-\-stable | \-\-unstable]
+\fIgit patch\-id\fR [\-\-stable | \-\-unstable | \-\-verbatim]
.fi
.sp
.SH "DESCRIPTION"
.sp
Read a patch from the standard input and compute the patch ID for it\&.
.sp
-A "patch ID" is nothing but a sum of SHA\-1 of the file diffs associated with a patch, with whitespace and line numbers ignored\&. As such, it\(cqs "reasonably stable", but at the same time also reasonably unique, i\&.e\&., two patches that have the same "patch ID" are almost guaranteed to be the same thing\&.
+A "patch ID" is nothing but a sum of SHA\-1 of the file diffs associated with a patch, with line numbers ignored\&. As such, it\(cqs "reasonably stable", but at the same time also reasonably unique, i\&.e\&., two patches that have the same "patch ID" are almost guaranteed to be the same thing\&.
.sp
-IOW, you can use this thing to look for likely duplicate commits\&.
+The main usecase for this command is to look for likely duplicate commits\&.
.sp
When dealing with \fIgit diff\-tree\fR 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\&. This can be used to make a mapping from patch ID to commit ID\&.
.SH "OPTIONS"
.PP
+\-\-verbatim
+.RS 4
+Calculate the patch\-id of the input as it is given, do not strip any whitespace\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+This is the default if patchid\&.verbatim is true\&.
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
\-\-stable
.RS 4
Use a "stable" sum of hashes as the patch ID\&. With this option:
@@ -70,6 +85,17 @@ Reordering file diffs that make up a patch does not affect the ID\&. In particul
.IP \(bu 2.3
.\}
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\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+All whitespace within the patch is ignored and does not affect the id\&.
.sp
.if n \{\
.RS 4
@@ -85,7 +111,7 @@ This is the default if patchid\&.stable is set to true\&.
.PP
\-\-unstable
.RS 4
-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\&. 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\&.
+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 with reordered patches) may want to use this option\&.
.sp
.if n \{\
.RS 4