From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
To: gitster@pobox.com
Cc: git@vger.kernel.org
Subject: [PATCH 2/2] commit-template: distinguish status information unconditionally
Date: Fri, 30 Jun 2017 17:42:21 +0530 [thread overview]
Message-ID: <20170630121221.3327-2-kaarticsivaraam91196@gmail.com> (raw)
In-Reply-To: <20170630121221.3327-1-kaarticsivaraam91196@gmail.com>
The commit template adds the status information without
adding a new line to distinguish them in the absence
of optional parts. This results in difficulty in interpreting
it's content, specifically for inexperienced users.
Unconditionally, add new lines to separate the status message
from the other parts of the commit-template to make it more
readable.
Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
---
In trying to make the test independent of the previous test,
it got a bit long. Hope it's not doing anything that shouldn't
be done.
In case you would wonder, the 'git reset' line is to remove
the files that were staged in previous test. I've done it in
the same motive that lead to a bigger test.
travis-ci builds passed
builtin/commit.c | 3 +--
t/t7500-commit.sh | 23 +++++++++++++++++++++++
2 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/builtin/commit.c b/builtin/commit.c
index 64701c8f4..22d17e6f2 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -873,8 +873,7 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
(int)(ci.name_end - ci.name_begin), ci.name_begin,
(int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
- if (ident_shown)
- status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
+ status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
saved_color_setting = s->use_color;
s->use_color = 0;
diff --git a/t/t7500-commit.sh b/t/t7500-commit.sh
index 116885a26..5739d3ed2 100755
--- a/t/t7500-commit.sh
+++ b/t/t7500-commit.sh
@@ -329,4 +329,27 @@ test_expect_success 'invalid message options when using --fixup' '
test_must_fail git commit --fixup HEAD~1 -F log
'
+cat >expected-template <<EOF
+
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+#
+# Author: A U Thor <author@example.com>
+#
+# On branch commit-template-check
+# Changes to be committed:
+# new file: commit-template-check
+#
+# Untracked files not listed
+EOF
+
+test_expect_success 'new line found before status message in commit template' '
+ git checkout -b commit-template-check &&
+ git reset --hard HEAD &&
+ touch commit-template-check &&
+ git add commit-template-check &&
+ GIT_EDITOR="cat >editor-input" git commit --untracked-files=no --allow-empty-message &&
+ test_i18ncmp expected-template editor-input
+'
+
test_done
--
2.11.0
next prev parent reply other threads:[~2017-06-30 12:14 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-26 17:24 [PATCH/RFC] commit-template: improve readability of commit template Kaartic Sivaraam
2017-06-26 21:59 ` Junio C Hamano
2017-06-27 17:22 ` Kaartic Sivaraam
2017-06-27 17:56 ` Junio C Hamano
2017-06-28 13:04 ` Kaartic Sivaraam
2017-06-28 14:50 ` Kaartic Sivaraam
2017-06-28 13:29 ` [PATCH] " Kaartic Sivaraam
2017-06-28 14:47 ` Kaartic Sivaraam
2017-06-28 16:48 ` Junio C Hamano
2017-06-29 17:01 ` [PATCH 1/2] commit-template: remove outdated notice about explicit paths Kaartic Sivaraam
2017-06-29 17:01 ` [PATCH 2/2] commit-template: add new line before status information Kaartic Sivaraam
2017-06-29 17:51 ` Junio C Hamano
2017-06-29 18:17 ` Junio C Hamano
2017-06-30 3:19 ` Kaartic Sivaraam
2017-06-29 17:56 ` [PATCH 1/2] commit-template: remove outdated notice about explicit paths Junio C Hamano
2017-06-30 3:18 ` Kaartic Sivaraam
2017-06-30 12:12 ` Kaartic Sivaraam
2017-06-30 12:12 ` Kaartic Sivaraam [this message]
2017-06-30 14:52 ` [PATCH 2/2] commit-template: distinguish status information unconditionally Junio C Hamano
2017-07-01 1:59 ` Kaartic Sivaraam
2017-07-01 11:44 ` Ævar Arnfjörð Bjarmason
2017-07-01 12:08 ` Kaartic Sivaraam
2017-07-01 17:21 ` Junio C Hamano
2017-07-09 17:54 ` [PATCH 1/2] commit-template: remove outdated notice about explicit paths Kaartic Sivaraam
2017-07-09 18:54 ` 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=20170630121221.3327-2-kaarticsivaraam91196@gmail.com \
--to=kaarticsivaraam91196@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).