Skip to content

Commit ace08c2

Browse files
committed
Merge branch 'jj/log-doc' into maint
* jj/log-doc: Documentation/git-log.txt: mark-up fix and minor rephasing Documentation/git-log: update "--log-size" description
2 parents 7be001d + b20cc13 commit ace08c2

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

Documentation/git-log.txt

Lines changed: 25 additions & 26 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,29 +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-
Before the log message print out its size in bytes. Intended
60-
mainly for porcelain tools consumption. If Git is unable to
61-
produce a valid value size is set to zero.
62-
Note that only message is considered, if also a diff is shown
63-
its size is not included.
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.
6463

6564
-L <start>,<end>:<file>::
6665
-L :<regex>:<file>::
67-
6866
Trace the evolution of the line range given by "<start>,<end>"
6967
(or the funcname regex <regex>) within the <file>. You may
7068
not give any pathspec limiters. This is currently limited to
@@ -80,16 +78,16 @@ include::line-range-format.txt[]
8078
whole history leading to the current commit). `origin..HEAD`
8179
specifies all the commits reachable from the current commit
8280
(i.e. `HEAD`), but not from `origin`. For a complete list of
83-
ways to spell <revision range>, see the "Specifying Ranges"
81+
ways to spell <revision range>, see the 'Specifying Ranges'
8482
section of linkgit:gitrevisions[7].
8583

8684
[\--] <path>...::
8785
Show only commits that are enough to explain how the files
88-
that match the specified paths came to be. See "History
89-
Simplification" below for details and other simplification
86+
that match the specified paths came to be. See 'History
87+
Simplification' below for details and other simplification
9088
modes.
9189
+
92-
Paths may need to be prefixed with "\-- " to separate them from
90+
Paths may need to be prefixed with ``\-- '' to separate them from
9391
options or the revision range, when confusion arises.
9492

9593
include::rev-list-options.txt[]
@@ -113,12 +111,12 @@ EXAMPLES
113111
`git log v2.6.12.. include/scsi drivers/scsi`::
114112

115113
Show all commits since version 'v2.6.12' that changed any file
116-
in the include/scsi or drivers/scsi subdirectories
114+
in the `include/scsi` or `drivers/scsi` subdirectories
117115

118116
`git log --since="2 weeks ago" -- gitk`::
119117

120118
Show the changes during the last two weeks to the file 'gitk'.
121-
The "--" is necessary to avoid confusion with the *branch* named
119+
The ``--'' is necessary to avoid confusion with the *branch* named
122120
'gitk'
123121

124122
`git log --name-status release..test`::
@@ -129,7 +127,7 @@ EXAMPLES
129127

130128
`git log --follow builtin/rev-list.c`::
131129

132-
Shows the commits that changed builtin/rev-list.c, including
130+
Shows the commits that changed `builtin/rev-list.c`, including
133131
those commits that occurred before the file was given its
134132
present name.
135133

@@ -147,17 +145,18 @@ EXAMPLES
147145
`git log -p -m --first-parent`::
148146

149147
Shows the history including change diffs, but only from the
150-
"main branch" perspective, skipping commits that come from merged
148+
``main branch'' perspective, skipping commits that come from merged
151149
branches, and showing full diffs of changes introduced by the merges.
152150
This makes sense only when following a strict policy of merging all
153151
topic branches when staying on a single integration branch.
154152

155153
`git log -L '/int main/',/^}/:main.c`::
156154

157-
Shows how the function `main()` in the file 'main.c' evolved
155+
Shows how the function `main()` in the file `main.c` evolved
158156
over time.
159157

160158
`git log -3`::
159+
161160
Limits the number of commits to show to 3.
162161

163162
DISCUSSION
@@ -172,12 +171,12 @@ See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
172171
for settings related to diff generation.
173172

174173
format.pretty::
175-
Default for the `--format` option. (See "PRETTY FORMATS" above.)
176-
Defaults to "medium".
174+
Default for the `--format` option. (See 'Pretty Formats' above.)
175+
Defaults to `medium`.
177176

178177
i18n.logOutputEncoding::
179-
Encoding to use when displaying logs. (See "Discussion", above.)
180-
Defaults to the value of `i18n.commitEncoding` if set, UTF-8
178+
Encoding to use when displaying logs. (See 'Discussion' above.)
179+
Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
181180
otherwise.
182181

183182
log.date::
@@ -186,7 +185,7 @@ log.date::
186185
dates like `Sat May 8 19:35:34 2010 -0500`.
187186

188187
log.showroot::
189-
If `false`, 'git log' and related commands will not treat the
188+
If `false`, `git log` and related commands will not treat the
190189
initial commit as a big creation event. Any root commits in
191190
`git log -p` output would be shown without a diff attached.
192191
The default is `true`.
@@ -197,7 +196,7 @@ mailmap.*::
197196
notes.displayRef::
198197
Which refs, in addition to the default set by `core.notesRef`
199198
or 'GIT_NOTES_REF', to read notes from when showing commit
200-
messages with the 'log' family of commands. See
199+
messages with the `log` family of commands. See
201200
linkgit:git-notes[1].
202201
+
203202
May be an unabbreviated ref name or a glob and may be specified

0 commit comments

Comments
 (0)