Code

Documentation: document show -s
authorJonathan Nieder <jrnieder@gmail.com>
Tue, 9 Nov 2010 17:12:48 +0000 (11:12 -0600)
committerJunio C Hamano <gitster@pobox.com>
Tue, 9 Nov 2010 17:42:57 +0000 (09:42 -0800)
commit60aa9cf8f370b69eb7feaad2e1cbcd04280bc799
tree1b8ba89a5608450b4f045ed76828f390cdaaf806
parentae3cdfe1123d153f720bbe4a4abc97ed3e9f65a4
Documentation: document show -s

Git's diff machinery has supported a -s (silence diff output) option
as far back as v0.99~900 (Silent flag for show-diff, 2005-04-13), but
the option is only advertised in an odd corner of the git diff-tree
manual.

The main use is to retrieve basic metadata about a commit:

git show -s rev

Explain this in the 'git log' manual and provide an example in the
'git show' examples section.  This is kind of a cop-out, since it
would be more useful to explain it in the 'git show' manual proper,
which says:

The command takes options applicable to the git
diff-tree command to control how the changes the
commit introduces are shown.

This manual page describes only the most frequently
used options.

Fixing that is a larger task for another day.

Reported-by: Will Hall <will@gnatter.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-show.txt
Documentation/rev-list-options.txt