diff options
| author | Rene Scharfe <rene.scharfe@lsrfire.ath.cx> | 2005-09-06 21:21:16 +0200 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-09-06 13:49:11 -0700 |
| commit | 760b6634461ded0a9f09e86388c0ad7500641f1e (patch) | |
| tree | 184370fb4eb0265b03b059411ae8cd0cb1e6b2e6 /Documentation | |
| parent | 0d821d4dab346c9891e937d5f10c3261e1bbf13a (diff) | |
| download | git-760b6634461ded0a9f09e86388c0ad7500641f1e.tar.gz | |
[PATCH] Update documentation for git-get-tar-commit-id
... and add a copyright notice.
[jc: also move its entry in git.txt from undocumented section.]
Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-get-tar-commit-id.txt | 23 | ||||
| -rw-r--r-- | Documentation/git.txt | 5 |
2 files changed, 13 insertions, 15 deletions
diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt index f9c4140d3d..0eb5e2889c 100644 --- a/Documentation/git-get-tar-commit-id.txt +++ b/Documentation/git-get-tar-commit-id.txt @@ -3,25 +3,24 @@ 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-tar-tree. SYNOPSIS -------- -'git-get-tar-commit-id' [ --option ] <args>... +'git-get-tar-commit-id' < <tarfile> + DESCRIPTION ----------- -Does something not yet documented. - - -OPTIONS -------- ---option:: - Some option not yet documented. - -<args>...:: - Some argument not yet documented. +Acts as a filter, extracting the commit ID stored in archives created by +git-tar-tree. 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-tar-tree or if the first parameter of git-tar-tree had been +a tree ID instead of a commit ID or tag. Author diff --git a/Documentation/git.txt b/Documentation/git.txt index 0bcd99027d..b10edffe48 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -319,6 +319,8 @@ link:git-patch-id.html[git-patch-id]:: link:git-send-email-script.html[git-send-email]:: Send patch e-mails out of "format-patch --mbox" output. +link:git-get-tar-commit-id.html[git-get-tar-commit-id]:: + Extract commit ID from an archive created using git-tar-tree. Commands not yet documented --------------------------- @@ -338,9 +340,6 @@ link:git-diff-script.html[git-diff-script]:: link:git-format-patch-script.html[git-format-patch-script]:: git-format-patch-script. -link:git-get-tar-commit-id.html[git-get-tar-commit-id]:: - git-get-tar-commit-id. - link:git-request-pull-script.html[git-request-pull-script]:: git-request-pull-script. |