qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Qemu-devel] qdev device documentation (Re: [PATCH 0/2] usb-linux: p


From: Markus Armbruster
Subject: Re: [Qemu-devel] qdev device documentation (Re: [PATCH 0/2] usb-linux: physical port handling.)
Date: Thu, 12 May 2011 18:08:07 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux)

Anthony Liguori <address@hidden> writes:

> On 05/12/2011 10:25 AM, Gerd Hoffmann wrote:
>> Hi,
>>
>>>> What is the status of the qdev documentation patches btw.?
>>>
>>> http://lists.gnu.org/archive/html/qemu-devel/2011-02/msg02169.html
>>
>> What is the problem with the empty strings btw?
>>
>> The only way around I can see is having _DOC and _NODOC versions for all
>> the property macros, but I'd prefer to not have _NODOC macros in the
>> tree ...
>
> Inline documentation is bad.  Our documentation should be
> centralized. That's the only way to keep it consistent and thorough.

External documentation of code details is bad.  Our documentation should
be next to the code.  That's the only way to keep it up-to-date and
consistent with the code.

> There's no way to easily extract the inline docs in a complete way
> since some devices are built conditionally.

For each configured target: extract docs of the devices it builds
Concatenate and discard the duplicates

Yes, that means you don't get docs for devices none of your targets has.
That's a feature.  If you really want docs for all devices, build all
targets.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]