diff options
author | Junio C Hamano <gitster@pobox.com> | 2012-04-26 10:35:15 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2012-04-26 10:35:15 -0700 |
commit | b4bd6bb356795ef817d44d65c16bba7f192ab29e (patch) | |
tree | fa810822ac0ebc8d83178a888f7340acbb6e04dc /Documentation | |
parent | 4579a0547cc558bd0e341adb77897e1f2f331f78 (diff) | |
parent | 1f08c2c8258cb09d4e78b8c3ff7e45a570f957ea (diff) | |
download | git-b4bd6bb356795ef817d44d65c16bba7f192ab29e.tar.gz |
Merge branch 'jc/commit-unedited-template' into maint
When "git commit --template F" errors out because the user did not
touch the message, it claimed that it aborts due to "empty message",
which was utterly wrong.
By Junio C Hamano (4) and Adam Monsen (1)
* jc/commit-unedited-template:
Documentation/git-commit: rephrase the "initial-ness" of templates
git-commit.txt: clarify -t requires editing message
commit: rephrase the error when user did not touch templated log message
commit: do not trigger bogus "has templated message edited" check
t7501: test the right kind of breakage
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-commit.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 5cc84a1391..68abfcacca 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -132,11 +132,14 @@ 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. + When editing the commit message, start the editor with the + contents in the given file. The `commit.template` configuration + variable is often used to give this option implicitly to the + command. This mechanism can be used by projects that want to + guide participants with some hints on what to write in the message + in what order. If the user exits the editor without editing the + message, the commit is aborted. This has no effect when a message + is given by other means, e.g. with the `-m` or `-F` options. -s:: --signoff:: |