mirror of
https://github.com/git/git.git
synced 2024-11-17 22:44:49 +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>
96 lines
3.1 KiB
Text
96 lines
3.1 KiB
Text
git-reflog(1)
|
|
=============
|
|
|
|
NAME
|
|
----
|
|
git-reflog - Manage reflog information
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git reflog' <subcommand> <options>
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The command takes various subcommands, and different options
|
|
depending on the subcommand:
|
|
|
|
[verse]
|
|
'git reflog expire' [--dry-run] [--stale-fix] [--verbose]
|
|
[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
|
|
'git reflog delete' ref@\{specifier\}...
|
|
'git reflog' ['show'] [log-options] [<ref>]
|
|
|
|
Reflog is a mechanism to record when the tip of branches are
|
|
updated. This command is to manage the information recorded in it.
|
|
|
|
The subcommand "expire" is used to prune older reflog entries.
|
|
Entries older than `expire` time, or entries older than
|
|
`expire-unreachable` time and not reachable from the current
|
|
tip, are removed from the reflog. This is typically not used
|
|
directly by the end users -- instead, see linkgit:git-gc[1].
|
|
|
|
The subcommand "show" (which is also the default, in the absence of any
|
|
subcommands) will take all the normal log options, and show the log of
|
|
the reference provided in the command-line (or `HEAD`, by default).
|
|
The reflog will cover all recent actions (HEAD reflog records branch switching
|
|
as well). It is an alias for `git log -g --abbrev-commit --pretty=oneline`;
|
|
see linkgit:git-log[1].
|
|
|
|
The reflog is useful in various git commands, to specify the old value
|
|
of a reference. For example, `HEAD@{2}` means "where HEAD used to be
|
|
two moves ago", `master@{one.week.ago}` means "where master used to
|
|
point to one week ago", and so on. See linkgit:gitrevisions[7] for
|
|
more details.
|
|
|
|
To delete single entries from the reflog, use the subcommand "delete"
|
|
and specify the _exact_ entry (e.g. "`git reflog delete master@{2}`").
|
|
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--stale-fix::
|
|
This revamps the logic -- the definition of "broken commit"
|
|
becomes: a commit that is not reachable from any of the refs and
|
|
there is a missing object among the commit, tree, or blob
|
|
objects reachable from it that is not reachable from any of the
|
|
refs.
|
|
+
|
|
This computation involves traversing all the reachable objects, i.e. it
|
|
has the same cost as 'git prune'. Fortunately, once this is run, we
|
|
should not have to ever worry about missing objects, because the current
|
|
prune and pack-objects know about reflogs and protect objects referred by
|
|
them.
|
|
|
|
--expire=<time>::
|
|
Entries older than this time are pruned. Without the
|
|
option it is taken from configuration `gc.reflogExpire`,
|
|
which in turn defaults to 90 days.
|
|
|
|
--expire-unreachable=<time>::
|
|
Entries older than this time and not reachable from
|
|
the current tip of the branch are pruned. Without the
|
|
option it is taken from configuration
|
|
`gc.reflogExpireUnreachable`, which in turn defaults to
|
|
30 days.
|
|
|
|
--all::
|
|
Instead of listing <refs> explicitly, prune all refs.
|
|
|
|
--updateref::
|
|
Update the ref with the sha1 of the top reflog entry (i.e.
|
|
<ref>@\{0\}) after expiring or deleting.
|
|
|
|
--rewrite::
|
|
While expiring or deleting, adjust each reflog entry to ensure
|
|
that the `old` sha1 field points to the `new` sha1 field of the
|
|
previous entry.
|
|
|
|
--verbose::
|
|
Print extra information on screen.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|