Merge branch 'ar/commit-cleanup'

* ar/commit-cleanup:
Allow selection of different cleanup modes for commit messages
builtin-commit: avoid double-negation in the code.
builtin-commit: fix amending of the initial commit
t7005: do not exit inside test.

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 4261384158f53ebe85dc32148b5652dc697e5b3b..96383b6543c781090bc2d4d7cf215c645b08714b 100644 (file)
--- 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

diff --git a/builtin-commit.c b/builtin-commit.c
index 96410de55ddbc52eb116049b4f6a2792a5386cb4..73f1e3576a019d33ee7034d46a4fe4a2d7ab3f7b 100644 (file)
--- a/builtin-commit.c
+++ b/builtin-commit.c
@@ -47,8 +47,21 @@ 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;
+/*
+ * The default commit message cleanup mode will remove the lines
+ * beginning with # (shell comments) and leading and trailing
+ * whitespaces (empty lines or containing only whitespaces)
+ * if editor is used, and only the whitespaces if the message
+ * is specified explicitly.
+ */
+static enum {
+       CLEANUP_SPACE,
+       CLEANUP_NONE,
+       CLEANUP_ALL,
+} cleanup_mode;
+static char *cleanup_arg;
 
-static int no_edit, initial_commit, in_merge;
+static int use_editor = 1, initial_commit, in_merge;
 const char *only_include_assumed;
 struct strbuf message;
 
@@ -88,6 +101,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_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
 
        OPT_END()
 };
@@ -346,7 +360,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 (cleanup_mode != CLEANUP_NONE)
+               stripspace(&sb, 0);
 
        if (signoff) {
                struct strbuf sob;
@@ -372,9 +387,9 @@ static int prepare_log_message(const char *index_file, const char *prefix)
 
        strbuf_release(&sb);
 
-       if (no_edit) {
+       if (!use_editor) {
                struct rev_info rev;
-               unsigned char sha1[40];
+               unsigned char sha1[20];
                const char *parent = "HEAD";
 
                fclose(fp);
@@ -382,12 +397,12 @@ static int prepare_log_message(const char *index_file, const char *prefix)
                if (!active_nr && read_cache() < 0)
                        die("Cannot read index");
 
-               if (get_sha1("HEAD", sha1) != 0)
-                       return !!active_nr;
-
                if (amend)
                        parent = "HEAD^1";
 
+               if (get_sha1(parent, sha1))
+                       return !!active_nr;
+
                init_revisions(&rev, "");
                rev.abbrev = 0;
                setup_revisions(0, NULL, &rev, parent);
@@ -398,7 +413,7 @@ static int prepare_log_message(const char *index_file, const char *prefix)
                return !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
        }
 
-       if (in_merge && !no_edit)
+       if (in_merge)
                fprintf(fp,
                        "#\n"
                        "# It looks like you may be committing a MERGE.\n"
@@ -411,7 +426,12 @@ static int prepare_log_message(const char *index_file, const char *prefix)
        fprintf(fp,
                "\n"
                "# Please enter the commit message for your changes.\n"
-               "# (Comment lines starting with '#' will not be included)\n");
+               "# (Comment lines starting with '#' will ");
+       if (cleanup_mode == CLEANUP_ALL)
+               fprintf(fp, "not be included)\n");
+       else /* CLEANUP_SPACE, that is. */
+               fprintf(fp, "be kept.\n"
+                       "# You can remove them yourself if you want to)\n");
        if (only_include_assumed)
                fprintf(fp, "# %s\n", only_include_assumed);
 
@@ -435,10 +455,13 @@ static int message_is_empty(struct strbuf *sb, int start)
        const char *nl;
        int eol, i;
 
+       if (cleanup_mode == CLEANUP_NONE && sb->len)
+               return 0;
+
        /* See if the template is just a prefix of the message. */
        strbuf_init(&tmpl, 0);
        if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
-               stripspace(&tmpl, 1);
+               stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
                if (start + tmpl.len <= sb->len &&
                    memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
                        start += tmpl.len;
@@ -513,9 +536,9 @@ static int parse_and_validate_options(int argc, const char *argv[],
        argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
 
        if (logfile || message.len || use_message)
-               no_edit = 1;
+               use_editor = 0;
        if (edit_flag)
-               no_edit = 0;
+               use_editor = 1;
 
        if (get_sha1("HEAD", head_sha1))
                initial_commit = 1;
@@ -591,6 +614,16 @@ static int parse_and_validate_options(int argc, const char *argv[],
                only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
                also = 0;
        }
+       if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
+               cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
+       else if (!strcmp(cleanup_arg, "verbatim"))
+               cleanup_mode = CLEANUP_NONE;
+       else if (!strcmp(cleanup_arg, "whitespace"))
+               cleanup_mode = CLEANUP_SPACE;
+       else if (!strcmp(cleanup_arg, "strip"))
+               cleanup_mode = CLEANUP_ALL;
+       else
+               die("Invalid cleanup mode %s", cleanup_arg);
 
        if (all && argc > 0)
                die("Paths with -a does not make sense.");
@@ -796,7 +829,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
 
        /* Get the commit message and validate it */
        header_len = sb.len;
-       if (!no_edit) {
+       if (use_editor) {
                char index[PATH_MAX];
                const char *env[2] = { index, NULL };
                snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
@@ -817,7 +850,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 (cleanup_mode != CLEANUP_NONE)
+               stripspace(&sb, cleanup_mode == CLEANUP_ALL);
        if (sb.len < header_len || message_is_empty(&sb, header_len)) {
                rollback_index_files();
                die("no commit message?  aborting commit.");

diff --git a/t/t7005-editor.sh b/t/t7005-editor.sh
index 44228b5ac12f5df9d6def93dc74e3687ba2d8e73..c1cec553060a2fd6a4d27191a866b3bf53ba3335 100755 (executable)
--- a/t/t7005-editor.sh
+++ b/t/t7005-editor.sh
@@ -37,7 +37,7 @@ test_expect_success 'dumb should error out when falling back on vi' '
        if git commit --amend
        then
                echo "Oops?"
-               exit 1
+               false
        else
                : happy
        fi

diff --git a/t/t7502-commit.sh b/t/t7502-commit.sh
index 21ac785e3d61aa94bae22db488fae893f315ba0b..aaf497e6a5948ffa393ea07380bf577ceb5f347b 100755 (executable)
--- a/t/t7502-commit.sh
+++ b/t/t7502-commit.sh
@@ -89,4 +89,69 @@ test_expect_success 'verbose' '
 
 '
 
+test_expect_success 'cleanup commit messages (verbatim,-t)' '
+
+       echo >>negative &&
+       { echo;echo "# text";echo; } >expect &&
+       git commit --cleanup=verbatim -t expect -a &&
+       git cat-file -p HEAD |sed -e "1,/^\$/d" |head -n 3 >actual &&
+       diff -u expect actual
+
+'
+
+test_expect_success 'cleanup commit messages (verbatim,-F)' '
+
+       echo >>negative &&
+       git commit --cleanup=verbatim -F expect -a &&
+       git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
+       diff -u expect actual
+
+'
+
+test_expect_success 'cleanup commit messages (verbatim,-m)' '
+
+       echo >>negative &&
+       git commit --cleanup=verbatim -m "$(cat expect)" -a &&
+       git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
+       diff -u expect actual
+
+'
+
+test_expect_success 'cleanup commit messages (whitespace,-F)' '
+
+       echo >>negative &&
+       { echo;echo "# text";echo; } >text &&
+       echo "# text" >expect &&
+       git commit --cleanup=whitespace -F text -a &&
+       git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
+       diff -u expect actual
+
+'
+
+test_expect_success 'cleanup commit messages (strip,-F)' '
+
+       echo >>negative &&
+       { echo;echo "# text";echo sample;echo; } >text &&
+       echo sample >expect &&
+       git commit --cleanup=strip -F text -a &&
+       git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
+       diff -u expect actual
+
+'
+
+echo "sample
+
+# Please enter the commit message for your changes.
+# (Comment lines starting with '#' will not be included)" >expect
+
+test_expect_success 'cleanup commit messages (strip,-F,-e)' '
+
+       echo >>negative &&
+       { echo;echo sample;echo; } >text &&
+       git commit -e -F text -a &&
+       head -n 4 .git/COMMIT_EDITMSG >actual &&
+       diff -u expect actual
+
+'
+
 test_done