From: "Jason St. John" <jstjohn@purdue.edu>
To: git@vger.kernel.org
Cc: "Jason St. John" <jstjohn@purdue.edu>
Subject: [PATCH 1/2] Rewrite man page explanation of git log's "--log-size" option
Date: Wed, 13 Nov 2013 01:21:48 -0500 [thread overview]
Message-ID: <1384323709-2690-1-git-send-email-jstjohn@purdue.edu> (raw)
Documentation/git-log.txt:
--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 <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
Thanks to Jonathan Nieder for writing the text used in this commit:
http://marc.info/?l=git&m=138395887208373&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
next reply other threads:[~2013-11-13 6:22 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-13 6:21 Jason St. John [this message]
2013-11-13 6:21 ` [PATCH 2/2] Fix minor grammatical and other formatting issues in the "git log" man page Jason St. John
2013-11-13 21:56 ` Junio C Hamano
2013-11-15 1:44 ` Jason St. John
2013-11-15 1:47 ` Jason St. John
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1384323709-2690-1-git-send-email-jstjohn@purdue.edu \
--to=jstjohn@purdue.edu \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).