Merge branch 'jp/refs'
[gitweb.git] / Documentation / git-patch-id.txt
index 3e560a37e835bb59f12754591c5c32bac671f57c..a7e9fd021a4cc1e467b2df7dd7e06d79a5182c7a 100644 (file)
@@ -3,7 +3,7 @@ git-patch-id(1)
 
 NAME
 ----
-git-patch-id - Generate a patch ID.
+git-patch-id - Compute unique ID for a patch
 
 SYNOPSIS
 --------
@@ -13,11 +13,17 @@ DESCRIPTION
 -----------
 A "patch ID" is nothing but a SHA1 of the diff associated with a patch, with
 whitespace and line numbers ignored.  As such, it's "reasonably stable", but at
-the same time also reasonably unique, ie two patches that have the same "patch
+the same time also reasonably unique, i.e., two patches that have the same "patch
 ID" are almost guaranteed to be the same thing.
 
 IOW, you can use this thing to look for likely duplicate commits.
 
+When dealing with git-diff-tree 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 string.  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.
+
 OPTIONS
 -------
 <patch>::