[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH] Documentation: Add missing documentation for qd
From: |
Markus Armbruster |
Subject: |
Re: [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options |
Date: |
Thu, 21 Jan 2010 17:45:12 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) |
Stefan Weil <address@hidden> writes:
> Markus Armbruster schrieb:
>> Stefan Weil <address@hidden> writes:
>>
>>> Markus Armbruster schrieb:
[...]
>>>> 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).
>>
>> What I had in mind was just to bring it up to par with your patch to the
>> texi, but...
>>
>>> 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
>>
>> ... a patch to provide that is very desirable!
>>
>> I figure the best way to document available properties and there values
>> is a self-documenting struct PropertyInfo: add a doc member, extend
>> DEFINE_PROP() & friends to set it, fix up users to pass NULL, and so
>> forth. We can then replace the NULL by something useful at our leisure.
>>
>>> There is already an online help for the driver (qemu -device ?).
>
> I cannot spend too much time on this, but a very basic help
> for "?" is implemented by the patch series I just sent to the list.
>
> The new feature was already very helpful for me, but it still
> can be improved, of course: the driver list contains shows
> too many drivers and is not nicely formatted, the help text
> for the values could be more user friendly, ...
It's a start. Many thanks!
- [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options, Stefan Weil, 2010/01/16
- Re: [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options, Markus Armbruster, 2010/01/18
- [Qemu-devel] Re: [PATCH] Documentation: Add missing documentation for qdev related command line options, Michael S. Tsirkin, 2010/01/19
- [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties, Stefan Weil, 2010/01/20
- [Qemu-devel] [PATCH 2/3] qdev: Add help for property value, Stefan Weil, 2010/01/20
- [Qemu-devel] [PATCH 3/3] Documentation: Improve command line help for -device option, Stefan Weil, 2010/01/20
- Re: [Qemu-devel] [PATCH 2/3] qdev: Add help for property value, Markus Armbruster, 2010/01/21
- Re: [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties, Markus Armbruster, 2010/01/21
- Re: [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties, Markus Armbruster, 2010/01/21
- Re: [Qemu-devel] [PATCH 1/3] qdev: Add help for device properties, Gerd Hoffmann, 2010/01/21
Re: [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options, Anthony Liguori, 2010/01/20