Documentation/git-describe.txt: make description more readable
[git/git-bigfiles.git] / Documentation / git-get-tar-commit-id.txt
blobdea41490c4415537ca4f87d182873e9dd218963a
1 git-get-tar-commit-id(1)
2 ========================
4 NAME
5 ----
6 git-get-tar-commit-id - Extract commit ID from an archive created using git-archive
9 SYNOPSIS
10 --------
11 'git-get-tar-commit-id' < <tarfile>
14 DESCRIPTION
15 -----------
16 Acts as a filter, extracting the commit ID stored in archives created by
17 linkgit:git-archive[1].  It reads only the first 1024 bytes of input, thus its
18 runtime is not influenced by the size of <tarfile> very much.
20 If no commit ID is found, git-get-tar-commit-id quietly exists with a
21 return code of 1.  This can happen if <tarfile> had not been created
22 using git-archive or if the first parameter of git-archive had been
23 a tree ID instead of a commit ID or tag.
26 Author
27 ------
28 Written by Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
30 Documentation
31 --------------
32 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
34 GIT
35 ---
36 Part of the linkgit:git[7] suite