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>
Denton Liu committed
Mar 3, 2021 at 01:21 UTC
4f0ba2d533360505ac7d1c9b6e673b2b38ca80de
1 file changed
+28
-28
Documentation/git-cat-file.txt
+28
-28
@@ -35,42 +35,42 @@ OPTIONS
35
36
-t::
37
Instead of the content, show the object type identified by
38
- <object>.
38
+ `<object>`.
39
40
-s::
41
Instead of the content, show the object size identified by
42
- <object>.
42
+ `<object>`.
43
44
-e::
45
- Exit with zero status if <object> exists and is a valid
46
- object. If <object> is of an invalid format exit with non-zero and
45
+ Exit with zero status if `<object>` exists and is a valid
46
+ object. If `<object>` is of an invalid format exit with non-zero and
47
emits an error on stderr.
48
49
-p::
50
- Pretty-print the contents of <object> based on its type.
50
+ Pretty-print the contents of `<object>` based on its type.
51
52
<type>::
53
- Typically this matches the real type of <object> but asking
53
+ Typically this matches the real type of `<object>` but asking
54
for a type that can trivially be dereferenced from the given
55
- <object> is also permitted. An example is to ask for a
56
- "tree" with <object> being a commit object that contains it,
57
- or to ask for a "blob" with <object> being a tag object that
55
+ `<object>` is also permitted. An example is to ask for a
56
+ "tree" with `<object>` being a commit object that contains it,
57
+ or to ask for a "blob" with `<object>` being a tag object that
58
points at it.
59
60
--textconv::
61
Show the content as transformed by a textconv filter. In this case,
62
- <object> has to be of the form <tree-ish>:<path>, or :<path> in
62
+ `<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in
63
order to apply the filter to the content recorded in the index at
64
- <path>.
64
+ `<path>`.
65
66
--filters::
67
Show the content as converted by the filters configured in
68
- the current working tree for the given <path> (i.e. smudge filters,
69
- end-of-line conversion, etc). In this case, <object> has to be of
70
- the form <tree-ish>:<path>, or :<path>.
68
+ the current working tree for the given `<path>` (i.e. smudge filters,
69
+ end-of-line conversion, etc). In this case, `<object>` has to be of
70
+ the form `<tree-ish>:<path>`, or `:<path>`.
71
72
--path=<path>::
73
- For use with --textconv or --filters, to allow specifying an object
73
+ For use with `--textconv` or `--filters`, to allow specifying an object
74
name and a path separately, e.g. when it is difficult to figure out
75
the revision from which the blob came.
76
@@ -115,15 +115,15 @@ OPTIONS
115
repository.
116
117
--allow-unknown-type::
118
- Allow -s or -t to query broken/corrupt objects of unknown type.
118
+ Allow `-s` or `-t` to query broken/corrupt objects of unknown type.
119
120
--follow-symlinks::
121
- With --batch or --batch-check, follow symlinks inside the
121
+ With `--batch` or `--batch-check`, follow symlinks inside the
122
repository when requesting objects with extended SHA-1
123
expressions of the form tree-ish:path-in-tree. Instead of
124
providing output about the link itself, provide output about
125
the linked-to object. If a symlink points outside the
126
- tree-ish (e.g. a link to /foo or a root-level link to ../foo),
126
+ tree-ish (e.g. a link to `/foo` or a root-level link to `../foo`),
127
the portion of the link which is outside the tree will be
128
printed.
129
+
@@ -175,15 +175,15 @@ respectively print:
175
176
OUTPUT
177
------
178
-If `-t` is specified, one of the <type>.
178
+If `-t` is specified, one of the `<type>`.
179
180
-If `-s` is specified, the size of the <object> in bytes.
180
+If `-s` is specified, the size of the `<object>` in bytes.
181
182
-If `-e` is specified, no output, unless the <object> is malformed.
182
+If `-e` is specified, no output, unless the `<object>` is malformed.
183
184
-If `-p` is specified, the contents of <object> are pretty-printed.
184
+If `-p` is specified, the contents of `<object>` are pretty-printed.
185
186
-If <type> is specified, the raw (though uncompressed) contents of the <object>
186
+If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`
187
will be returned.
188
189
BATCH OUTPUT
@@ -258,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh
258
<object> SP ambiguous LF
259
------------
260
261
-If --follow-symlinks is used, and a symlink in the repository points
261
+If `--follow-symlinks` is used, and a symlink in the repository points
262
outside the repository, then `cat-file` will ignore any custom format
263
and print:
264
@@ -267,11 +267,11 @@ symlink SP <size> LF
267
<symlink> LF
268
------------
269
270
-The symlink will either be absolute (beginning with a /), or relative
271
-to the tree root. For instance, if dir/link points to ../../foo, then
272
-<symlink> will be ../foo. <size> is the size of the symlink in bytes.
270
+The symlink will either be absolute (beginning with a `/`), or relative
271
+to the tree root. For instance, if dir/link points to `../../foo`, then
272
+`<symlink>` will be `../foo`. `<size>` is the size of the symlink in bytes.
273
274
-If --follow-symlinks is used, the following error messages will be
274
+If `--follow-symlinks` is used, the following error messages will be
275
displayed:
276
277
------------