From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53866) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a9r4D-0003O8-Jy for qemu-devel@nongnu.org; Fri, 18 Dec 2015 04:11:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1a9r49-0001go-HJ for qemu-devel@nongnu.org; Fri, 18 Dec 2015 04:11:13 -0500 Received: from mx1.redhat.com ([209.132.183.28]:50026) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1a9r49-0001fG-CB for qemu-devel@nongnu.org; Fri, 18 Dec 2015 04:11:09 -0500 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) by mx1.redhat.com (Postfix) with ESMTPS id 3F678C0A5262 for ; Fri, 18 Dec 2015 09:11:08 +0000 (UTC) From: Markus Armbruster References: <1450371004-26866-1-git-send-email-armbru@redhat.com> <1450371004-26866-6-git-send-email-armbru@redhat.com> <5672E9E5.70004@redhat.com> <87wpsduf2i.fsf@blackfin.pond.sub.org> <5672FC0D.70300@redhat.com> <87mvt8rjcu.fsf@blackfin.pond.sub.org> <567312A2.3070503@redhat.com> Date: Fri, 18 Dec 2015 10:11:05 +0100 In-Reply-To: <567312A2.3070503@redhat.com> (Eric Blake's message of "Thu, 17 Dec 2015 12:53:06 -0700") Message-ID: <87bn9ojf4m.fsf@blackfin.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Qemu-devel] [PATCH v2 05/23] error: Improve documentation around error_append_hint() List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: qemu-devel@nongnu.org Eric Blake writes: > On 12/17/2015 12:00 PM, Markus Armbruster wrote: > >>>>>> @@ -128,6 +138,7 @@ ErrorClass error_get_class(const Error *err); >>>>>> * If @errp is anything else, *@errp must be NULL. >>>>>> * The new error's class is ERROR_CLASS_GENERIC_ERROR, and its >>>>>> * human-readable error message is made from printf-style @fmt, ... >>>>>> + * The resulting message should not contain newlines. >>>>> >>>>> Should we also discourage trailing punctuation? >>>> >>>> Yes. How to best phrase it? >>> >>> Maybe: >>> >>> The resulting message should be a single phrase, with no newline or >>> trailing punctuation. >> >> What about ending the message with an exclamation mark? > > Very few current users do that! An exclamation mark is still trailing > punctuation! And I don't like shouting at users! > > :) Okay, okay, I applied it %-)