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>

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index ac2694d04cfc73c9b5ae6e6982d2f7f290ed67fe..da1c2c6fd71deabb5b9147a79020e407d73b7368 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -56,11 +56,11 @@ Note that this affects all diff-based output types, e.g. those
 produced by --stat etc.
 
 --log-size::
 produced by --stat etc.
 
 --log-size::

-       Before the log message print out its size in bytes. Intended
-       mainly for porcelain tools consumption. If Git is unable to
-       produce a valid value size is set to zero.
-       Note that only message is considered, if also a diff is shown
-       its size is not included.
+
+       Include a line ``log size <number>'' in the output for each commit,
+       where <number> is the length of that commit's message in bytes.
+       Intended to speed up tools that read log messages from `git log`
+       output by allowing them to allocate space in advance.

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