Documentation/git-log.txt: mark-up fix and minor rephasing
- typeset options, commands, and paths in monospace; - typeset references to sections with emphasis; - replace some double quotes with proper AsciiDoc quotes (e.g. ``foo''); - use title case when referring to section headings. Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jason St. John committed
Nov 13, 2013 at 01:21 UTC
b20cc13e73fcec3d80eed4d9fc7f6ee8acc206ac
1 file changed
+23
-23
Documentation/git-log.txt
+23
-23
@@ -15,9 +15,9 @@ DESCRIPTION
15
-----------
16
Shows the commit logs.
17
18
-The command takes options applicable to the 'git rev-list'
18
+The command takes options applicable to the `git rev-list`
19
command to control what is shown and how, and options applicable to
20
-the 'git diff-*' commands to control how the changes
20
+the `git diff-*` commands to control how the changes
21
each commit introduces are shown.
22
23
@@ -42,28 +42,27 @@ OPTIONS
42
43
--use-mailmap::
44
Use mailmap file to map author and committer names and email
45
- to canonical real names and email addresses. See
45
+ addresses to canonical real names and email addresses. See
46
linkgit:git-shortlog[1].
47
48
--full-diff::
49
- Without this flag, "git log -p <path>..." shows commits that
49
+ Without this flag, `git log -p <path>...` shows commits that
50
touch the specified paths, and diffs about the same specified
51
paths. With this, the full diff is shown for commits that touch
52
the specified paths; this means that "<path>..." limits only
53
commits, and doesn't limit diff for those commits.
54
+
55
Note that this affects all diff-based output types, e.g. those
56
-produced by --stat etc.
56
+produced by `--stat`, etc.
57
58
--log-size::
59
-
59
Include a line ``log size <number>'' in the output for each commit,
60
where <number> is the length of that commit's message in bytes.
61
Intended to speed up tools that read log messages from `git log`
62
output by allowing them to allocate space in advance.
63
65
--L <start>,<end>:<file>, -L :<regex>:<file>::
66
-
64
+-L <start>,<end>:<file>::
65
+-L :<regex>:<file>::
66
Trace the evolution of the line range given by "<start>,<end>"
67
(or the funcname regex <regex>) within the <file>. You may
68
not give any pathspec limiters. This is currently limited to
@@ -81,16 +80,16 @@ include::line-range-format.txt[]
80
whole history leading to the current commit). `origin..HEAD`
81
specifies all the commits reachable from the current commit
82
(i.e. `HEAD`), but not from `origin`. For a complete list of
84
- ways to spell <revision range>, see the "Specifying Ranges"
83
+ ways to spell <revision range>, see the 'Specifying Ranges'
84
section of linkgit:gitrevisions[7].
85
86
[\--] <path>...::
87
Show only commits that are enough to explain how the files
89
- that match the specified paths came to be. See "History
90
- Simplification" below for details and other simplification
88
+ that match the specified paths came to be. See 'History
89
+ Simplification' below for details and other simplification
90
modes.
91
+
93
-Paths may need to be prefixed with "\-- " to separate them from
92
+Paths may need to be prefixed with ``\-- '' to separate them from
93
options or the revision range, when confusion arises.
94
95
include::rev-list-options.txt[]
@@ -114,12 +113,12 @@ EXAMPLES
113
`git log v2.6.12.. include/scsi drivers/scsi`::
114
115
Show all commits since version 'v2.6.12' that changed any file
117
- in the include/scsi or drivers/scsi subdirectories
116
+ in the `include/scsi` or `drivers/scsi` subdirectories
117
118
`git log --since="2 weeks ago" -- gitk`::
119
120
Show the changes during the last two weeks to the file 'gitk'.
122
- The "--" is necessary to avoid confusion with the *branch* named
121
+ The ``--'' is necessary to avoid confusion with the *branch* named
122
'gitk'
123
124
`git log --name-status release..test`::
@@ -130,7 +129,7 @@ EXAMPLES
129
130
`git log --follow builtin/rev-list.c`::
131
133
- Shows the commits that changed builtin/rev-list.c, including
132
+ Shows the commits that changed `builtin/rev-list.c`, including
133
those commits that occurred before the file was given its
134
present name.
135
@@ -148,17 +147,18 @@ EXAMPLES
147
`git log -p -m --first-parent`::
148
149
Shows the history including change diffs, but only from the
151
- "main branch" perspective, skipping commits that come from merged
150
+ ``main branch'' perspective, skipping commits that come from merged
151
branches, and showing full diffs of changes introduced by the merges.
152
This makes sense only when following a strict policy of merging all
153
topic branches when staying on a single integration branch.
154
155
`git log -L '/int main/',/^}/:main.c`::
156
158
- Shows how the function `main()` in the file 'main.c' evolved
157
+ Shows how the function `main()` in the file `main.c` evolved
158
over time.
159
160
`git log -3`::
161
+
162
Limits the number of commits to show to 3.
163
164
DISCUSSION
@@ -173,12 +173,12 @@ See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
173
for settings related to diff generation.
174
175
format.pretty::
176
- Default for the `--format` option. (See "PRETTY FORMATS" above.)
177
- Defaults to "medium".
176
+ Default for the `--format` option. (See 'Pretty Formats' above.)
177
+ Defaults to `medium`.
178
179
i18n.logOutputEncoding::
180
- Encoding to use when displaying logs. (See "Discussion", above.)
181
- Defaults to the value of `i18n.commitEncoding` if set, UTF-8
180
+ Encoding to use when displaying logs. (See 'Discussion' above.)
181
+ Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
182
otherwise.
183
184
log.date::
@@ -187,7 +187,7 @@ log.date::
187
dates like `Sat May 8 19:35:34 2010 -0500`.
188
189
log.showroot::
190
- If `false`, 'git log' and related commands will not treat the
190
+ If `false`, `git log` and related commands will not treat the
191
initial commit as a big creation event. Any root commits in
192
`git log -p` output would be shown without a diff attached.
193
The default is `true`.
@@ -198,7 +198,7 @@ mailmap.*::
198
notes.displayRef::
199
Which refs, in addition to the default set by `core.notesRef`
200
or 'GIT_NOTES_REF', to read notes from when showing commit
201
- messages with the 'log' family of commands. See
201
+ messages with the `log` family of commands. See
202
linkgit:git-notes[1].
203
+
204
May be an unabbreviated ref name or a glob and may be specified