git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Adam Monsen <haircut@gmail.com>
To: Junio C Hamano <gitster@pobox.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 21:53:19 -0700	[thread overview]
Message-ID: <4F753C3F.7010805@gmail.com> (raw)
In-Reply-To: <7vr4waoics.fsf@alter.siamese.dyndns.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Junio C Hamano wrote:
> You still say "the message is considered empty and" but I think it
>  probably reads better without it.

Do you like the patch without those words?

> Strictly speaking, it is not a "mandatory fillable form", but 
> whatever text you put in the template is advisory to the users.

Ok, right on. I understand the template feature now since you've
patiently explained it to me (thank you!). I still want to plainly
convey that even if my template is the following:

	~~~~
	zip module: continue to expand transformer
	
	This WIP will eventually provide expanded
	transformer functionality.
	~~~~

I *cannot* just save and quit my editor (unless I supply
- --allow-empty-message). That's the behavior I find confusing: git
telling me a non-empty commit message is an empty commit message. If I
save that text above (zip module... etc) in FILE and do `git commit -t
FILE`, save and quit my editor, git says "Aborting commit due to empty
commit message." Lies! A more precise message would be "Aborting
commit due to unmodified commit message template."

Based on the current documentation I misunderstood that -t could be
used to review a boilerplate commit message and save it verbatim.

...AHA! I just figured out a way to do exactly that:

	git commit --edit --file=FILE

aka

	git commit -eF FILE

Yay! No idea how I missed that before.

Anyway, it still seems like the documentation for "git commit -t"
could use improvement. I actually wouldn't mind seeing a short example
template like the one you provided, maybe in the EXAMPLES or
DISCUSSION section.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)

iQEcBAEBAgAGBQJPdTw/AAoJEJtdmT+DbynAte4IALRx50yW5bEfzXskvSDewPuL
SgaU4CqUHRm8sWXHeFbd4I2rG4dEJuqYqzKKbfay3EMwEbIkThiwoC2pJ9xJoFpe
8O95GVp3ikYvsY3mn87ebiwA9FBhnTy1Fz+MREfuzETpJbdtJSHhbRXMxfJ9ZabU
FOPE/qeZDvQJA9b9QFY3QS/BcxsGHXhW9xCULZlAprDggMcchhHDEbqJCh/1wObw
cQvoONiqZSkXA17K3gxfs7NgafUVFIg3+N9vcq90eZXbT/s1MM+1zxj5ezTh9jbV
sOkzepfE5+NBK3PnewMDxDxhF0LD5lzHCwnfkTl1Om3okSE0nxVyRZKabuzc99s=
=NUN8
-----END PGP SIGNATURE-----

  reply	other threads:[~2012-03-30  4:53 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
2012-03-30  3:07       ` Adam Monsen
2012-03-30  3:52         ` Junio C Hamano
2012-03-30  4:53           ` Adam Monsen [this message]
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=4F753C3F.7010805@gmail.com \
    --to=haircut@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).