Skip to content

Commit b20cc13

Browse files
jrstjohngitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c20e6fb commit b20cc13

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

Documentation/git-log.txt

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ DESCRIPTION
1515
-----------
1616
Shows the commit logs.
1717

18-
The command takes options applicable to the 'git rev-list'
18+
The command takes options applicable to the `git rev-list`
1919
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
2121
each commit introduces are shown.
2222

2323

@@ -42,28 +42,27 @@ OPTIONS
4242

4343
--use-mailmap::
4444
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
4646
linkgit:git-shortlog[1].
4747

4848
--full-diff::
49-
Without this flag, "git log -p <path>..." shows commits that
49+
Without this flag, `git log -p <path>...` shows commits that
5050
touch the specified paths, and diffs about the same specified
5151
paths. With this, the full diff is shown for commits that touch
5252
the specified paths; this means that "<path>..." limits only
5353
commits, and doesn't limit diff for those commits.
5454
+
5555
Note that this affects all diff-based output types, e.g. those
56-
produced by --stat etc.
56+
produced by `--stat`, etc.
5757

5858
--log-size::
59-
6059
Include a line ``log size <number>'' in the output for each commit,
6160
where <number> is the length of that commit's message in bytes.
6261
Intended to speed up tools that read log messages from `git log`
6362
output by allowing them to allocate space in advance.
6463

65-
-L <start>,<end>:<file>, -L :<regex>:<file>::
66-
64+
-L <start>,<end>:<file>::
65+
-L :<regex>:<file>::
6766
Trace the evolution of the line range given by "<start>,<end>"
6867
(or the funcname regex <regex>) within the <file>. You may
6968
not give any pathspec limiters. This is currently limited to
@@ -81,16 +80,16 @@ include::line-range-format.txt[]
8180
whole history leading to the current commit). `origin..HEAD`
8281
specifies all the commits reachable from the current commit
8382
(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'
8584
section of linkgit:gitrevisions[7].
8685

8786
[\--] <path>...::
8887
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
9190
modes.
9291
+
93-
Paths may need to be prefixed with "\-- " to separate them from
92+
Paths may need to be prefixed with ``\-- '' to separate them from
9493
options or the revision range, when confusion arises.
9594

9695
include::rev-list-options.txt[]
@@ -114,12 +113,12 @@ EXAMPLES
114113
`git log v2.6.12.. include/scsi drivers/scsi`::
115114

116115
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
118117

119118
`git log --since="2 weeks ago" -- gitk`::
120119

121120
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
123122
'gitk'
124123

125124
`git log --name-status release..test`::
@@ -130,7 +129,7 @@ EXAMPLES
130129

131130
`git log --follow builtin/rev-list.c`::
132131

133-
Shows the commits that changed builtin/rev-list.c, including
132+
Shows the commits that changed `builtin/rev-list.c`, including
134133
those commits that occurred before the file was given its
135134
present name.
136135

@@ -148,17 +147,18 @@ EXAMPLES
148147
`git log -p -m --first-parent`::
149148

150149
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
152151
branches, and showing full diffs of changes introduced by the merges.
153152
This makes sense only when following a strict policy of merging all
154153
topic branches when staying on a single integration branch.
155154

156155
`git log -L '/int main/',/^}/:main.c`::
157156

158-
Shows how the function `main()` in the file 'main.c' evolved
157+
Shows how the function `main()` in the file `main.c` evolved
159158
over time.
160159

161160
`git log -3`::
161+
162162
Limits the number of commits to show to 3.
163163

164164
DISCUSSION
@@ -173,12 +173,12 @@ See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
173173
for settings related to diff generation.
174174

175175
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`.
178178

179179
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
182182
otherwise.
183183

184184
log.date::
@@ -187,7 +187,7 @@ log.date::
187187
dates like `Sat May 8 19:35:34 2010 -0500`.
188188

189189
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
191191
initial commit as a big creation event. Any root commits in
192192
`git log -p` output would be shown without a diff attached.
193193
The default is `true`.
@@ -198,7 +198,7 @@ mailmap.*::
198198
notes.displayRef::
199199
Which refs, in addition to the default set by `core.notesRef`
200200
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
202202
linkgit:git-notes[1].
203203
+
204204
May be an unabbreviated ref name or a glob and may be specified

0 commit comments

Comments
 (0)