man1/git-patch-id.1

   1 '\" t
   2 .\"     Title: git-patch-id
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 09/23/2022
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.38.0.rc1.6.g4fd6c5e444
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-PATCH\-ID" "1" "09/23/2022" "Git 2\&.38\&.0\&.rc1\&.6\&.g4f" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-patch-id \- Compute unique ID for a patch
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit patch\-id\fR [\-\-stable | \-\-unstable]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 Read a patch from the standard input and compute the patch ID for it\&.
  41 .sp
  42 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\&.
  43 .sp
  44 IOW, you can use this thing to look for likely duplicate commits\&.
  45 .sp
  46 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\&.
  47 .SH "OPTIONS"
  48 .PP
  49 \-\-stable
  50 .RS 4
  51 Use a "stable" sum of hashes as the patch ID\&. With this option:
  52 .sp
  53 .RS 4
  54 .ie n \{\
  55 \h'-04'\(bu\h'+03'\c
  56 .\}
  57 .el \{\
  58 .sp -1
  59 .IP \(bu 2.3
  60 .\}
  61 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 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;
  62 .RE
  63 .sp
  64 .RS 4
  65 .ie n \{\
  66 \h'-04'\(bu\h'+03'\c
  67 .\}
  68 .el \{\
  69 .sp -1
  70 .IP \(bu 2.3
  71 .\}
  72 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\&.
  73 .sp
  74 .if n \{\
  75 .RS 4
  76 .\}
  77 .nf
  78 This is the default if patchid\&.stable is set to true\&.
  79 .fi
  80 .if n \{\
  81 .RE
  82 .\}
  83 .RE
  84 .RE
  85 .PP
  86 \-\-unstable
  87 .RS 4
  88 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\&.
  89 .sp
  90 .if n \{\
  91 .RS 4
  92 .\}
  93 .nf
  94 This is the default\&.
  95 .fi
  96 .if n \{\
  97 .RE
  98 .\}
  99 .RE
 100 .SH "GIT"
 101 .sp
 102 Part of the \fBgit\fR(1) suite