From: Alex Riesen <raa.lkml@gmail.com>
To: Linus Torvalds <torvalds@linux-foundation.org>
Cc: git@vger.kernel.org
Subject: [PATCH] git-commit: add --verbatim to allow unstripped commit messages
Date: Fri, 21 Dec 2007 00:35:39 +0100 [thread overview]
Message-ID: <20071220233539.GC3052@steel.home> (raw)
In-Reply-To: <20071220233324.GB3052@steel.home>
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>
---
Updated patch. It conflicts with yours a bit. Will update it
Documentation/git-commit.txt | 7 ++++++-
builtin-commit.c | 20 ++++++++++++++------
t/t7502-commit.sh | 18 ++++++++++++++++++
3 files changed, 38 insertions(+), 7 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..3127247 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;
@@ -404,10 +407,11 @@ static int prepare_log_message(const char *index_file, const char *prefix)
"#\n",
git_path("MERGE_HEAD"));
- fprintf(fp,
- "\n"
- "# Please enter the commit message for your changes.\n"
- "# (Comment lines starting with '#' will not be included)\n");
+ if (!verbatim_message)
+ fprintf(fp,
+ "\n"
+ "# Please enter the commit message for your changes.\n"
+ "# (Comment lines starting with '#' will not be included)\n");
if (only_include_assumed)
fprintf(fp, "# %s\n", only_include_assumed);
@@ -431,6 +435,9 @@ static int message_is_empty(struct strbuf *sb, int start)
const char *nl;
int eol, i;
+ if (verbatim_message && sb->len)
+ return 1;
+
/* 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) {
@@ -813,7 +820,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..d549728 100755
--- a/t/t7502-commit.sh
+++ b/t/t7502-commit.sh
@@ -89,4 +89,22 @@ test_expect_success 'verbose' '
'
+test_expect_success 'verbatim commit messages' '
+
+ echo >>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 &&
+ echo >>negative &&
+ git commit --verbatim -F expect -a &&
+ git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
+ diff -u expect actual &&
+ echo >>negative &&
+ 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
next prev parent reply other threads:[~2007-12-20 23:36 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-12-20 21:18 [PATCH] git-commit: add --verbatim to allow unstripped commit messages Alex Riesen
2007-12-20 21:40 ` Linus Torvalds
2007-12-20 23:33 ` Alex Riesen
2007-12-20 23:35 ` Alex Riesen [this message]
2007-12-20 23:37 ` [PATCH] Only filter "#" comments from commits if the editor is used Alex Riesen
2007-12-20 23:39 ` Junio C Hamano
2007-12-20 23:43 ` Alex Riesen
2007-12-20 23:43 ` Junio C Hamano
2007-12-20 23:48 ` [PATCH] Fix thinko in checking for commit message emptiness Alex Riesen
2007-12-20 23:55 ` [PATCH] git-commit: add --verbatim to allow unstripped commit messages Linus Torvalds
2007-12-21 0:14 ` Björn Steinbrink
2007-12-21 0:49 ` Linus Torvalds
2007-12-20 23:50 ` Junio C Hamano
2007-12-21 0:03 ` Linus Torvalds
2007-12-21 17:35 ` [PATCH] Allow selection of different cleanup modes for " Alex Riesen
2007-12-21 21:43 ` Junio C Hamano
2007-12-21 23:08 ` Alex Riesen
2007-12-22 7:59 ` Junio C Hamano
2007-12-22 18:46 ` Alex Riesen
2007-12-22 19:18 ` Linus Torvalds
2007-12-22 19:41 ` Junio C Hamano
2007-12-23 3:01 ` Junio C Hamano
2007-12-23 3:46 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20071220233539.GC3052@steel.home \
--to=raa.lkml@gmail.com \
--cc=git@vger.kernel.org \
--cc=torvalds@linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).