git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Alangi Derick <alangiderick@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>,
	Stefan Beller <sbeller@google.com>,
	"git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: Patch that modifies git usage message
Date: Fri, 1 May 2015 13:40:21 -0400	[thread overview]
Message-ID: <CAPig+cROY5ZaXtAWpaMpe8JsuG1eSp2jhAsSh1dAsCSACgoFxw@mail.gmail.com> (raw)
In-Reply-To: <CAKB+oNtKi6e7H9U75WEJDKH2KK349JT+vGE8+acHvM6SasCWfQ@mail.gmail.com>

(Etiquette on this list is to reply inline rather than top-posting[1].)

On Fri, May 1, 2015 at 12:38 PM, Alangi Derick <alangiderick@gmail.com> wrote:
> What about the other strings used for
> error display? For example
> die("cannot handle %s as a builtin", cmd);
> Can't i change the "cannot" to "Cannot"? Or is there a problem with
> that one too?

Despite inconsistencies in existing code, lowercase in new error
messages is intentional. Documentation/CodingGuidelines has this to
say[2]:

    Error Messages

    - Do not capitalize ("unable to open %s", not "Unable to
      open %s")

Therefore, a goal more aligned with this recommendation would be to
submit a patch which changes capitalized error messages to lowercase,
however, heed this warning[3] from CodingGuidelines:

   - Fixing style violations while working on a real change as a
     preparatory clean-up step is good, but otherwise avoid useless
     code churn for the sake of conforming to the style.

     "Once it _is_ in the tree, it's not really worth the patch noise
     to go and fix it up."
     Cf. http://article.gmane.org/gmane.linux.kernel/943020

Sometimes there are exceptions. One may be able to argue that making
user-facing messages more consistent is worthwhile (for instance [4]).

Finally, changing "usage:" to "Usage:" would undo recent work to
improve consistency of usage messages[4].

[1]: https://lkml.org/lkml/2005/1/11/111
[2]: https://github.com/git/git/blob/master/Documentation/CodingGuidelines#L416
[3]: https://github.com/git/git/blob/master/Documentation/CodingGuidelines#L21
[4]: http://thread.gmane.org/gmane.comp.version-control.git/216961

  parent reply	other threads:[~2015-05-01 17:40 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-01 11:01 Patch that modifies git usage message Alangi Derick
2015-05-01 15:51 ` Stefan Beller
2015-05-01 15:54   ` Alangi Derick
2015-05-01 16:29   ` Junio C Hamano
2015-05-01 16:38     ` Alangi Derick
2015-05-01 16:55       ` Stefan Beller
2015-05-01 17:40       ` Eric Sunshine [this message]
2015-05-01 17:49         ` Alangi Derick
2015-05-01 18:01           ` Eric Sunshine
2015-05-01 16:55     ` Stefan Beller

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=CAPig+cROY5ZaXtAWpaMpe8JsuG1eSp2jhAsSh1dAsCSACgoFxw@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=alangiderick@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=sbeller@google.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).