[PATCH] fixup! Documentation/git-commit.txt: rework the --cleanup section

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

Brandon Casey wrote:

> Signed-off-by: Brandon Casey <drafnel@xxxxxxxxx>

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@xxxxxxxxx>
---
 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

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]