diff options
| author | Alex Riesen <raa.lkml@gmail.com> | 2007-12-22 19:46:24 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2007-12-22 19:55:07 -0800 |
| commit | 5f0657374344a5d8cf5ce5a9920a08c0be422194 (patch) | |
| tree | 388d086fdee6cddd2fbddb200ee96a399cd10ef5 /Documentation | |
| parent | 4803466f62777fe3d0b33c8f999ec392f47a5b09 (diff) | |
| download | git-5f0657374344a5d8cf5ce5a9920a08c0be422194.tar.gz git-5f0657374344a5d8cf5ce5a9920a08c0be422194.tar.xz | |
Allow selection of different cleanup modes for commit messages
Although we traditionally stripped away excess blank lines, trailing
whitespaces and lines that begin with "#" from the commit log message,
sometimes the message just has to be the way user wants it.
For instance, a commit message template can contain lines that begin with
"#", the message must be kept as close to its original source as possible
if you are converting from a foreign SCM, or maybe the message has a shell
script including its comments for future reference.
The cleanup modes are default, verbatim, whitespace and strip. The
default mode depends on if the message is being edited and will either
strip whitespace and comments (if editor active) or just strip the
whitespace (for where the message is given explicitely).
Signed-off-by: Alex Riesen <raa.lkml@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-commit.txt | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 426138415..96383b654 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -11,7 +11,7 @@ SYNOPSIS 'git-commit' [-a | --interactive] [-s] [-v] [-u] [(-c | -C) <commit> | -F <file> | -m <msg> | --amend] [--allow-empty] [--no-verify] [-e] [--author <author>] - [--] [[-i | -o ]<file>...] + [--cleanup=<mode>] [--] [[-i | -o ]<file>...] DESCRIPTION ----------- @@ -95,6 +95,16 @@ OPTIONS from making such a commit. This option bypasses the safety, and is primarily for use by foreign scm interface scripts. +--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. + -e|--edit:: The message taken from file with `-F`, command line with `-m`, and from file with `-C` are usually used as the |