From: Junio C Hamano <gitster@pobox.com>
To: Adam Monsen <haircut@gmail.com>
Cc: git@vger.kernel.org, Ivan Heffner <iheffner@gmail.com>
Subject: Re: [PATCH v2] git-commit.txt: clarify -t requires editing message
Date: Thu, 29 Mar 2012 19:05:43 -0700 [thread overview]
Message-ID: <7vboneq1vs.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1333062296-27823-1-git-send-email-haircut@gmail.com> (Adam Monsen's message of "Thu, 29 Mar 2012 16:04:56 -0700")
Adam Monsen <haircut@gmail.com> writes:
> 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 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.
First, think of template not as the "initial version" but as "a form that
needs to be filled", and imagine that you are explaining to a beginner how
to create a commit.
The word you would choose to use would be very different if you rephrase
the above after doing that mental exercise, and I suspect that it would
become much easier to read.
For example:
- subsequent changes --> fill in the form
- If ... considerede empty and --> If you did not fill the form
next prev parent reply other threads:[~2012-03-30 2:06 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-29 17:57 [PATCH] git-commit doc: say -t requires editing commit message Adam Monsen
2012-03-29 18:09 ` Ivan Heffner
2012-03-29 23:04 ` [PATCH v2] git-commit.txt: clarify -t requires editing message Adam Monsen
2012-03-30 2:05 ` Junio C Hamano [this message]
2012-03-30 3:07 ` Adam Monsen
2012-03-30 3:52 ` Junio C Hamano
2012-03-30 4:53 ` Adam Monsen
2012-03-30 5:08 ` Junio C Hamano
2012-03-30 5:43 ` Adam Monsen
2012-03-30 18:17 ` Junio C Hamano
2012-03-30 19:45 ` [PATCH 0/3] "commit --template" fixes Junio C Hamano
2012-03-30 19:45 ` [PATCH 1/3] t7501: test the right kind of breakage Junio C Hamano
2012-03-30 19:45 ` [PATCH 2/3] commit: do not trigger bogus "has templated message edited" check Junio C Hamano
2012-03-30 19:45 ` [PATCH 3/3] commit: rephrase the error when user did not touch templated log message Junio C Hamano
2012-03-31 19:28 ` [PATCH 0/3] "commit --template" fixes Adam Monsen
2012-04-01 22:28 ` Junio C Hamano
2012-04-03 17:11 ` Adam Monsen
2012-04-03 21:55 ` Junio C Hamano
2012-04-05 14:29 ` Adam Monsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7vboneq1vs.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=haircut@gmail.com \
--cc=iheffner@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).