aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-show.adoc
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2025-01-20 01:56:02 +0000
committerJunio C Hamano <gitster@pobox.com>2025-01-21 12:56:06 -0800
commit1f010d6bdf756129db13d1367c888aa4153f6d87 (patch)
tree715708841b4980198157a60e72028e25a0059177 /Documentation/git-show.adoc
parented4cf6e8e29bebb9324ba1a400a6c07513f2d642 (diff)
downloadgit-1f010d6bdf756129db13d1367c888aa4153f6d87.tar.xz
doc: use .adoc extension for AsciiDoc files
We presently use the ".txt" extension for our AsciiDoc files. While not wrong, most editors do not associate this extension with AsciiDoc, meaning that contributors don't get automatic editor functionality that could be useful, such as syntax highlighting and prose linting. It is much more common to use the ".adoc" extension for AsciiDoc files, since this helps editors automatically detect files and also allows various forges to provide rich (HTML-like) rendering. Let's do that here, renaming all of the files and updating the includes where relevant. Adjust the various build scripts and makefiles to use the new extension as well. Note that this should not result in any user-visible changes to the documentation. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-show.adoc')
-rw-r--r--Documentation/git-show.adoc90
1 files changed, 90 insertions, 0 deletions
diff --git a/Documentation/git-show.adoc b/Documentation/git-show.adoc
new file mode 100644
index 0000000000..51044c814f
--- /dev/null
+++ b/Documentation/git-show.adoc
@@ -0,0 +1,90 @@
+git-show(1)
+===========
+
+NAME
+----
+git-show - Show various types of objects
+
+
+SYNOPSIS
+--------
+[verse]
+'git show' [<options>] [<object>...]
+
+DESCRIPTION
+-----------
+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.
+
+Some options that 'git log' command understands can be used to
+control how the changes the commit introduces are shown.
+
+This manual page describes only the most frequently used options.
+
+
+OPTIONS
+-------
+<object>...::
+ The names of objects to show (defaults to 'HEAD').
+ For a more complete list of ways to spell object names, see
+ "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
+
+include::pretty-options.adoc[]
+
+
+include::pretty-formats.adoc[]
+
+
+DIFF FORMATTING
+---------------
+The options below can be used to change the way `git show` generates
+diff output.
+
+:git-log: 1
+:diff-merges-default: `dense-combined`
+include::diff-options.adoc[]
+
+include::diff-generate-patch.adoc[]
+
+
+EXAMPLES
+--------
+
+`git show v1.0.0`::
+ Shows the tag `v1.0.0`, along with the object the tag
+ 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.adoc[]
+
+GIT
+---
+Part of the linkgit:git[1] suite