Skip to content

Commit c20e6fb

Browse files
jrstjohngitster
authored andcommitted
Documentation/git-log: update "--log-size" description
"--log-size" was added in commit 9fa3465, and the commit message contained a satisfactory explanation; however, the man page entry for it did not describe the actual output format, what the output meant and what the option was meant to be used for. Helped-by: Jonathan Nieder <[email protected]> Signed-off-by: Jason St. John <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d7d2c87 commit c20e6fb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/git-log.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Note that this affects all diff-based output types, e.g. those
5656
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+
60+
Include a line ``log size <number>'' in the output for each commit,
61+
where <number> is the length of that commit's message in bytes.
62+
Intended to speed up tools that read log messages from `git log`
63+
output by allowing them to allocate space in advance.
6464

6565
-L <start>,<end>:<file>, -L :<regex>:<file>::
6666

0 commit comments

Comments
 (0)