git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2] git-commit.txt: clarify -t requires editing message

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 30, 2012, 05:08 UTC
Message-ID
<7vehsaoev5.fsf@alter.siamese.dyndns.org>
In-Reply-To
<4F753C3F.7010805@gmail.com>
Adam Monsen <haircut@gmail.com> writes:
> I *cannot* just save and quit my editor (unless I supply
> --allow-empty-message). That's the behavior I find confusing...

The root cause of the confusion is that the entire "--template" code piggy backs on the non-templated case, where we would want to error out if the user leaves the editor without explaining the commit. And an appropriate diagnosis message for the "normal" case is "you gave me an empty message", but "--template" code did not bother updating that to suit what it tries to do better, e.g. "you did not edit the template I gave you".

The check to see if the message the user left matches that came from the template was tacked into a wrong function message_is_empty(); it should be made into its own helper function and called from the same caller where it calls message_is_empty() only when template_file is not NULL. Also its honoring "--allow-empty" needs to be reconsidered.

In other words, I think that is something that needs fixing the broken code to behave less confusingly, not documenting its wrong behaviour.

Previous: Adam MonsenNext: Adam Monsen
Message 8 of 19 in “git-commit doc: say -t requires editing commit message”
  1. git-commit doc: say -t requires editing commit messageAdam Monsen, Mar 29, 2012
  2. Ivan HeffnerMar 29, 2012
  3. git-commit.txt: clarify -t requires editing messageAdam Monsen, Mar 29, 2012
  4. Junio C HamanoMar 30, 2012
  5. Adam MonsenMar 30, 2012
  6. Junio C HamanoMar 30, 2012
  7. Adam MonsenMar 30, 2012
  8. Junio C HamanoMar 30, 2012
  9. Adam MonsenMar 30, 2012
  10. Junio C HamanoMar 30, 2012
  11. 0/3 "commit --template" fixesJunio C Hamano, Mar 30, 2012
  12. 1/3 t7501: test the right kind of breakageJunio C Hamano, Mar 30, 2012
  13. 2/3 commit: do not trigger bogus "has templated message edited" checkJunio C Hamano, Mar 30, 2012
  14. 3/3 commit: rephrase the error when user did not touch templated log messageJunio C Hamano, Mar 30, 2012
  15. Adam MonsenMar 31, 2012
  16. Junio C HamanoApr 1, 2012
  17. Adam MonsenApr 3, 2012
  18. Junio C HamanoApr 3, 2012
  19. Adam MonsenApr 5, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.