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

Re: [PATCH 4/7] merge,tag: describe -m just like commit

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Feb 15, 2011, 07:08 UTC
Message-ID
<4D5A267B.7070902@drmicha.warpmail.net>
In-Reply-To
<7v4o86s7km.fsf@alter.siamese.dyndns.org>
Junio C Hamano venit, vidit, dixit 14.02.2011 21:08:
Show 9 quoted lines
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> This also removes the misleading "if any" which sounds as if omitting
>> "-m" would omit the commmit message. (It meant to mean "if a merge
>> commit is created at all".)
> 
> Hmph, then don't we want to keep that in your clearer form, i.e.
> 
> 	specify merge commit message (if a merge is created at all)
Well, any option is effective only in the case when the command succeeds
- "commit -m msg" specifies only a message when a commit is created at
all, etc. So, it usually is a trivial remark. It is slightly different
for merge because merge may succeed by doing a fast-forward without
creating a merge commit, which is why I wrote "merge commit message".
So, the parenthetical remark would have to be "if a non-ff merge commit
is created". I'm afraid "merge created" alone would not convey this.
> An option is by definition to _specify_ something, "specify" is a waste of
> space in a description of an option.  E.g. in patch 3/7, --template option
> is described as "directory from which templates will be used", and not
> "specify the directory from which...".

Oh yes, I tried to refrain from mixing other clean-up tasks with the unifying series, especially in the absence of (my knowledge about) an option "style guide". If "--foo bar" specifies that "bar" is used as "baz" then saying "--foo <BAR>: baz" is enough and c/should be the general rule. I'd be happy to incorporate this.

Michael
Previous: Junio C HamanoNext: Junio C Hamano
Message 13 of 36 in “Cleaning up --help-all inconsistencies”
  1. 0/7 Cleaning up --help-all inconsistenciesMichael J Gruber, Feb 14, 2011
  2. 1/7 commit,tag: use same wording for -FMichael J Gruber, Feb 14, 2011
  3. Junio C HamanoFeb 14, 2011
  4. 2/7 push: describe --porcelain just like commit and statusMichael J Gruber, Feb 14, 2011
  5. Johannes SixtFeb 14, 2011
  6. Junio C HamanoFeb 14, 2011
  7. Sverre RabbelierFeb 14, 2011
  8. Michael J GruberFeb 15, 2011
  9. 3/7 clone,init: describe --template using the same wordingMichael J Gruber, Feb 14, 2011
  10. Junio C HamanoFeb 14, 2011
  11. 4/7 merge,tag: describe -m just like commitMichael J Gruber, Feb 14, 2011
  12. Junio C HamanoFeb 14, 2011
  13. Michael J GruberFeb 15, 2011
  14. Junio C HamanoFeb 15, 2011
  15. 5/7 add: describe --patch like checkout, resetMichael J Gruber, Feb 14, 2011
  16. 6/7 commit,status: describe -u likewiseMichael J Gruber, Feb 14, 2011
  17. Junio C HamanoFeb 14, 2011
  18. Michael J GruberFeb 15, 2011
  19. Jeff KingFeb 15, 2011
  20. 7/7 git-tag.txt: list all modes in the descriptionMichael J Gruber, Feb 14, 2011
  21. Junio C HamanoFeb 14, 2011
  22. 00/10 Cleaning up --help-all inconsistenciesMichael J Gruber, Feb 15, 2011
  23. Junio C HamanoFeb 15, 2011
  24. Michael J GruberFeb 16, 2011
  25. Junio C HamanoFeb 16, 2011
  26. Make <identifier> lowercase in DocumentationMichael J Gruber, Feb 17, 2011
  27. 01/10 commit,tag: use same wording for -FMichael J Gruber, Feb 15, 2011
  28. 02/10 commit,status: describe --porcelain just like pushMichael J Gruber, Feb 15, 2011
  29. 03/10 clone,init: describe --template using the same wordingMichael J Gruber, Feb 15, 2011
  30. 04/10 commit,merge,tag: describe -m likewiseMichael J Gruber, Feb 15, 2011
  31. 05/10 add: describe --patch like checkout, resetMichael J Gruber, Feb 15, 2011
  32. 06/10 commit,status: describe -u likewiseMichael J Gruber, Feb 15, 2011
  33. 07/10 git-tag.txt: list all modes in the descriptionMichael J Gruber, Feb 15, 2011
  34. 08/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011
  35. 09/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011
  36. 10/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011

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.