[PATCH 1/2] Rewrite man page explanation of git log's "--log-size" option

From

Jason St. John <jstjohn@purdue.edu>

Date

Nov 13, 2013, 06:21 UTC

Message-ID

<1384323709-2690-1-git-send-email-jstjohn@purdue.edu>

Thanks-to: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Jason St. John <jstjohn@purdue.edu>
---
This is effectively a resubmit of my previous patch here:
http://marc.info/?l=git&m=138395803808196&w=2

 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
--- 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::
-	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>::

-- 
1.8.4.2