Documentation/git-commit: rephrase the "initial-ness" of templates
The description of "commit -t <file>" said the file is used "as the initial version" of the commit message, but in the context of an SCM, "version" is a loaded word that can needlesslyl confuse readers. Explain the purpose of the mechanism without using "version". Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Apr 3, 2012 at 16:41 UTC
1f08c2c8258cb09d4e78b8c3ff7e45a570f957ea
1 file changed
+8
-5
Documentation/git-commit.txt
+8
-5
@@ -132,11 +132,14 @@ OPTIONS
132
133
-t <file>::
134
--template=<file>::
135
- Use the contents of the given file as the initial version of the
136
- commit message. The editor is invoked so you can make subsequent
137
- changes. If you make no changes, the commit is aborted. If a message
138
- is specified using the `-m` or `-F` options, this option has no
139
- effect. This overrides the `commit.template` configuration variable.
135
+ When editing the commit message, start the editor with the
136
+ contents in the given file. The `commit.template` configuration
137
+ variable is often used to give this option implicitly to the
138
+ command. This mechanism can be used by projects that want to
139
+ guide participants with some hints on what to write in the message
140
+ in what order. If the user exits the editor without editing the
141
+ message, the commit is aborted. This has no effect when a message
142
+ is given by other means, e.g. with the `-m` or `-F` options.
143
144
-s::
145
--signoff::