SubmittingPatches: document how to reference previous commits
[gitweb.git] / Documentation / git-get-tar-commit-id.txt
index dea41490c4415537ca4f87d182873e9dd218963a..ac44d85b0b5c7f12a2d5473b3be0b0e4511cf58f 100644 (file)
@@ -8,29 +8,23 @@ git-get-tar-commit-id - Extract commit ID from an archive created using git-arch
 
 SYNOPSIS
 --------
-'git-get-tar-commit-id' < <tarfile>
+[verse]
+'git get-tar-commit-id'
 
 
 DESCRIPTION
 -----------
-Acts as a filter, extracting the commit ID stored in archives created by
-linkgit:git-archive[1].  It reads only the first 1024 bytes of input, thus its
-runtime is not influenced by the size of <tarfile> very much.
-
-If no commit ID is found, git-get-tar-commit-id quietly exists with a
-return code of 1.  This can happen if <tarfile> had not been created
-using git-archive or if the first parameter of git-archive had been
-a tree ID instead of a commit ID or tag.
 
+Read a tar archive created by 'git archive' from the standard input
+and extract the commit ID stored in it.  It reads only the first
+1024 bytes of input, thus its runtime is not influenced by the size
+of the tar archive very much.
 
-Author
-------
-Written by Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
-
-Documentation
---------------
-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+If no commit ID is found, 'git get-tar-commit-id' quietly exists with a
+return code of 1.  This can happen if the archive had not been created
+using 'git archive' or if the first parameter of 'git archive' had been
+a tree ID instead of a commit ID or tag.
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite