--log-size was added in commit 9fa3465, and the commit message contained
a satisfactory explanation; however, the man page entry for it was
unclear and cryptic.
Thanks-to: Jonathan Nieder <jrnie...@gmail.com>
Signed-off-by: Jason St. John <jstj...@purdue.edu>
This is effectively a resubmit of my previous patch here:
Thanks to Jonathan Nieder for writing the text used in this commit:
Documentation/git-log.txt | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 34097ef..a5de513 100644
@@ -56,11 +56,11 @@ Note that this affects all diff-based output types, e.g.
produced by --stat etc.
- 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.
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html