git/Documentation/git-show.adoc
brian m. carlson 1f010d6bdf 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>
2025-01-21 12:56:06 -08:00

91 lines
1.9 KiB
Plaintext

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