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 <jrnieder@gmail.com> 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
c20e6fb1df0b9049377b0050599d320dd3822150
1 file changed
+5
-5
Documentation/git-log.txt
+5
-5
@@ -56,11 +56,11 @@ Note that this affects all diff-based output types, e.g. those
56
produced by --stat etc.
57
58
--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.
64
65
-L <start>,<end>:<file>, -L :<regex>:<file>::
66