All of lore.kernel.org
 help / color / mirror / Atom feed
From: Stefan Weil <sw@weilnetz.de>
To: QEMU Developers <qemu-devel@nongnu.org>
Subject: [Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1?
Date: Wed, 02 May 2012 23:04:37 +0200	[thread overview]
Message-ID: <4FA1A165.40703@weilnetz.de> (raw)

Hello,

the QEMU documentation (*texi, docs/*, maybe more files) still
includes lots of examples using the executable name "qemu"
which is no longer supported.

Even if a future version of QEMU will provide this name again
(maybe as a common entry point for all other executables),
there is no qemu executable today. That's a bit confusing for
new users of QEMU which don't know the history.

I think man pages and html documentation should be as correct
as possible and therefore suggest replacing "qemu" by
qemu-system-i386 (or qemu-system-x86_64, any other
executable, or randomly selected executables?) in *texi.

When "qemu" is not used for the name of the executable, it
should be written "QEMU".

Should the man page's current name (qemu.1) be changed or
linked to qemu-system-i386 and so on?

The examples in docs/* are less important for end users, so
fixing these is also less important for QEMU 1.1.

Please send suggestions and feedback whether patches for 1.1
seem reasonable or too late for that version.

Regards,

Stefan Weil

             reply	other threads:[~2012-05-02 21:04 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-02 21:04 Stefan Weil [this message]
2012-05-03  3:32 ` [Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1? 陳韋任
2012-05-03  6:55 ` ronnie sahlberg

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=4FA1A165.40703@weilnetz.de \
    --to=sw@weilnetz.de \
    --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.