[PATCH] git-commit: add --verbatim to allow unstripped commit messages
- From
Alex Riesen <raa.lkml@gmail.com>
- Date
- Dec 20, 2007, 21:18 UTC
- Message-ID
- <20071220211835.GA3052@steel.home>
It also implies --allow-empty.
Sometimes the message just have to be the way user wants it. For instance, a template can contain "#" characters, or the message must be kept as close to its original source as possible for reimport reasons. Or maybe the user just copied a shell script including its comments into the commit message for future reference.
Signed-off-by: Alex Riesen <raa.lkml@gmail.com> ---
I just happen to have a corporate template (for perforce messages, I reuse it my git mirror repo) which contains "#" and at least one time lost my bash comments in a commit.
Documentation/git-commit.txt | 7 ++++++- builtin-commit.c | 10 ++++++++-- t/t7502-commit.sh | 17 +++++++++++++++++ 3 files changed, 31 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 4261384..862543f 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>...] + [--verbatim] [--] [[-i | -o ]<file>...] DESCRIPTION ----------- @@ -95,6 +95,11 @@ OPTIONS from making such a commit. This option bypasses the safety, and is primarily for use by foreign scm interface scripts. +--verbatim:: + Inhibits stripping of leading and trailing spaces, + empty lines and #commentary from the commit message. + Implies --allow-empty. + -e|--edit:: The message taken from file with `-F`, command line with `-m`, and from file with `-C` are usually used as the diff --git a/builtin-commit.c b/builtin-commit.c index 0a91013..cc77ba9 100644 --- a/builtin-commit.c +++ b/builtin-commit.c @@ -47,6 +47,7 @@ static char *logfile, *force_author, *template_file; static char *edit_message, *use_message; static int all, edit_flag, also, interactive, only, amend, signoff; static int quiet, verbose, untracked_files, no_verify, allow_empty; +static int verbatim_message; static int no_edit, initial_commit, in_merge; const char *only_include_assumed; @@ -88,6 +89,7 @@ static struct option builtin_commit_options[] = { OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"), OPT_BOOLEAN(0, "untracked-files", &untracked_files, "show all untracked files"), OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"), + OPT_BOOLEAN(0, "verbatim", &verbatim_message, "do not strip spaces and #comments from message"), OPT_END() }; @@ -346,7 +348,8 @@ static int prepare_log_message(const char *index_file, const char *prefix) if (fp == NULL) die("could not open %s", git_path(commit_editmsg)); - stripspace(&sb, 0); + if (!verbatim_message) + stripspace(&sb, 0); if (signoff) { struct strbuf sob; @@ -512,6 +515,8 @@ static int parse_and_validate_options(int argc, const char *argv[], no_edit = 1; if (edit_flag) no_edit = 0; + if (verbatim_message) + allow_empty = 1; if (get_sha1("HEAD", head_sha1)) initial_commit = 1; @@ -813,7 +818,8 @@ int cmd_commit(int argc, const char **argv, const char *prefix) if (p != NULL) strbuf_setlen(&sb, p - sb.buf + 1); - stripspace(&sb, 1); + if (!verbatim_message) + stripspace(&sb, 1); if (sb.len < header_len || message_is_empty(&sb, header_len)) { rollback_index_files(); die("no commit message? aborting commit."); diff --git a/t/t7502-commit.sh b/t/t7502-commit.sh index 21ac785..42f98bc 100755 --- a/t/t7502-commit.sh +++ b/t/t7502-commit.sh @@ -89,4 +89,21 @@ test_expect_success 'verbose' ' ' +test_expect_success 'verbatim commit messages' ' + + echo >>negative && + git add negative && + { echo;echo "# text";echo; } >expect && + git commit --verbatim -t expect -a && + git cat-file -p HEAD |sed -e "1,/^\$/d" |head -n 3 >actual && + diff -u expect actual && + git commit --verbatim -F expect -a && + git cat-file -p HEAD |sed -e "1,/^\$/d">actual && + diff -u expect actual && + git commit --verbatim -m "$(cat expect)" -a && + git cat-file -p HEAD |sed -e "1,/^\$/d">actual && + diff -u expect actual + +' + test_done
-- 1.5.4.rc1.33.gbd32b