diff options
author | Junio C Hamano <gitster@pobox.com> | 2012-04-16 12:43:07 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2012-04-16 12:43:07 -0700 |
commit | 091df17f27ed735160bbd82360efb8154b35ffeb (patch) | |
tree | 497296ce56e74c321d7076e5c9dedfae38aa1ac5 /Documentation | |
parent | fa0ba729dc5e0af0b0165e4e12904bfa3f39f9db (diff) | |
parent | 1f08c2c8258cb09d4e78b8c3ff7e45a570f957ea (diff) | |
download | git-091df17f27ed735160bbd82360efb8154b35ffeb.tar.gz git-091df17f27ed735160bbd82360efb8154b35ffeb.tar.xz |
Merge branch 'jc/commit-unedited-template'
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 5cc84a139..68abfcacc 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:: |