git/Documentation/git-whatchanged.txt
Jeff King 5d2fc9135a 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>
2011-08-04 15:49:13 -07:00

69 lines
1.5 KiB
Text

git-whatchanged(1)
==================
NAME
----
git-whatchanged - Show logs with difference each commit introduces
SYNOPSIS
--------
[verse]
'git whatchanged' <option>...
DESCRIPTION
-----------
Shows commit logs and diff output each commit introduces. The
command internally invokes 'git rev-list' piped to
'git diff-tree', and takes command line options for both of
these commands.
This manual page describes only the most frequently used options.
OPTIONS
-------
-p::
Show textual diffs, instead of the git internal diff
output format that is useful only to tell the changed
paths and their nature of changes.
-<n>::
Limit output to <n> commits.
<since>..<until>::
Limit output to between the two named commits (bottom
exclusive, top inclusive).
-r::
Show git internal diff output, but for the whole tree,
not just the top level.
-m::
By default, differences for merge commits are not shown.
With this flag, show differences to that commit from all
of its parents.
+
However, it is not very useful in general, although it
*is* useful on a file-by-file basis.
include::pretty-options.txt[]
include::pretty-formats.txt[]
Examples
--------
`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`::
Show the changes during the last two weeks to the file 'gitk'.
The "--" is necessary to avoid confusion with the *branch* named
'gitk'
GIT
---
Part of the linkgit:git[1] suite