SubmittingPatches: document how to reference previous commits
[gitweb.git] / Documentation / git-get-tar-commit-id.txt
index f9c4140d3dbf1c23e2ac758ed6317d53fce9bb7c..ac44d85b0b5c7f12a2d5473b3be0b0e4511cf58f 100644 (file)
@@ -3,36 +3,28 @@ git-get-tar-commit-id(1)
 
 NAME
 ----
-git-get-tar-commit-id - Some git command not yet documented.
+git-get-tar-commit-id - Extract commit ID from an archive created using git-archive
 
 
 SYNOPSIS
 --------
-'git-get-tar-commit-id' [ --option ] <args>...
+[verse]
+'git get-tar-commit-id'
+
 
 DESCRIPTION
 -----------
-Does something not yet documented.
-
-
-OPTIONS
--------
---option::
-       Some option not yet documented.
 
-<args>...::
-       Some argument not yet documented.
+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 link:git.html[git] suite
-
+Part of the linkgit:git[1] suite