[PATCH] fixup! Documentation/git-commit.txt: rework the --cleanup section
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Feb 19, 2013, 20:28 UTC
- Message-ID
- <20130219202822.GA13460@google.com>
- 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