[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v2] qemu-options.hx: Improve documentation of ch
From: |
Stefan Hajnoczi |
Subject: |
Re: [Qemu-devel] [PATCH v2] qemu-options.hx: Improve documentation of chardev multiplexing mode |
Date: |
Wed, 17 Feb 2016 09:56:09 +0000 |
User-agent: |
Mutt/1.5.24 (2015-08-30) |
On Tue, Feb 16, 2016 at 05:28:58PM +0000, Peter Maydell wrote:
> The current documentation of chardev mux=on is rather brief and opaque;
> expand it to hopefully be a bit more helpful.
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> There was some discussion on #qemu yesterday evening about multiplexing,
> and "make the docs a bit less confusing" was one suggestion...
>
> v1->v2 changes:
> * include examples of the multiplexer use
> * mention that some other command options implicitly create a mux
> * link to the documentation of the mux's escape keys
> * fix up the documentation of mux escape keys so it can actually
> be linked to
> * drop the not-implemented "Ctrl-a ?" from the docs
> * improve the documentation of the mux keys a bit (in particular
> mentioning -echr, and being more generic than just "console/monitor")
>
> Our doc structure overall is pretty busted (why is all the documentation
> of generic stuff like -chardev lurking in "PC system emulation", for
> instance), so this is about as far as I want to go in cleaning up
> for now...
>
> qemu-doc.texi | 30 ++++++++++++++++++++----------
> qemu-options.hx | 45 +++++++++++++++++++++++++++++++++++++++++++--
> 2 files changed, 63 insertions(+), 12 deletions(-)
Reviewed-by: Stefan Hajnoczi <address@hidden>
signature.asc
Description: PGP signature