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-whatchanged.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-whatchanged.txt')
| -rw-r--r-- | Documentation/git-whatchanged.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 99388bd374..76c7f7eec5 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -53,12 +53,12 @@ include::pretty-formats.txt[] Examples -------- -git whatchanged -p v2.6.12.. include/scsi drivers/scsi:: +`git whatchanged -p v2.6.12.. include/scsi drivers/scsi`:: Show as patches the commits since version 'v2.6.12' that changed any file in the include/scsi or drivers/scsi subdirectories -git whatchanged --since="2 weeks ago" \-- gitk:: +`git whatchanged --since="2 weeks ago" \-- gitk`:: Show the changes during the last two weeks to the file 'gitk'. The "--" is necessary to avoid confusion with the *branch* named |