[PATCH v2] git-commit.txt: clarify -t requires editing message
- From
Adam Monsen <haircut@gmail.com>
- Date
- Mar 29, 2012, 23:04 UTC
- Message-ID
- <1333062296-27823-1-git-send-email-haircut@gmail.com>
- 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