git-cat-file.txt: monospace args, placeholders and filenames
In modern documentation, args, placeholders and filenames are monospaced. Apply monospace formatting to these objects. Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:

committed by
Junio C Hamano

parent
59ec22464f
commit
4f0ba2d533
@ -35,42 +35,42 @@ OPTIONS
|
|||||||
|
|
||||||
-t::
|
-t::
|
||||||
Instead of the content, show the object type identified by
|
Instead of the content, show the object type identified by
|
||||||
<object>.
|
`<object>`.
|
||||||
|
|
||||||
-s::
|
-s::
|
||||||
Instead of the content, show the object size identified by
|
Instead of the content, show the object size identified by
|
||||||
<object>.
|
`<object>`.
|
||||||
|
|
||||||
-e::
|
-e::
|
||||||
Exit with zero status if <object> exists and is a valid
|
Exit with zero status if `<object>` exists and is a valid
|
||||||
object. If <object> is of an invalid format exit with non-zero and
|
object. If `<object>` is of an invalid format exit with non-zero and
|
||||||
emits an error on stderr.
|
emits an error on stderr.
|
||||||
|
|
||||||
-p::
|
-p::
|
||||||
Pretty-print the contents of <object> based on its type.
|
Pretty-print the contents of `<object>` based on its type.
|
||||||
|
|
||||||
<type>::
|
<type>::
|
||||||
Typically this matches the real type of <object> but asking
|
Typically this matches the real type of `<object>` but asking
|
||||||
for a type that can trivially be dereferenced from the given
|
for a type that can trivially be dereferenced from the given
|
||||||
<object> is also permitted. An example is to ask for a
|
`<object>` is also permitted. An example is to ask for a
|
||||||
"tree" with <object> being a commit object that contains it,
|
"tree" with `<object>` being a commit object that contains it,
|
||||||
or to ask for a "blob" with <object> being a tag object that
|
or to ask for a "blob" with `<object>` being a tag object that
|
||||||
points at it.
|
points at it.
|
||||||
|
|
||||||
--textconv::
|
--textconv::
|
||||||
Show the content as transformed by a textconv filter. In this case,
|
Show the content as transformed by a textconv filter. In this case,
|
||||||
<object> has to be of the form <tree-ish>:<path>, or :<path> in
|
`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in
|
||||||
order to apply the filter to the content recorded in the index at
|
order to apply the filter to the content recorded in the index at
|
||||||
<path>.
|
`<path>`.
|
||||||
|
|
||||||
--filters::
|
--filters::
|
||||||
Show the content as converted by the filters configured in
|
Show the content as converted by the filters configured in
|
||||||
the current working tree for the given <path> (i.e. smudge filters,
|
the current working tree for the given `<path>` (i.e. smudge filters,
|
||||||
end-of-line conversion, etc). In this case, <object> has to be of
|
end-of-line conversion, etc). In this case, `<object>` has to be of
|
||||||
the form <tree-ish>:<path>, or :<path>.
|
the form `<tree-ish>:<path>`, or `:<path>`.
|
||||||
|
|
||||||
--path=<path>::
|
--path=<path>::
|
||||||
For use with --textconv or --filters, to allow specifying an object
|
For use with `--textconv` or `--filters`, to allow specifying an object
|
||||||
name and a path separately, e.g. when it is difficult to figure out
|
name and a path separately, e.g. when it is difficult to figure out
|
||||||
the revision from which the blob came.
|
the revision from which the blob came.
|
||||||
|
|
||||||
@ -115,15 +115,15 @@ OPTIONS
|
|||||||
repository.
|
repository.
|
||||||
|
|
||||||
--allow-unknown-type::
|
--allow-unknown-type::
|
||||||
Allow -s or -t to query broken/corrupt objects of unknown type.
|
Allow `-s` or `-t` to query broken/corrupt objects of unknown type.
|
||||||
|
|
||||||
--follow-symlinks::
|
--follow-symlinks::
|
||||||
With --batch or --batch-check, follow symlinks inside the
|
With `--batch` or `--batch-check`, follow symlinks inside the
|
||||||
repository when requesting objects with extended SHA-1
|
repository when requesting objects with extended SHA-1
|
||||||
expressions of the form tree-ish:path-in-tree. Instead of
|
expressions of the form tree-ish:path-in-tree. Instead of
|
||||||
providing output about the link itself, provide output about
|
providing output about the link itself, provide output about
|
||||||
the linked-to object. If a symlink points outside the
|
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 `/foo` or a root-level link to `../foo`),
|
||||||
the portion of the link which is outside the tree will be
|
the portion of the link which is outside the tree will be
|
||||||
printed.
|
printed.
|
||||||
+
|
+
|
||||||
@ -175,15 +175,15 @@ respectively print:
|
|||||||
|
|
||||||
OUTPUT
|
OUTPUT
|
||||||
------
|
------
|
||||||
If `-t` is specified, one of the <type>.
|
If `-t` is specified, one of the `<type>`.
|
||||||
|
|
||||||
If `-s` is specified, the size of the <object> in bytes.
|
If `-s` is specified, the size of the `<object>` in bytes.
|
||||||
|
|
||||||
If `-e` is specified, no output, unless the <object> is malformed.
|
If `-e` is specified, no output, unless the `<object>` is malformed.
|
||||||
|
|
||||||
If `-p` is specified, the contents of <object> are pretty-printed.
|
If `-p` is specified, the contents of `<object>` are pretty-printed.
|
||||||
|
|
||||||
If <type> is specified, the raw (though uncompressed) contents of the <object>
|
If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`
|
||||||
will be returned.
|
will be returned.
|
||||||
|
|
||||||
BATCH OUTPUT
|
BATCH OUTPUT
|
||||||
@ -258,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh
|
|||||||
<object> SP ambiguous LF
|
<object> SP ambiguous LF
|
||||||
------------
|
------------
|
||||||
|
|
||||||
If --follow-symlinks is used, and a symlink in the repository points
|
If `--follow-symlinks` is used, and a symlink in the repository points
|
||||||
outside the repository, then `cat-file` will ignore any custom format
|
outside the repository, then `cat-file` will ignore any custom format
|
||||||
and print:
|
and print:
|
||||||
|
|
||||||
@ -267,11 +267,11 @@ symlink SP <size> LF
|
|||||||
<symlink> LF
|
<symlink> LF
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The symlink will either be absolute (beginning with a /), or relative
|
The symlink will either be absolute (beginning with a `/`), or relative
|
||||||
to the tree root. For instance, if dir/link points to ../../foo, then
|
to the tree root. For instance, if dir/link points to `../../foo`, then
|
||||||
<symlink> will be ../foo. <size> is the size of the symlink in bytes.
|
`<symlink>` will be `../foo`. `<size>` is the size of the symlink in bytes.
|
||||||
|
|
||||||
If --follow-symlinks is used, the following error messages will be
|
If `--follow-symlinks` is used, the following error messages will be
|
||||||
displayed:
|
displayed:
|
||||||
|
|
||||||
------------
|
------------
|
||||||
|
Reference in New Issue
Block a user