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

Re: How to begin an error/die string? Upper- or lower-case letter?

From
Thomas Gummerer <t.gummerer@gmail.com>
Date
Dec 11, 2017, 12:25 UTC
Message-ID
<CALgYhfN4NiQsaBZBU8jj4XBd48BjdWcEUqJCZH-rkHF-8QbdLQ@mail.gmail.com>
In-Reply-To
<0ABBA110-59E9-423C-9A8E-9CF4BE2C4CA9@gmail.com>

On Mon, Dec 11, 2017 at 10:23 AM, Lars Schneider <larsxschneider@gmail.com> wrote:

Show 9 quoted lines
> Hi,
>
> error() and die() messages seems to begin with upper-case and
> lower-case letters in the Git code base:
>
>   git grep 'error(_' | perl -nE 'say /.*error\(_\("(.).*/' | sort | uniq -c
>   git grep 'die(_' | perl -nE 'say /.*die\(_\("(.).*/' | sort | uniq -c
>
> Do we prefer one way over the other?
The coding guidelines mandate not capitalizing error messages:
    $ git grep -A6 "Error Messages" Documentation/CodingGuidelines
    Documentation/CodingGuidelines:Error Messages
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Do not end error messages with a
full stop.
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Do not capitalize ("unable to
open %s", not "Unable to open %s")
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Say what the error is first
("cannot open %s", not "%s: cannot open")

I guess those that are capitalized are just leftovers from before we had that guideline in place, or slipped through review.

> Thanks,
> Lars
>
Previous: Lars Schneider
Message 2 of 2 in “How to begin an error/die string? Upper- or lower-case letter?”
  1. Lars SchneiderDec 11, 2017
  2. Thomas GummererDec 11, 2017

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.