[PATCH] Documentation: document show -s

From

Jonathan Nieder <jrnieder@gmail.com>

Date

Nov 9, 2010, 17:12 UTC

Message-ID

<20101109171248.GG18960@burratino>

In-Reply-To

<4CD97399.4010704@gnatter.net>

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

	git show -s rev

	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>
---
Will Hall wrote:

> I know this should be obvious but I can't find *any* reference to
> this in git show --help

Thanks, good catch.

 Documentation/git-show.txt         |    4 ++++
 Documentation/rev-list-options.txt |    3 +++
 2 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 2049c60..f0a8a1a 100644
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -54,6 +54,10 @@ git show v1.0.0::
 git show v1.0.0^\{tree\}::
 	Shows the tree pointed to by the tag `v1.0.0`.
 
+git show -s --format=%s v1.0.0^\{commit\}::
+	Shows the subject of the commit pointed to by the
+	tag `v1.0.0`.
+
 git show next~10:Documentation/README::
 	Shows the contents of the file `Documentation/README` as
 	they were current in the 10th last commit of the branch
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 7a42567..1aaaf5a 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -146,6 +146,9 @@ options may be given. See linkgit:git-diff-files[1] for more options.
 -t::
 
 	Show the tree objects in the diff output. This implies '-r'.
+
+-s::
+	Suppress diff output.
 endif::git-rev-list[]
 
 Commit Limiting

-- 
1.7.2.3.557.gab647.dirty