git-get-tar-commit-id Command

1st chunk of `Documentation/git-get-tar-commit-id.adoc`

49088ca6c923b8a0edb6ef0a1144ee9f2bab0178322b3f2f00000001000002f1

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'


DESCRIPTION
-----------

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.

If no commit ID is found, 'git get-tar-commit-id' quietly exits 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 linkgit:git[1] suite

Title: git-get-tar-commit-id Command

Summary

Extracts the commit ID from a tar archive created using git-archive, reading only the first 1024 bytes of input and exiting quietly with a return code of 1 if no commit ID is found, which can occur if the archive was not created with git-archive or if a tree ID was used instead of a commit ID or tag, providing a efficient way to retrieve commit information from archives.