updated git doc
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-get-tar-commit-id.xml
blob6ae713b6694dbcb74daa6e79b8ceb00e75f3c82d
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-get-tar-commit-id(1)">\r
5 <articleinfo>\r
6     <title>git-get-tar-commit-id(1)</title>\r
7 <indexterm>\r
8 <primary>git-get-tar-commit-id(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-get-tar-commit-id - Extract commit ID from an archive created using git-archive</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git get-tar-commit-id</emphasis> &lt; &lt;tarfile&gt;</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>Acts as a filter, extracting the commit ID stored in archives created by\r
24 <emphasis>git archive</emphasis>.  It reads only the first 1024 bytes of input, thus its\r
25 runtime is not influenced by the size of &lt;tarfile&gt; very much.</simpara>\r
26 <simpara>If no commit ID is found, <emphasis>git get-tar-commit-id</emphasis> quietly exists with a\r
27 return code of 1.  This can happen if &lt;tarfile&gt; had not been created\r
28 using <emphasis>git archive</emphasis> or if the first parameter of <emphasis>git archive</emphasis> had been\r
29 a tree ID instead of a commit ID or tag.</simpara>\r
30 </simplesect>\r
31 <simplesect id="_git">\r
32 <title>GIT</title>\r
33 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
34 </simplesect>\r
35 </article>\r