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-remote-fd.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-remote-fd.txt')
-rw-r--r-- | Documentation/git-remote-fd.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index 4aecd4d18..f095d57d0 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt @@ -35,19 +35,19 @@ GIT_TRANSLOOP_DEBUG:: EXAMPLES -------- -git fetch fd::17 master:: +`git fetch fd::17 master`:: Fetch master, using file descriptor #17 to communicate with git-upload-pack. -git fetch fd::17/foo master:: +`git fetch fd::17/foo master`:: Same as above. -git push fd::7,8 master (as URL):: +`git push fd::7,8 master (as URL)`:: Push master, using file descriptor #7 to read data from git-receive-pack and file descriptor #8 to write data to same service. -git push fd::7,8/bar master:: +`git push fd::7,8/bar master`:: Same as above. Documentation |