From: Christian Schoenebeck <qemu_oss@crudebyte.com>
To: qemu-devel@nongnu.org, "Daniel P. Berrangé" <berrange@redhat.com>
Cc: Greg Kurz <groug@kaod.org>
Subject: Re: [PATCH] 9pfs: log warning if msize <= 8192
Date: Wed, 02 Sep 2020 18:03:12 +0200 [thread overview]
Message-ID: <2877776.MzA8b4DPAS@silver> (raw)
In-Reply-To: <20200902141035.GK403297@redhat.com>
On Mittwoch, 2. September 2020 16:10:35 CEST Daniel P. Berrangé wrote:
> > Yeah, I know, but the problem is I don't see how I would squeeze the
> > relevant information into only one log message; and even "what's a good
> > starting point" is already questionable.
> >
> > For that reason my plan was:
> > - logging this warning
> >
> > - describing the 'msize' issue in detail on the QEMU wiki (what's the
> >
> > point, how would you benchmark it)
> >
> > So my idea was: user sees the message, "what is 'msize?'" -> Google "msize
> > qemu" -> click 'QEMU wiki' -> read all the details.
> >
> > But how about this: I put a QEMU wiki link directly into the log message?
>
> Rather than that, how about putting it in the QEMU man page, and then
> just add "See 'man 1 qemu' for further guidance".
Well, I can do that of course. But somehow I fear users get lost by just
pointing them to "man 1 qemu" in the log message. It already starts that e.g.
on Debian there is no "man qemu", it is "man qemu-system" there instead. Next
issue is that qemu man page is currently not structured in a way that would
allow me to directly point them to the relevant man heading like:
man --pager='less -p ^9P-msize' qemu
So they would need to scroll their way through the entire man page by
themselfes and find confusing sections like "-fsdev -device virtio-9p-pci" vs.
"-virtfs", etc. I can imagine some people will struggle with that.
With a link like "https://wiki.qemu.org/Documentation/9psetup#msize" the thing
would be crystal clear within seconds.
Just my opinion. Greg?
Best regards,
Christian Schoenebeck
next prev parent reply other threads:[~2020-09-02 16:08 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-02 11:22 [PATCH] 9pfs: log warning if msize <= 8192 Christian Schoenebeck
2020-09-02 12:25 ` Daniel P. Berrangé
2020-09-02 12:52 ` Christian Schoenebeck
2020-09-02 13:39 ` Greg Kurz
2020-09-02 13:45 ` Daniel P. Berrangé
2020-09-02 14:08 ` Christian Schoenebeck
2020-09-02 14:10 ` Daniel P. Berrangé
2020-09-02 16:03 ` Christian Schoenebeck [this message]
2020-09-02 16:08 ` Daniel P. Berrangé
2020-09-02 16:54 ` Greg Kurz
2020-09-03 8:20 ` Christian Schoenebeck
2020-09-03 9:35 ` Greg Kurz
2020-09-03 10:57 ` Christian Schoenebeck
2020-09-02 13:58 ` Christian Schoenebeck
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=2877776.MzA8b4DPAS@silver \
--to=qemu_oss@crudebyte.com \
--cc=berrange@redhat.com \
--cc=groug@kaod.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 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).