git-commit-vandalism/Documentation/git-get-tar-commit-id.txt
Jonathan Nieder 483bc4f045 Documentation formatting and cleanup
Following what appears to be the predominant style, format
names of commands and commandlines both as `teletype text`.

While we're at it, add articles ("a" and "the") in some
places, italicize the name of the command in the manual page
synopsis line, and add a comma or two where it seems appropriate.

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-01 17:20:16 -07:00

37 lines
901 B
Plaintext

git-get-tar-commit-id(1)
========================
NAME
----
git-get-tar-commit-id - Extract commit ID from an archive created using git-archive
SYNOPSIS
--------
'git get-tar-commit-id' < <tarfile>
DESCRIPTION
-----------
Acts as a filter, extracting the commit ID stored in archives created by
`git-archive`. 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.
Author
------
Written by Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the linkgit:git[1] suite