All of lore.kernel.org
 help / color / mirror / Atom feed
From: Karel Zak <kzak@redhat.com>
To: Benno Schulenberg <bensberg@justemail.net>
Cc: JWP <elseifthen@gmx.com>, Util-Linux <util-linux@vger.kernel.org>
Subject: Re: [PATCH 2/5] hwclock: clean up message periods/full stops
Date: Mon, 27 Oct 2014 11:59:34 +0100	[thread overview]
Message-ID: <20141027105934.GG10134@x2.net.home> (raw)
In-Reply-To: <1414184287.962524.183013401.569326CF@webmail.messagingengine.com>

On Fri, Oct 24, 2014 at 10:58:07PM +0200, Benno Schulenberg wrote:
> 
> On Fri, Oct 24, 2014, at 18:07, JWP wrote:
> > So what is the util-linux position on message punctuation in general, and
> > line termination specifically?  The documentation seem to imply not using any.
> 
> The current situation is a mess.  And the documentation does not say
> anything about what error messages, status reports, and imperatives

I don't think so, but it would be nice to have
Documentation/howto-messages.txt.

> to the user should look like.  The general style seems to be:
> 
> 1) Error messages (anything that is preceded by the program name
> followed by a colon and a space, in thise case "hwclock: ") start with
> a lowercase letter and do not end in a period, nor use any period.

The preferred way to print error and warning messages is err() and
warn() (or errx() and warnx()). 

> 2) Status reports and imperatives to the user use full sentences:
> they start with a capital letter and end in a period.

yep.

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

  reply	other threads:[~2014-10-27 10:59 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-24  2:49 [PATCH 2/5] hwclock: clean up message periods/full stops JWP
2014-10-24 11:33 ` Benno Schulenberg
2014-10-24 12:37   ` JWP
2014-10-24 12:59     ` Karel Zak
2014-10-24 16:07       ` JWP
2014-10-24 20:58         ` Benno Schulenberg
2014-10-27 10:59           ` Karel Zak [this message]
2014-10-27 10:55         ` Karel Zak
2014-10-24 21:57     ` Lauri Nurmi

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=20141027105934.GG10134@x2.net.home \
    --to=kzak@redhat.com \
    --cc=bensberg@justemail.net \
    --cc=elseifthen@gmx.com \
    --cc=util-linux@vger.kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.