mirror of
https://github.com/git/git.git
synced 2024-11-08 18:23:01 +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>
191 lines
5.4 KiB
Text
191 lines
5.4 KiB
Text
git-log(1)
|
|
==========
|
|
|
|
NAME
|
|
----
|
|
git-log - Show commit logs
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git log' [<options>] [<since>..<until>] [[\--] <path>...]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Shows the commit logs.
|
|
|
|
The command takes options applicable to the 'git rev-list'
|
|
command to control what is shown and how, and options applicable to
|
|
the 'git diff-*' commands to control how the changes
|
|
each commit introduces are shown.
|
|
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
-<n>::
|
|
Limits the number of commits to show.
|
|
Note that this is a commit limiting option, see below.
|
|
|
|
<since>..<until>::
|
|
Show only commits between the named two commits. When
|
|
either <since> or <until> is omitted, it defaults to
|
|
`HEAD`, i.e. the tip of the current branch.
|
|
For a more complete list of ways to spell <since>
|
|
and <until>, see linkgit:gitrevisions[7].
|
|
|
|
--follow::
|
|
Continue listing the history of a file beyond renames
|
|
(works only for a single file).
|
|
|
|
--no-decorate::
|
|
--decorate[=short|full|no]::
|
|
Print out the ref names of any commits that are shown. If 'short' is
|
|
specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
|
|
'refs/remotes/' will not be printed. If 'full' is specified, the
|
|
full ref name (including prefix) will be printed. The default option
|
|
is 'short'.
|
|
|
|
--source::
|
|
Print out the ref name given on the command line by which each
|
|
commit was reached.
|
|
|
|
--full-diff::
|
|
Without this flag, "git log -p <path>..." shows commits that
|
|
touch the specified paths, and diffs about the same specified
|
|
paths. With this, the full diff is shown for commits that touch
|
|
the specified paths; this means that "<path>..." limits only
|
|
commits, and doesn't limit diff for those commits.
|
|
+
|
|
Note that this affects all diff-based output types, e.g. those
|
|
produced by --stat etc.
|
|
|
|
--log-size::
|
|
Before the log message print out its size in bytes. Intended
|
|
mainly for porcelain tools consumption. If git is unable to
|
|
produce a valid value size is set to zero.
|
|
Note that only message is considered, if also a diff is shown
|
|
its size is not included.
|
|
|
|
[\--] <path>...::
|
|
Show only commits that are enough to explain how the files
|
|
that match the specified paths came to be. See "History
|
|
Simplification" below for details and other simplification
|
|
modes.
|
|
+
|
|
To prevent confusion with options and branch names, paths may need to
|
|
be prefixed with "\-- " to separate them from options or refnames.
|
|
|
|
include::rev-list-options.txt[]
|
|
|
|
include::pretty-formats.txt[]
|
|
|
|
Common diff options
|
|
-------------------
|
|
|
|
:git-log: 1
|
|
include::diff-options.txt[]
|
|
|
|
include::diff-generate-patch.txt[]
|
|
|
|
Examples
|
|
--------
|
|
`git log --no-merges`::
|
|
|
|
Show the whole commit history, but skip any merges
|
|
|
|
`git log v2.6.12.. include/scsi drivers/scsi`::
|
|
|
|
Show all commits since version 'v2.6.12' that changed any file
|
|
in the include/scsi or drivers/scsi subdirectories
|
|
|
|
`git log --since="2 weeks ago" -- gitk`::
|
|
|
|
Show the changes during the last two weeks to the file 'gitk'.
|
|
The "--" is necessary to avoid confusion with the *branch* named
|
|
'gitk'
|
|
|
|
`git log --name-status release..test`::
|
|
|
|
Show the commits that are in the "test" branch but not yet
|
|
in the "release" branch, along with the list of paths
|
|
each commit modifies.
|
|
|
|
`git log --follow builtin-rev-list.c`::
|
|
|
|
Shows the commits that changed builtin-rev-list.c, including
|
|
those commits that occurred before the file was given its
|
|
present name.
|
|
|
|
`git log --branches --not --remotes=origin`::
|
|
|
|
Shows all commits that are in any of local branches but not in
|
|
any of remote-tracking branches for 'origin' (what you have that
|
|
origin doesn't).
|
|
|
|
`git log master --not --remotes=*/master`::
|
|
|
|
Shows all commits that are in local master but not in any remote
|
|
repository master branches.
|
|
|
|
`git log -p -m --first-parent`::
|
|
|
|
Shows the history including change diffs, but only from the
|
|
"main branch" perspective, skipping commits that come from merged
|
|
branches, and showing full diffs of changes introduced by the merges.
|
|
This makes sense only when following a strict policy of merging all
|
|
topic branches when staying on a single integration branch.
|
|
|
|
|
|
Discussion
|
|
----------
|
|
|
|
include::i18n.txt[]
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
|
|
for settings related to diff generation.
|
|
|
|
format.pretty::
|
|
Default for the `--format` option. (See "PRETTY FORMATS" above.)
|
|
Defaults to "medium".
|
|
|
|
i18n.logOutputEncoding::
|
|
Encoding to use when displaying logs. (See "Discussion", above.)
|
|
Defaults to the value of `i18n.commitEncoding` if set, UTF-8
|
|
otherwise.
|
|
|
|
log.date::
|
|
Default format for human-readable dates. (Compare the
|
|
`--date` option.) Defaults to "default", which means to write
|
|
dates like `Sat May 8 19:35:34 2010 -0500`.
|
|
|
|
log.showroot::
|
|
If `false`, 'git log' and related commands will not treat the
|
|
initial commit as a big creation event. Any root commits in
|
|
`git log -p` output would be shown without a diff attached.
|
|
The default is `true`.
|
|
|
|
mailmap.file::
|
|
See linkgit:git-shortlog[1].
|
|
|
|
notes.displayRef::
|
|
Which refs, in addition to the default set by `core.notesRef`
|
|
or 'GIT_NOTES_REF', to read notes from when showing commit
|
|
messages with the 'log' family of commands. See
|
|
linkgit:git-notes[1].
|
|
+
|
|
May be an unabbreviated ref name or a glob and may be specified
|
|
multiple times. A warning will be issued for refs that do not exist,
|
|
but a glob that does not match any refs is silently ignored.
|
|
+
|
|
This setting can be disabled by the `--no-notes` option,
|
|
overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
|
|
and overridden by the `--notes=<ref>` option.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|