mirror of
https://github.com/git/git.git
synced 2024-11-05 16:52:59 +01:00
6cf378f0cb
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>
182 lines
5.8 KiB
Text
182 lines
5.8 KiB
Text
git-show-ref(1)
|
|
===============
|
|
|
|
NAME
|
|
----
|
|
git-show-ref - List references in a local repository
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git show-ref' [-q|--quiet] [--verify] [--head] [-d|--dereference]
|
|
[-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags]
|
|
[--heads] [--] [<pattern>...]
|
|
'git show-ref' --exclude-existing[=<pattern>] < ref-list
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Displays references available in a local repository along with the associated
|
|
commit IDs. Results can be filtered using a pattern and tags can be
|
|
dereferenced into object IDs. Additionally, it can be used to test whether a
|
|
particular ref exists.
|
|
|
|
The --exclude-existing form is a filter that does the inverse, it shows the
|
|
refs from stdin that don't exist in the local repository.
|
|
|
|
Use of this utility is encouraged in favor of directly accessing files under
|
|
the `.git` directory.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--head::
|
|
|
|
Show the HEAD reference.
|
|
|
|
--tags::
|
|
--heads::
|
|
|
|
Limit to only "refs/heads" and "refs/tags", respectively. These
|
|
options are not mutually exclusive; when given both, references stored
|
|
in "refs/heads" and "refs/tags" are displayed.
|
|
|
|
-d::
|
|
--dereference::
|
|
|
|
Dereference tags into object IDs as well. They will be shown with "{caret}{}"
|
|
appended.
|
|
|
|
-s::
|
|
--hash[=<n>]::
|
|
|
|
Only show the SHA1 hash, not the reference name. When combined with
|
|
--dereference the dereferenced tag will still be shown after the SHA1.
|
|
|
|
--verify::
|
|
|
|
Enable stricter reference checking by requiring an exact ref path.
|
|
Aside from returning an error code of 1, it will also print an error
|
|
message if '--quiet' was not specified.
|
|
|
|
--abbrev[=<n>]::
|
|
|
|
Abbreviate the object name. When using `--hash`, you do
|
|
not have to say `--hash --abbrev`; `--hash=n` would do.
|
|
|
|
-q::
|
|
--quiet::
|
|
|
|
Do not print any results to stdout. When combined with '--verify' this
|
|
can be used to silently check if a reference exists.
|
|
|
|
--exclude-existing[=<pattern>]::
|
|
|
|
Make 'git show-ref' act as a filter that reads refs from stdin of the
|
|
form "`^(?:<anything>\s)?<refname>(?:\^{})?$`"
|
|
and performs the following actions on each:
|
|
(1) strip "{caret}{}" at the end of line if any;
|
|
(2) ignore if pattern is provided and does not head-match refname;
|
|
(3) warn if refname is not a well-formed refname and skip;
|
|
(4) ignore if refname is a ref that exists in the local repository;
|
|
(5) otherwise output the line.
|
|
|
|
|
|
<pattern>...::
|
|
|
|
Show references matching one or more patterns. Patterns are matched from
|
|
the end of the full name, and only complete parts are matched, e.g.
|
|
'master' matches 'refs/heads/master', 'refs/remotes/origin/master',
|
|
'refs/tags/jedi/master' but not 'refs/heads/mymaster' nor
|
|
'refs/remotes/master/jedi'.
|
|
|
|
OUTPUT
|
|
------
|
|
|
|
The output is in the format: '<SHA-1 ID>' '<space>' '<reference name>'.
|
|
|
|
-----------------------------------------------------------------------------
|
|
$ git show-ref --head --dereference
|
|
832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
|
|
832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
|
|
832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
|
|
3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
|
|
6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
|
|
055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
|
|
423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
|
|
...
|
|
-----------------------------------------------------------------------------
|
|
|
|
When using --hash (and not --dereference) the output format is: '<SHA-1 ID>'
|
|
|
|
-----------------------------------------------------------------------------
|
|
$ git show-ref --heads --hash
|
|
2e3ba0114a1f52b47df29743d6915d056be13278
|
|
185008ae97960c8d551adcd9e23565194651b5d1
|
|
03adf42c988195b50e1a1935ba5fcbc39b2b029b
|
|
...
|
|
-----------------------------------------------------------------------------
|
|
|
|
EXAMPLE
|
|
-------
|
|
|
|
To show all references called "master", whether tags or heads or anything
|
|
else, and regardless of how deep in the reference naming hierarchy they are,
|
|
use:
|
|
|
|
-----------------------------------------------------------------------------
|
|
git show-ref master
|
|
-----------------------------------------------------------------------------
|
|
|
|
This will show "refs/heads/master" but also "refs/remote/other-repo/master",
|
|
if such references exists.
|
|
|
|
When using the '--verify' flag, the command requires an exact path:
|
|
|
|
-----------------------------------------------------------------------------
|
|
git show-ref --verify refs/heads/master
|
|
-----------------------------------------------------------------------------
|
|
|
|
will only match the exact branch called "master".
|
|
|
|
If nothing matches, 'git show-ref' will return an error code of 1,
|
|
and in the case of verification, it will show an error message.
|
|
|
|
For scripting, you can ask it to be quiet with the "--quiet" flag, which
|
|
allows you to do things like
|
|
|
|
-----------------------------------------------------------------------------
|
|
git show-ref --quiet --verify -- "refs/heads/$headname" ||
|
|
echo "$headname is not a valid branch"
|
|
-----------------------------------------------------------------------------
|
|
|
|
to check whether a particular branch exists or not (notice how we don't
|
|
actually want to show any results, and we want to use the full refname for it
|
|
in order to not trigger the problem with ambiguous partial matches).
|
|
|
|
To show only tags, or only proper branch heads, use "--tags" and/or "--heads"
|
|
respectively (using both means that it shows tags and heads, but not other
|
|
random references under the refs/ subdirectory).
|
|
|
|
To do automatic tag object dereferencing, use the "-d" or "--dereference"
|
|
flag, so you can do
|
|
|
|
-----------------------------------------------------------------------------
|
|
git show-ref --tags --dereference
|
|
-----------------------------------------------------------------------------
|
|
|
|
to get a listing of all tags together with what they dereference.
|
|
|
|
FILES
|
|
-----
|
|
`.git/refs/*`, `.git/packed-refs`
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkgit:git-ls-remote[1],
|
|
linkgit:git-update-ref[1],
|
|
linkgit:gitrepository-layout[5]
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|