From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NXEFB-00008k-JR for qemu-devel@nongnu.org; Tue, 19 Jan 2010 08:35:41 -0500 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1NXEF7-00006V-RY for qemu-devel@nongnu.org; Tue, 19 Jan 2010 08:35:41 -0500 Received: from [199.232.76.173] (port=32797 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NXEF7-00006M-Ly for qemu-devel@nongnu.org; Tue, 19 Jan 2010 08:35:37 -0500 Received: from mx1.redhat.com ([209.132.183.28]:1025) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1NXEF7-0002u2-65 for qemu-devel@nongnu.org; Tue, 19 Jan 2010 08:35:37 -0500 Date: Tue, 19 Jan 2010 15:32:32 +0200 From: "Michael S. Tsirkin" Message-ID: <20100119133232.GB25083@redhat.com> References: <1263662384-1459-1-git-send-email-weil@mail.berlios.de> <4B54B749.5080304@mail.berlios.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <4B54B749.5080304@mail.berlios.de> Subject: [Qemu-devel] Re: [PATCH] Documentation: Add missing documentation for qdev related command line options List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Stefan Weil Cc: Markus Armbruster , QEMU Developers On Mon, Jan 18, 2010 at 08:32:25PM +0100, Stefan Weil wrote: > Markus Armbruster schrieb: > > Stefan Weil writes: > > > >> The command line options -device, -nodefaults, -readconfig, > >> -writeconfig had entries for command line help, but > >> documentation for texi and derived formats (man, html, info) > >> was missing. > >> > >> This also required moving "@end table" to the end of > >> qemu-options.hx again. > >> > >> Signed-off-by: Stefan Weil > >> --- > >> qemu-options.hx | 25 +++++++++++++++++++++---- > >> 1 files changed, 21 insertions(+), 4 deletions(-) > >> > >> diff --git a/qemu-options.hx b/qemu-options.hx > >> index e2edd71..b2d04e2 100644 > >> --- a/qemu-options.hx > >> +++ b/qemu-options.hx > >> @@ -404,6 +404,12 @@ ETEXI > >> > >> DEF("device", HAS_ARG, QEMU_OPTION_device, > >> "-device driver[,options] add device\n") > >> +STEXI > >> +@item -device @var{driver}[,@var{option}[,...]] > >> +Add device @var{driver}. Depending on the device type, > >> +@var{option} (typically @var{key}=@var{value}) may be useful. > >> +ETEXI > >> + > > > > While there, would you mind improving --help for -device a bit? It's > > too terse, and it doesn't start the help text in column 16 like the > > other options do. > > Hi Markus, > > this needs a little more work. I just had a look on the code, > and there is no online help for the possible options (key, value). > > If you (and especially those who have commit rights) agree, > I could provide these three additional patches: > > * Add online help for properties (qemu -device driver,?) > * Add online help for property value (qemu -device driver,property=?) > * Update documentation for command line option -device > > There is already an online help for the driver (qemu -device ?). > > Regards, > > Stefan > Yes, this was on list of things to be fixed for a long time now. Some more things that need looking into: . -device ? itself is undocumented . - device ? currently prints system devices as well let's only print these that have a description and add ?? to list all devices . -netdev has undocumented options as well . we should have a flag to dump all options in one go, for ease of searching -- MST