summaryrefslogtreecommitdiff
path: root/Documentation/git-get-tar-commit-id.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-get-tar-commit-id.txt')
-rw-r--r--Documentation/git-get-tar-commit-id.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt
new file mode 100644
index 0000000000..1e2a20dd26
--- /dev/null
+++ b/Documentation/git-get-tar-commit-id.txt
@@ -0,0 +1,28 @@
+git-get-tar-commit-id(1)
+========================
+
+NAME
+----
+git-get-tar-commit-id - Extract commit ID from an archive created using git-archive
+
+
+SYNOPSIS
+--------
+[verse]
+'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.
+
+GIT
+---
+Part of the linkgit:git[1] suite