docs: put listed example commands in backticks
authorJeff King <peff@peff.net>
Thu, 4 Aug 2011 02:13:29 +0000 (20:13 -0600)
committerJunio C Hamano <gitster@pobox.com>
Thu, 4 Aug 2011 22:49:13 +0000 (15:49 -0700)
commit5d2fc9135a35284176e99708b9b6f32c9e6eb7a2
tree33f4b86622e56d19e4fe706b05e0c6e22a86f216
parent927cd1fc940f7b588521b388aeb610ab3890399e
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>
13 files changed:
Documentation/git-archive.txt
Documentation/git-cherry-pick.txt
Documentation/git-grep.txt
Documentation/git-gui.txt
Documentation/git-log.txt
Documentation/git-merge-file.txt
Documentation/git-push.txt
Documentation/git-remote-fd.txt
Documentation/git-revert.txt
Documentation/git-rm.txt
Documentation/git-show.txt
Documentation/git-tar-tree.txt
Documentation/git-whatchanged.txt