summaryrefslogtreecommitdiffstats
path: root/git-cat-file.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-03-22 14:20:26 -0700
committerJunio C Hamano <gitster@pobox.com>2021-03-22 14:20:26 -0700
commit458281a5cc4fbbf5382b507870ac92d09f4cb1d9 (patch)
treef969cc3e9470c06902051bcd159aa1bc58a02bb2 /git-cat-file.html
parentd6b9ba3262e9125b842efd226c8023a5c9aed98c (diff)
downloadgit-htmldocs-458281a5cc4fbbf5382b507870ac92d09f4cb1d9.tar.gz
Autogenerated HTML docs for v2.31.0-97-g14243
Diffstat (limited to 'git-cat-file.html')
-rw-r--r--git-cat-file.html69
1 files changed, 35 insertions, 34 deletions
diff --git a/git-cat-file.html b/git-cat-file.html
index b8e6c2cec..93762990a 100644
--- a/git-cat-file.html
+++ b/git-cat-file.html
@@ -790,7 +790,7 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
<dd>
<p>
Instead of the content, show the object type identified by
- &lt;object&gt;.
+ <code>&lt;object&gt;</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -799,7 +799,7 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
<dd>
<p>
Instead of the content, show the object size identified by
- &lt;object&gt;.
+ <code>&lt;object&gt;</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -807,8 +807,8 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- Exit with zero status if &lt;object&gt; exists and is a valid
- object. If &lt;object&gt; is of an invalid format exit with non-zero and
+ Exit with zero status if <code>&lt;object&gt;</code> exists and is a valid
+ object. If <code>&lt;object&gt;</code> is of an invalid format exit with non-zero and
emits an error on stderr.
</p>
</dd>
@@ -817,7 +817,7 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- Pretty-print the contents of &lt;object&gt; based on its type.
+ Pretty-print the contents of <code>&lt;object&gt;</code> based on its type.
</p>
</dd>
<dt class="hdlist1">
@@ -825,11 +825,11 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- Typically this matches the real type of &lt;object&gt; but asking
+ Typically this matches the real type of <code>&lt;object&gt;</code> but asking
for a type that can trivially be dereferenced from the given
- &lt;object&gt; is also permitted. An example is to ask for a
- "tree" with &lt;object&gt; being a commit object that contains it,
- or to ask for a "blob" with &lt;object&gt; being a tag object that
+ <code>&lt;object&gt;</code> is also permitted. An example is to ask for a
+ "tree" with <code>&lt;object&gt;</code> being a commit object that contains it,
+ or to ask for a "blob" with <code>&lt;object&gt;</code> being a tag object that
points at it.
</p>
</dd>
@@ -839,9 +839,9 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
<dd>
<p>
Show the content as transformed by a textconv filter. In this case,
- &lt;object&gt; has to be of the form &lt;tree-ish&gt;:&lt;path&gt;, or :&lt;path&gt; in
+ <code>&lt;object&gt;</code> has to be of the form <code>&lt;tree-ish&gt;:&lt;path&gt;</code>, or <code>:&lt;path&gt;</code> in
order to apply the filter to the content recorded in the index at
- &lt;path&gt;.
+ <code>&lt;path&gt;</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -850,9 +850,9 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
<dd>
<p>
Show the content as converted by the filters configured in
- the current working tree for the given &lt;path&gt; (i.e. smudge filters,
- end-of-line conversion, etc). In this case, &lt;object&gt; has to be of
- the form &lt;tree-ish&gt;:&lt;path&gt;, or :&lt;path&gt;.
+ the current working tree for the given <code>&lt;path&gt;</code> (i.e. smudge filters,
+ end-of-line conversion, etc). In this case, <code>&lt;object&gt;</code> has to be of
+ the form <code>&lt;tree-ish&gt;:&lt;path&gt;</code>, or <code>:&lt;path&gt;</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -860,7 +860,7 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- For use with --textconv or --filters, to allow specifying an object
+ For use with <code>--textconv</code> or <code>--filters</code>, to allow specifying an object
name and a path separately, e.g. when it is difficult to figure out
the revision from which the blob came.
</p>
@@ -939,7 +939,7 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- Allow -s or -t to query broken/corrupt objects of unknown type.
+ Allow <code>-s</code> or <code>-t</code> to query broken/corrupt objects of unknown type.
</p>
</dd>
<dt class="hdlist1">
@@ -947,12 +947,12 @@ whitespace, so that the appropriate drivers can be determined.</p></div>
</dt>
<dd>
<p>
- With --batch or --batch-check, follow symlinks inside the
+ With <code>--batch</code> or <code>--batch-check</code>, follow symlinks inside the
repository when requesting objects with extended SHA-1
expressions of the form tree-ish:path-in-tree. Instead of
providing output about the link itself, provide output about
the linked-to object. If a symlink points outside the
- tree-ish (e.g. a link to /foo or a root-level link to ../foo),
+ tree-ish (e.g. a link to <code>/foo</code> or a root-level link to <code>../foo</code>),
the portion of the link which is outside the tree will be
printed.
</p>
@@ -1015,11 +1015,11 @@ respectively print:</p></div>
<div class="sect1">
<h2 id="_output">OUTPUT</h2>
<div class="sectionbody">
-<div class="paragraph"><p>If <code>-t</code> is specified, one of the &lt;type&gt;.</p></div>
-<div class="paragraph"><p>If <code>-s</code> is specified, the size of the &lt;object&gt; in bytes.</p></div>
-<div class="paragraph"><p>If <code>-e</code> is specified, no output, unless the &lt;object&gt; is malformed.</p></div>
-<div class="paragraph"><p>If <code>-p</code> is specified, the contents of &lt;object&gt; are pretty-printed.</p></div>
-<div class="paragraph"><p>If &lt;type&gt; is specified, the raw (though uncompressed) contents of the &lt;object&gt;
+<div class="paragraph"><p>If <code>-t</code> is specified, one of the <code>&lt;type&gt;</code>.</p></div>
+<div class="paragraph"><p>If <code>-s</code> is specified, the size of the <code>&lt;object&gt;</code> in bytes.</p></div>
+<div class="paragraph"><p>If <code>-e</code> is specified, no output, unless the <code>&lt;object&gt;</code> is malformed.</p></div>
+<div class="paragraph"><p>If <code>-p</code> is specified, the contents of <code>&lt;object&gt;</code> are pretty-printed.</p></div>
+<div class="paragraph"><p>If <code>&lt;type&gt;</code> is specified, the raw (though uncompressed) contents of the <code>&lt;object&gt;</code>
will be returned.</p></div>
</div>
</div>
@@ -1040,7 +1040,7 @@ newline. The available atoms are:</p></div>
</dt>
<dd>
<p>
- The 40-hex object name of the object.
+ The full hex representation of the object name.
</p>
</dd>
<dt class="hdlist1">
@@ -1075,8 +1075,9 @@ newline. The available atoms are:</p></div>
<dd>
<p>
If the object is stored as a delta on-disk, this expands to the
- 40-hex sha1 of the delta base object. Otherwise, expands to the
- null sha1 (40 zeroes). See <code>CAVEATS</code> below.
+ full hex representation of the delta base object name.
+ Otherwise, expands to the null OID (all zeroes). See <code>CAVEATS</code>
+ below.
</p>
</dd>
<dt class="hdlist1">
@@ -1100,13 +1101,13 @@ newline.</p></div>
<div class="paragraph"><p>For example, <code>--batch</code> without a custom format would produce:</p></div>
<div class="listingblock">
<div class="content">
-<pre><code>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF
+<pre><code>&lt;oid&gt; SP &lt;type&gt; SP &lt;size&gt; LF
&lt;contents&gt; LF</code></pre>
</div></div>
<div class="paragraph"><p>Whereas <code>--batch-check='%(objectname) %(objecttype)'</code> would produce:</p></div>
<div class="listingblock">
<div class="content">
-<pre><code>&lt;sha1&gt; SP &lt;type&gt; LF</code></pre>
+<pre><code>&lt;oid&gt; SP &lt;type&gt; LF</code></pre>
</div></div>
<div class="paragraph"><p>If a name is specified on stdin that cannot be resolved to an object in
the repository, then <code>cat-file</code> will ignore any custom format and print:</p></div>
@@ -1119,7 +1120,7 @@ the repository, then <code>cat-file</code> will ignore any custom format and pri
<div class="content">
<pre><code>&lt;object&gt; SP ambiguous LF</code></pre>
</div></div>
-<div class="paragraph"><p>If --follow-symlinks is used, and a symlink in the repository points
+<div class="paragraph"><p>If <code>--follow-symlinks</code> is used, and a symlink in the repository points
outside the repository, then <code>cat-file</code> will ignore any custom format
and print:</p></div>
<div class="listingblock">
@@ -1127,10 +1128,10 @@ and print:</p></div>
<pre><code>symlink SP &lt;size&gt; LF
&lt;symlink&gt; LF</code></pre>
</div></div>
-<div class="paragraph"><p>The symlink will either be absolute (beginning with a /), or relative
-to the tree root. For instance, if dir/link points to ../../foo, then
-&lt;symlink&gt; will be ../foo. &lt;size&gt; is the size of the symlink in bytes.</p></div>
-<div class="paragraph"><p>If --follow-symlinks is used, the following error messages will be
+<div class="paragraph"><p>The symlink will either be absolute (beginning with a <code>/</code>), or relative
+to the tree root. For instance, if dir/link points to <code>../../foo</code>, then
+<code>&lt;symlink&gt;</code> will be <code>../foo</code>. <code>&lt;size&gt;</code> is the size of the symlink in bytes.</p></div>
+<div class="paragraph"><p>If <code>--follow-symlinks</code> is used, the following error messages will be
displayed:</p></div>
<div class="listingblock">
<div class="content">
@@ -1185,7 +1186,7 @@ will be reported.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2020-07-09 14:26:04 PDT
+ 2021-03-22 14:17:33 PDT
</div>
</div>
</body>