From: Brandon Casey <bcasey@nvidia.com>
To: <gitster@pobox.org>
Cc: <git@vger.kernel.org>, <jrnieder@gmail.com>,
<ralf.thielow@gmail.com>, Brandon Casey <drafnel@gmail.com>
Subject: [PATCH v2 4/4] Documentation/git-commit.txt: rework the --cleanup section
Date: Tue, 19 Feb 2013 10:14:13 -0800 [thread overview]
Message-ID: <1361297653-1315-1-git-send-email-bcasey@nvidia.com> (raw)
In-Reply-To: <7va9r06we2.fsf@alter.siamese.dyndns.org>
From: Brandon Casey <drafnel@gmail.com>
Signed-off-by: Brandon Casey <drafnel@gmail.com>
---
Ok, here's the updated text. I am not set up to build the documentation,
so I hope someone will test, but looks right to me.
-Brandon
Documentation/git-commit.txt | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 0eb79cc..992c219 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -172,16 +172,24 @@ OPTIONS
linkgit:git-commit-tree[1].
--cleanup=<mode>::
- This option sets how the commit message is cleaned up.
- The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
- and 'default'. The 'default' mode will strip leading and
- trailing empty lines and #commentary from the commit message
- only if the message is to be edited. Otherwise only whitespace
- removed. The 'verbatim' mode does not change message at all,
- 'whitespace' removes just leading/trailing whitespace lines
- and 'strip' removes both whitespace and commentary. The default
- can be changed by the 'commit.cleanup' configuration variable
- (see linkgit:git-config[1]).
+ This option determines how the supplied commit message should be
+ cleaned up before committing. The '<mode>' can be `strip`,
+ `whitespace`, `verbatim`, or `default`.
++
+--
+strip::
+ Strip leading and trailing empty lines, trailing whitespace, and
+ #commentary and collapse consecutive empty lines.
+whitespace::
+ Same as `strip` except #commentary is not removed.
+verbatim::
+ Do not change the message at all.
+default::
+ `strip` if the message is to be edited. Otherwise `whitespace`.
+--
++
+ The default can be changed by the 'commit.cleanup' configuration
+ variable (see linkgit:git-config[1]).
-e::
--edit::
--
1.8.1.3.566.gaa39828
next prev parent reply other threads:[~2013-02-19 18:14 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-19 4:17 [PATCH 1/4] t/t7502: compare entire commit message with what was expected Brandon Casey
2013-02-19 4:17 ` [PATCH 2/4] t7502: demonstrate breakage with a commit message with trailing newlines Brandon Casey
2013-02-19 5:39 ` Jonathan Nieder
2013-02-19 4:17 ` [PATCH 3/4] git-commit: only append a newline to -m mesg if necessary Brandon Casey
2013-02-19 6:31 ` Jonathan Nieder
2013-02-19 4:17 ` [PATCH 4/4] Documentation/git-commit.txt: correct a few minor grammatical mistakes Brandon Casey
2013-02-19 6:43 ` Jonathan Nieder
2013-02-19 7:18 ` Brandon Casey
2013-02-19 7:29 ` Jonathan Nieder
2013-02-19 17:33 ` Junio C Hamano
2013-02-19 18:14 ` Brandon Casey [this message]
2013-02-19 18:28 ` [PATCH v2 4/4] Documentation/git-commit.txt: rework the --cleanup section Brandon Casey
2013-02-19 18:29 ` Brandon Casey
2013-02-19 20:28 ` [PATCH] fixup! " Jonathan Nieder
2013-02-19 20:33 ` Brandon Casey
2013-02-19 20:35 ` [PATCH v2 4/4] " Junio C Hamano
2013-02-19 5:08 ` [PATCH 1/4] t/t7502: compare entire commit message with what was expected Jonathan Nieder
2013-02-19 5:10 ` Jonathan Nieder
2013-02-19 17:24 ` Junio C Hamano
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=1361297653-1315-1-git-send-email-bcasey@nvidia.com \
--to=bcasey@nvidia.com \
--cc=drafnel@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.org \
--cc=jrnieder@gmail.com \
--cc=ralf.thielow@gmail.com \
/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).