Merge 1.5.1.5 in

[git.git] / Documentation / git-show.txt

diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 9c359a448ed835991dd3e373de46fdfa704ec3e9..34c5caf2d08324cc1595013cbdcd40d89d7a1968 100644 (file)
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -3,38 +3,76 @@ git-show(1)
 
 NAME
 ----
-git-show - Show one commit with difference it introduces.
+git-show - Show various types of objects
 
 
 SYNOPSIS
 --------
-'git-show' <option>...
+'git-show' [options] <object>...
 
 DESCRIPTION
 -----------
-Shows commit log and textual diff for a single commit.  The
-command internally invokes 'git-rev-list' piped to
-'git-diff-tree', and takes command line options for both of
-these commands. It also presents the merge commit in a special
-format as produced by 'git-diff-tree --cc'.
+Shows one or more objects (blobs, trees, tags and commits).
+
+For commits it shows the log message and textual diff. It also
+presents the merge commit in a special format as produced by
+'git-diff-tree --cc'.
+
+For tags, it shows the tag message and the referenced objects.
+
+For trees, it shows the names (equivalent to gitlink:git-ls-tree[1]
+with \--name-only).
+
+For plain blobs, it shows the plain contents.
+
+The command takes options applicable to the gitlink:git-diff-tree[1] command to
+control how the changes the commit introduces are shown.
 
 This manual page describes only the most frequently used options.
 
 
 OPTIONS
 -------
-<commitid>::
-       ID of the commit to show.
+<object>::
+       The name of the object to show.
+       For a more complete list of ways to spell object names, see
+       "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
+
+include::pretty-options.txt[]
+
+
+include::pretty-formats.txt[]
+
+
+EXAMPLES
+--------
+
+git show v1.0.0::
+       Shows the tag `v1.0.0`, along with the object the tags
+       points at.
+
+git show v1.0.0^\{tree\}::
+       Shows the tree 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
+       `next`.
+
+git show master:Makefile master:t/Makefile::
+       Concatenates the contents of said Makefiles in the head
+       of the branch `master`.
+
+Discussion
+----------
 
---pretty=<format>::
-       Controls the output format for the commit logs.
-       <format> can be one of 'raw', 'medium', 'short', 'full',
-       and 'oneline'.
+include::i18n.txt[]
 
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org> and
-Junio C Hamano <junkio@cox.net>
+Junio C Hamano <junkio@cox.net>.  Significantly enhanced by
+Johannes Schindelin <Johannes.Schindelin@gmx.de>.
 
 
 Documentation