git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Brandon Casey <bcasey@nvidia.com>
Cc: gitster@pobox.com, git@vger.kernel.org, ralf.thielow@gmail.com,
	Brandon Casey <drafnel@gmail.com>
Subject: [PATCH] fixup! Documentation/git-commit.txt: rework the --cleanup section
Date: Tue, 19 Feb 2013 12:28:23 -0800	[thread overview]
Message-ID: <20130219202822.GA13460@google.com> (raw)
In-Reply-To: <1361298570-19738-1-git-send-email-bcasey@nvidia.com>

Hi,

Brandon Casey wrote:

> Signed-off-by: Brandon Casey <drafnel@gmail.com>

This renders as

	--cleanup=<mode>
	    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' config
		variable (see linkgit:git-config[1]).

Problems:

 * There's a weird extra blank line after "default"
 * Wrong indentation for the final paragraph.
 * The linkgit isn't resolved for some reason.

The following fixes it for me.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-commit.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 992c219..24a99cc 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -185,11 +185,12 @@ whitespace::
 verbatim::
 	Do not change the message at all.
 default::
-	`strip` if the message is to be edited.  Otherwise `whitespace`.
+	Same as `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]).
+The default can be changed by the 'commit.cleanup' configuration
+variable (see linkgit:git-config[1]).
 
 -e::
 --edit::
-- 
1.8.1.3

  reply	other threads:[~2013-02-19 20:28 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           ` [PATCH v2 4/4] Documentation/git-commit.txt: rework the --cleanup section Brandon Casey
2013-02-19 18:28           ` Brandon Casey
2013-02-19 18:29           ` Brandon Casey
2013-02-19 20:28             ` Jonathan Nieder [this message]
2013-02-19 20:33               ` [PATCH] fixup! " 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=20130219202822.GA13460@google.com \
    --to=jrnieder@gmail.com \
    --cc=bcasey@nvidia.com \
    --cc=drafnel@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).