summaryrefslogtreecommitdiff
path: root/Documentation/git-log.txt
diff options
context:
space:
mode:
authorJason St. John <jstjohn@purdue.edu>2013-11-13 01:21:48 -0500
committerJunio C Hamano <gitster@pobox.com>2013-11-13 14:06:17 -0800
commitc20e6fb1df0b9049377b0050599d320dd3822150 (patch)
tree40c03fcd1d4587f97b25507c242cf8a0f35fcb57 /Documentation/git-log.txt
parentd7d2c87955f7700289c5b516f12579a5be4b879d (diff)
downloadgit-c20e6fb1df0b9049377b0050599d320dd3822150.tar.gz
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>
Diffstat (limited to 'Documentation/git-log.txt')
-rw-r--r--Documentation/git-log.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index ac2694d04c..da1c2c6fd7 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>::