From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH 2/3] git-cat-file.txt: monospace args and placeholders
Date: Mon, 22 Feb 2021 22:39:07 -0800 [thread overview]
Message-ID: <1ab7ca7fc0928b40c47b53d97695ae911ba93c39.1614062288.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1614062288.git.liu.denton@gmail.com>
In modern documentation, args and placeholders are monospaced. Format
all remaining args and placeholders as monospace.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Documentation/git-cat-file.txt | 42 +++++++++++++++++-----------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 8e192d87db..987d170506 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -35,42 +35,42 @@ OPTIONS
-t::
Instead of the content, show the object type identified by
- <object>.
+ `<object>`.
-s::
Instead of the content, show the object size identified by
- <object>.
+ `<object>`.
-e::
- Exit with zero status if <object> exists and is a valid
- object. If <object> is of an invalid format exit with non-zero and
+ Exit with zero status if `<object>` exists and is a valid
+ object. If `<object>` is of an invalid format exit with non-zero and
emits an error on stderr.
-p::
- Pretty-print the contents of <object> based on its type.
+ Pretty-print the contents of `<object>` based on its 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
- <object> is also permitted. An example is to ask for a
- "tree" with <object> being a commit object that contains it,
- or to ask for a "blob" with <object> being a tag object that
+ `<object>` is also permitted. An example is to ask for a
+ "tree" with `<object>` being a commit object that contains it,
+ or to ask for a "blob" with `<object>` being a tag object that
points at it.
--textconv::
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
- <path>.
+ `<path>`.
--filters::
Show the content as converted by the filters configured in
- 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
- the form <tree-ish>:<path>, or :<path>.
+ 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
+ the form `<tree-ish>:<path>`, or `:<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
the revision from which the blob came.
@@ -115,7 +115,7 @@ OPTIONS
repository.
--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::
With --batch or --batch-check, follow symlinks inside the
@@ -175,15 +175,15 @@ respectively print:
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.
BATCH OUTPUT
--
2.30.0.478.g8a0d178c01
next prev parent reply other threads:[~2021-02-23 6:42 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-23 6:39 [PATCH 0/3] docs: misc cleanup Denton Liu
2021-02-23 6:39 ` [PATCH 1/3] i18n.txt: camel case and monospace "i18n.commitEncoding" Denton Liu
2021-02-23 19:15 ` Junio C Hamano
2021-02-23 19:26 ` [PATCH v2] " Junio C Hamano
2021-02-23 19:32 ` Eric Sunshine
2021-02-23 19:41 ` Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 0/3] doc: spell configuration variable names in camelCase Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 1/3] i18n.txt: camel case and monospace "i18n.commitEncoding" Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 2/3] blame-options.txt: camelcase blame.blankBoundary Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 3/3] index-format doc: camelCase core.excludesFile Junio C Hamano
2021-02-23 6:39 ` Denton Liu [this message]
2021-02-23 6:44 ` [PATCH 2/3] git-cat-file.txt: monospace args and placeholders Eric Sunshine
2021-02-23 6:59 ` [PATCH v1.1 2/3] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-02-23 6:39 ` [PATCH 3/3] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-02-23 6:48 ` Eric Sunshine
2021-02-23 7:17 ` [PATCH v2] " Denton Liu
2021-02-23 7:48 ` Junio C Hamano
2021-03-03 9:21 ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup Denton Liu
2021-03-03 9:21 ` [PATCH v2 1/2] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-03-03 9:21 ` [PATCH v2 2/2] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-03-04 0:43 ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1ab7ca7fc0928b40c47b53d97695ae911ba93c39.1614062288.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).