From b0ad5e27803cd599e629b1a64b74ac4bffb3962d Mon Sep 17 00:00:00 2001 From: Adam Monsen Date: Sat, 31 Mar 2012 12:28:15 -0700 Subject: git-commit.txt: clarify -t requires editing message Make it clear that, when using commit --template, the message *must* be changed or the commit will be aborted. Helped-by: Junio C Hamano Helped-by: Ivan Heffner Signed-off-by: Adam Monsen Signed-off-by: Junio C Hamano --- Documentation/git-commit.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 5cc84a139..f584a6214 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -132,11 +132,11 @@ OPTIONS -t :: --template=:: - 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. + Use the contents of the given file as the initial version of the + commit message. The editor is invoked so you can make subsequent + changes. If you make no changes, 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:: -- cgit v1.2.1 From 1f08c2c8258cb09d4e78b8c3ff7e45a570f957ea Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 3 Apr 2012 16:41:21 -0700 Subject: Documentation/git-commit: rephrase the "initial-ness" of templates The description of "commit -t " 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 --- Documentation/git-commit.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index f584a6214..68abfcacc 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -132,11 +132,14 @@ OPTIONS -t :: --template=:: - Use the contents of the given file as the initial version of the - commit message. The editor is invoked so you can make subsequent - changes. If you make no changes, 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. + 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:: -- cgit v1.2.1