From: Brandon Casey Date: Tue, 19 Feb 2013 18:29:30 GMT Subject: [PATCH v2 4/4] Documentation/git-commit.txt: rework the --cleanup section Message-ID: <1361298570-19738-1-git-send-email-bcasey@nvidia.com> In-Reply-To: <7va9r06we2.fsf@alter.siamese.dyndns.org> From: Brandon Casey Signed-off-by: Brandon Casey --- [RESEND] I originally specified Junio's address as gitster@pobox.org. [RESEND] Sorry, now with the correct address. 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=:: - This option sets how the commit message is cleaned up. - The '' 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 '' 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