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-revert.txt | |
parent | 927cd1fc940f7b588521b388aeb610ab3890399e (diff) | |
download | git-5d2fc9135a35284176e99708b9b6f32c9e6eb7a2.tar.gz git-5d2fc9135a35284176e99708b9b6f32c9e6eb7a2.tar.xz |
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-revert.txt')
-rw-r--r-- | Documentation/git-revert.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 3d0a7d1da..b311d59c7 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -93,12 +93,12 @@ effect to your index in a row. EXAMPLES -------- -git revert HEAD~3:: +`git revert HEAD~3`:: Revert the changes specified by the fourth last commit in HEAD and create a new commit with the reverted changes. -git revert -n master{tilde}5..master{tilde}2:: +`git revert -n master{tilde}5..master{tilde}2`:: Revert the changes done by commits from the fifth last commit in master (included) to the third last commit in master |