From: Adam Monsen <haircut@gmail.com>
To: git@vger.kernel.org
Cc: Ivan Heffner <iheffner@gmail.com>, Adam Monsen <haircut@gmail.com>
Subject: [PATCH v2] git-commit.txt: clarify -t requires editing message
Date: Thu, 29 Mar 2012 16:04:56 -0700 [thread overview]
Message-ID: <1333062296-27823-1-git-send-email-haircut@gmail.com> (raw)
In-Reply-To: <CAF_oF=xGHdbkYw-ytvcZvJnqZ_jdckUCBiuUDzkqGDk=66+yMQ@mail.gmail.com>
Make it clear that, when using a commit template, the message *must* be
changed or the commit will be aborted "due to empty commit message".
Helped-by: Ivan Heffner <iheffner@gmail.com>
Signed-off-by: Adam Monsen <haircut@gmail.com>
---
Incorporate feedback from Ivan Heffner.
Anyone else agree/disagree with this patch? I would like to see the
manpage improved because I found the behavior of "git commit -t"
confusing as documented.
I wrapped the text at 77 characters because that was the longest
line in the file (according to wc -L).
I used ":set noet nosta ts=8 sw=8 tw=77" in Vim.
Documentation/git-commit.txt | 10 ++++++----
1 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 5cc84a1..c6df120 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -133,10 +133,12 @@ OPTIONS
-t <file>::
--template=<file>::
Use the contents of the given file as the initial version
- of the commit message. The editor is invoked and you can
- make subsequent changes. If a message is specified using
- the `-m` or `-F` options, this option has no effect. This
- overrides the `commit.template` configuration variable.
+ of the commit message. The editor is invoked so you can
+ make subsequent changes. If you make no changes, the message
+ is considered empty and the commit is aborted. If a message
+ is specified using the `-m` or `-F` options, this option has
+ no effect. This overrides the `commit.template`
+ configuration variable.
-s::
--signoff::
--
1.7.5.4
next prev parent reply other threads:[~2012-03-29 23:05 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-29 17:57 [PATCH] git-commit doc: say -t requires editing commit message Adam Monsen
2012-03-29 18:09 ` Ivan Heffner
2012-03-29 23:04 ` Adam Monsen [this message]
2012-03-30 2:05 ` [PATCH v2] git-commit.txt: clarify -t requires editing message Junio C Hamano
2012-03-30 3:07 ` Adam Monsen
2012-03-30 3:52 ` Junio C Hamano
2012-03-30 4:53 ` Adam Monsen
2012-03-30 5:08 ` Junio C Hamano
2012-03-30 5:43 ` Adam Monsen
2012-03-30 18:17 ` Junio C Hamano
2012-03-30 19:45 ` [PATCH 0/3] "commit --template" fixes Junio C Hamano
2012-03-30 19:45 ` [PATCH 1/3] t7501: test the right kind of breakage Junio C Hamano
2012-03-30 19:45 ` [PATCH 2/3] commit: do not trigger bogus "has templated message edited" check Junio C Hamano
2012-03-30 19:45 ` [PATCH 3/3] commit: rephrase the error when user did not touch templated log message Junio C Hamano
2012-03-31 19:28 ` [PATCH 0/3] "commit --template" fixes Adam Monsen
2012-04-01 22:28 ` Junio C Hamano
2012-04-03 17:11 ` Adam Monsen
2012-04-03 21:55 ` Junio C Hamano
2012-04-05 14:29 ` Adam Monsen
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=1333062296-27823-1-git-send-email-haircut@gmail.com \
--to=haircut@gmail.com \
--cc=git@vger.kernel.org \
--cc=iheffner@gmail.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).