summaryrefslogtreecommitdiff
path: root/Documentation/git-show.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-show.txt')
-rw-r--r--Documentation/git-show.txt84
1 files changed, 61 insertions, 23 deletions
diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 2b4df3f96f..4e617e6979 100644
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -3,47 +3,85 @@ git-show(1)
NAME
----
-git-show - Show one commit with difference it introduces
+git-show - Show various types of objects
SYNOPSIS
--------
-'git-show' <option>...
+[verse]
+'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 'git ls-tree'
+with \--name-only).
+
+For plain blobs, it shows the plain contents.
+
+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.
OPTIONS
-------
-<commitid>::
- ID of the commit to show.
+<object>...::
+ The names of objects to show.
+ For a more complete list of ways to spell object names, see
+ "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
+
+include::pretty-options.txt[]
+
+
+include::pretty-formats.txt[]
+
---pretty=<format>::
- Controls the output format for the commit logs.
- <format> can be one of 'raw', 'medium', 'short', 'full',
- and 'oneline'.
+COMMON DIFF OPTIONS
+-------------------
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org> and
-Junio C Hamano <junkio@cox.net>
+:git-log: 1
+include::diff-options.txt[]
+include::diff-generate-patch.txt[]
-Documentation
--------------
-Documentation by David Greaves, Petr Baudis and the git-list <git@vger.kernel.org>.
-This manual page is a stub. You can help the git documentation by expanding it.
+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 -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
+ `next`.
+
+`git show master:Makefile master:t/Makefile`::
+ Concatenates the contents of said Makefiles in the head
+ of the branch `master`.
+
+Discussion
+----------
+
+include::i18n.txt[]
GIT
---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite