mailsplit: allow feeding mbox from standard input.
[gitweb.git] / Documentation / git-patch-id.txt
index 9a4abd124dfd0a6ceea058c3c4105298c81e8f5a..3e560a37e835bb59f12754591c5c32bac671f57c 100644 (file)
@@ -3,26 +3,25 @@ git-patch-id(1)
 
 NAME
 ----
-git-patch-id - Some git command not yet documented.
-
+git-patch-id - Generate a patch ID.
 
 SYNOPSIS
 --------
-'git-patch-id' [ --option ] <args>...
+'git-patch-id' < <patch>
 
 DESCRIPTION
 -----------
-Does something not yet documented.
+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
+ID" are almost guaranteed to be the same thing.
 
+IOW, you can use this thing to look for likely duplicate commits.
 
 OPTIONS
 -------
---option::
-       Some option not yet documented.
-
-<args>...::
-       Some argument not yet documented.
-
+<patch>::
+       The diff to create the ID of.
 
 Author
 ------
@@ -34,5 +33,5 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite