[PATCH 2/2] commit: fix ending newline for template files
- From
Patryk Obara <patryk.obara@gmail.com>
- Date
- May 26, 2015, 06:15 UTC
- Message-ID
- <1432620908-16071-3-git-send-email-patryk.obara@gmail.com>
- In-Reply-To
- <1432620908-16071-1-git-send-email-patryk.obara@gmail.com>
git-commit with -t or -F -e uses content of user-supplied file as initial value for commit msg in editor. There is no guarantee, that this file ends with newline - it depends on file content and editor used to create file (some editors append and hide last newline from user while others do not).
When --status (default) is supplied, additional comment is placed after template content. If template file ended with newline this results in additional line being appended (which may be unexpected e.g. when last line of template is a comment). On the other hand, first line of status should never be concatenated to last line of template file.
Append newline before status _only_ if template/logfile didn't end with one already. This way content of template is exactly the way user intended and there's no chance, that line of status will merge with last line of template.
Remove unnecessary premature cleanup of commit message, which was implemented for -F, but not for -t.
Signed-off-by: Patryk Obara <patryk.obara@gmail.com> --- builtin/commit.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/builtin/commit.c b/builtin/commit.c index da79ac4..eb41e05 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -666,8 +666,8 @@ static int prepare_to_commit(const char *index_file, const char *prefix, struct strbuf sb = STRBUF_INIT; const char *hook_arg1 = NULL; const char *hook_arg2 = NULL; - int clean_message_contents = (cleanup_mode != CLEANUP_NONE); int old_display_comment_prefix; + int sb_ends_with_newline = 0; /* This checks and barfs if author is badly specified */ determine_author_info(author_ident); @@ -737,7 +737,6 @@ static int prepare_to_commit(const char *index_file, const char *prefix, if (strbuf_read_file(&sb, template_file, 0) < 0) die_errno(_("could not read '%s'"), template_file); hook_arg1 = "template"; - clean_message_contents = 0; } /* @@ -775,9 +774,6 @@ static int prepare_to_commit(const char *index_file, const char *prefix, */ s->hints = 0; - if (clean_message_contents) - stripspace(&sb, 0); - if (signoff) append_signoff(&sb, ignore_non_trailer(&sb), 0); @@ -786,6 +782,9 @@ static int prepare_to_commit(const char *index_file, const char *prefix, if (auto_comment_line_char) adjust_comment_line_char(&sb); + + sb_ends_with_newline = ends_with(sb.buf, "\n"); + strbuf_release(&sb); /* This checks if committer ident is explicitly given */ @@ -794,6 +793,10 @@ static int prepare_to_commit(const char *index_file, const char *prefix, int ident_shown = 0; int saved_color_setting; struct ident_split ci, ai; + int append_newline = (template_file || logfile) ? !sb_ends_with_newline : 1; + + if (append_newline) + fprintf(s->fp, "\n"); if (whence != FROM_COMMIT) { if (cleanup_mode == CLEANUP_SCISSORS) @@ -815,7 +818,6 @@ static int prepare_to_commit(const char *index_file, const char *prefix, : "CHERRY_PICK_HEAD")); } - fprintf(s->fp, "\n"); if (cleanup_mode == CLEANUP_ALL) status_printf(s, GIT_COLOR_NORMAL, _("Please enter the commit message for your changes."
-- 2.4.1