git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 4/7] merge,tag: describe -m just like commit
Date: Tue, 15 Feb 2011 08:08:43 +0100	[thread overview]
Message-ID: <4D5A267B.7070902@drmicha.warpmail.net> (raw)
In-Reply-To: <7v4o86s7km.fsf@alter.siamese.dyndns.org>

Junio C Hamano venit, vidit, dixit 14.02.2011 21:08:
> 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

  reply	other threads:[~2011-02-15  7:11 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-14 15:10 [PATCH 0/7] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-14 15:10 ` [PATCH 1/7] commit,tag: use same wording for -F Michael J Gruber
2011-02-14 19:49   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 2/7] push: describe --porcelain just like commit and status Michael J Gruber
2011-02-14 19:42   ` Johannes Sixt
2011-02-14 19:53   ` Junio C Hamano
2011-02-14 22:25     ` Sverre Rabbelier
2011-02-15  6:50     ` Michael J Gruber
2011-02-14 15:10 ` [PATCH 3/7] clone,init: describe --template using the same wording Michael J Gruber
2011-02-14 19:54   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 4/7] merge,tag: describe -m just like commit Michael J Gruber
2011-02-14 20:08   ` Junio C Hamano
2011-02-15  7:08     ` Michael J Gruber [this message]
2011-02-15 18:14       ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 5/7] add: describe --patch like checkout, reset Michael J Gruber
2011-02-14 15:10 ` [PATCH 6/7] commit,status: describe -u likewise Michael J Gruber
2011-02-14 19:57   ` Junio C Hamano
2011-02-15  6:53     ` Michael J Gruber
2011-02-15  7:21       ` Jeff King
2011-02-14 15:10 ` [PATCH 7/7] git-tag.txt: list all modes in the description Michael J Gruber
2011-02-14 20:03   ` Junio C Hamano
2011-02-15 13:09 ` [PATCHv2 00/10] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-15 19:02   ` Junio C Hamano
2011-02-16  7:46     ` Michael J Gruber
2011-02-16 21:34       ` Junio C Hamano
2011-02-17  7:48         ` [PATCH] Make <identifier> lowercase in Documentation Michael J Gruber
     [not found] ` <cover.1297775122.git.git@drmicha.warpmail.net>
2011-02-15 13:09   ` [PATCHv2 01/10] commit,tag: use same wording for -F Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 02/10] commit,status: describe --porcelain just like push Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 03/10] clone,init: describe --template using the same wording Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 04/10] commit,merge,tag: describe -m likewise Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 05/10] add: describe --patch like checkout, reset Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 06/10] commit,status: describe -u likewise Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 07/10] git-tag.txt: list all modes in the description Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 08/10] Make <identifier> lowercase as per CodingGuidelines Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 09/10] " Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 10/10] " Michael J Gruber

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4D5A267B.7070902@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).