mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
![Jeff King](/assets/img/avatar_default.png)
In asciidoc 7, backticks like `foo` produced a typographic effect, but did not otherwise affect the syntax. In asciidoc 8, backticks introduce an "inline literal" inside which markup is not interpreted. To keep compatibility with existing documents, asciidoc 8 has a "no-inline-literal" attribute to keep the old behavior. We enabled this so that the documentation could be built on either version. It has been several years now, and asciidoc 7 is no longer in wide use. We can now decide whether or not we want inline literals on their own merits, which are: 1. The source is much easier to read when the literal contains punctuation. You can use `master~1` instead of `master{tilde}1`. 2. They are less error-prone. Because of point (1), we tend to make mistakes and forget the extra layer of quoting. This patch removes the no-inline-literal attribute from the Makefile and converts every use of backticks in the documentation to an inline literal (they must be cleaned up, or the example above would literally show "{tilde}" in the output). Problematic sites were found by grepping for '`.*[{\\]' and examined and fixed manually. The results were then verified by comparing the output of "html2text" on the set of generated html pages. Doing so revealed that in addition to making the source more readable, this patch fixes several formatting bugs: - HTML rendering used the ellipsis character instead of literal "..." in code examples (like "git log A...B") - some code examples used the right-arrow character instead of '->' because they failed to quote - api-config.txt did not quote tilde, and the resulting HTML contained a bogus snippet like: <tt><sub></tt> foo <tt></sub>bar</tt> which caused some parsers to choke and omit whole sections of the page. - git-commit.txt confused ``foo`` (backticks inside a literal) with ``foo'' (matched double-quotes) - mentions of `A U Thor <author@example.com>` used to erroneously auto-generate a mailto footnote for author@example.com - the description of --word-diff=plain incorrectly showed the output as "[-removed-] and {added}", not "{+added+}". - using "prime" notation like: commit `C` and its replacement `C'` confused asciidoc into thinking that everything between the first backtick and the final apostrophe were meant to be inside matched quotes - asciidoc got confused by the escaping of some of our asterisks. In particular, `credential.\*` and `credential.<url>.\*` properly escaped the asterisk in the first case, but literally passed through the backslash in the second case. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
79 lines
1.6 KiB
Plaintext
79 lines
1.6 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.
|
|
|
|
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
|
|
-------
|
|
<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[]
|
|
|
|
|
|
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 linkgit:git[1] suite
|