diff options
| author | Jeff King <peff@peff.net> | 2011-08-03 20:13:29 -0600 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-08-04 15:49:13 -0700 |
| commit | 5d2fc9135a35284176e99708b9b6f32c9e6eb7a2 (patch) | |
| tree | 33f4b86622e56d19e4fe706b05e0c6e22a86f216 /Documentation/git-show.txt | |
| parent | 927cd1fc940f7b588521b388aeb610ab3890399e (diff) | |
| download | git-5d2fc9135a35284176e99708b9b6f32c9e6eb7a2.tar.gz | |
docs: put listed example commands in backticks
Many examples of git command invocation are given in asciidoc listing
blocks, which makes them monospaced and avoids further interpretation of
special characters. Some manpages make a list of examples, like:
git foo::
Run git foo.
git foo -q::
Use the "-q" option.
to quickly show many variants. However, they can sometimes be hard to
read, because they are shown in a proportional-width font (so, for
example, seeing the difference between "-- foo" and "--foo" can be
difficult).
This patch puts all such examples into backticks, which gives the
equivalent formatting to a listing block (i.e., monospaced and without
character interpretation).
As a bonus, this also fixes an example in the git-push manpage, in which
"git push origin :::" was accidentally considered a newly-indented list,
and not a list item with "git push origin :" in it.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-show.txt')
| -rw-r--r-- | Documentation/git-show.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 1f0e30b912..1e38819e67 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -48,23 +48,23 @@ include::pretty-formats.txt[] EXAMPLES -------- -git show v1.0.0:: +`git show v1.0.0`:: Shows the tag `v1.0.0`, along with the object the tags points at. -git show v1.0.0^\{tree\}:: +`git show v1.0.0^\{tree\}`:: Shows the tree pointed to by the tag `v1.0.0`. -git show -s --format=%s v1.0.0^\{commit\}:: +`git show -s --format=%s v1.0.0^\{commit\}`:: Shows the subject of the commit pointed to by the tag `v1.0.0`. -git show next~10:Documentation/README:: +`git show next~10:Documentation/README`:: Shows the contents of the file `Documentation/README` as they were current in the 10th last commit of the branch `next`. -git show master:Makefile master:t/Makefile:: +`git show master:Makefile master:t/Makefile`:: Concatenates the contents of said Makefiles in the head of the branch `master`. |