All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Andrew Jones <drjones@redhat.com>,
	qemu-arm@nongnu.org, QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [Qemu-devel] [PATCH] hw/arm/virt: error_report cleanups
Date: Mon, 09 Nov 2015 11:21:44 +0100	[thread overview]
Message-ID: <87oaf3jww7.fsf@blackfin.pond.sub.org> (raw)
In-Reply-To: <CAFEAcA8rsWg=9ZV75ZmJYPrPznUH-bQObvzHUem1Tciv3_5CaA@mail.gmail.com> (Peter Maydell's message of "Mon, 9 Nov 2015 10:01:12 +0000")

Peter Maydell <peter.maydell@linaro.org> writes:

> On 9 November 2015 at 07:44, Markus Armbruster <armbru@redhat.com> wrote:
>> For consistency, error messages should be a phrase, not a full sentence,
>> let alone a paraphraph.
>
> This is in direct conflict with wanting them to be actually useful
> to users :-(

I appreciate your drive for useful error messages.  Judging from the
error messages we got, it's a rare thing.

Let me rephrase.  The error message proper (the thing emitted by
error_report()) should be a phrase, and it should be short and to the
point.  It can be followed by hints.  Compare:

    qemu-system-arm: Unable to determine GIC version supported by host. KVM acceleration is probably not supported.

and

    qemu-system-arm: Unable to determine GIC version supported by host
    KVM acceleration is probably not supported

I prefer the latter.  The error message proper is short and to the
point.  The hint points to the most probable cause.  Sensible line
lengths.

By the way, the error.h API supports this message + hints convention
since commit 50b7b00.

  reply	other threads:[~2015-11-09 10:21 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-11-07 15:25 [Qemu-devel] [PATCH] hw/arm/virt: error_report cleanups Andrew Jones
2015-11-07 16:56 ` Peter Maydell
2015-11-09  7:44   ` Markus Armbruster
2015-11-09 10:01     ` Peter Maydell
2015-11-09 10:21       ` Markus Armbruster [this message]
2015-11-09 15:47         ` Peter Maydell
2015-11-09 18:52           ` Markus Armbruster
2015-11-10  9:31             ` Peter Maydell
2015-11-10  9:39               ` Markus Armbruster
2015-11-10 11:55                 ` Peter Maydell
2015-11-10 13:02                   ` Andrew Jones

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=87oaf3jww7.fsf@blackfin.pond.sub.org \
    --to=armbru@redhat.com \
    --cc=drjones@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-arm@nongnu.org \
    --cc=qemu-devel@nongnu.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.