[Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1?

[Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1?

[Stefan Weil]

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

Re: [Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1?

[陳韋任]

> 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.

  How about qemu-system-YOUR_TARGET? Not everyone use x86/x86_64, so I think
replace "qemu" with particular name is inappropriate.
 
> When "qemu" is not used for the name of the executable, it
> should be written "QEMU".

  Agreed.

  I have no idea about remaining stuff. :)
 
Regards,
chenwj

-- 
Wei-Ren Chen (陳韋任)
Computer Systems Lab, Institute of Information Science,
Academia Sinica, Taiwan (R.O.C.)
Tel:886-2-2788-3799 #1667
Homepage: http://people.cs.nctu.edu.tw/~chenwj

Re: [Qemu-devel] [RFC 1.1] Fix "qemu" in documentation for version 1.1?

[ronnie sahlberg]

On Thu, May 3, 2012 at 7:04 AM, Stefan Weil <sw@weilnetz.de> wrote:
> 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.

"qemu-system-<something> is a bit verbose to just represent "your qemu
executable of choice".

What about "<qemu>"  and just have a paragraph at the start of the
documentation that specifies that
<qemu> is the wildcard for whatever executable/target you picked.


regards
ronnie sahlberg