@matheusbsbs / matheus-bagliano / commits / 60aa9cf8f3
Fork 0

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>

Jonathan Nieder committed Nov 9, 2010 at 11:12 UTC 60aa9cf8f370b69eb7feaad2e1cbcd04280bc799
2 files changed +7
Documentation/git-show.txt
+4
@@ -54,6 +54,10 @@ git show v1.0.0::
54 git show v1.0.0^\{tree\}::
55 Shows the tree pointed to by the tag `v1.0.0`.
56
57 +git show -s --format=%s v1.0.0^\{commit\}::
58 + Shows the subject of the commit pointed to by the
59 + tag `v1.0.0`.
60 +
61 git show next~10:Documentation/README::
62 Shows the contents of the file `Documentation/README` as
63 they were current in the 10th last commit of the branch
Documentation/rev-list-options.txt
+3
@@ -146,6 +146,9 @@ options may be given. See linkgit:git-diff-files[1] for more options.
146 -t::
147
148 Show the tree objects in the diff output. This implies '-r'.
149 +
150 +-s::
151 + Suppress diff output.
152 endif::git-rev-list[]
153
154 Commit Limiting