Re: [Qemu-devel] [PATCH 0/4] First steps towards documenting qdev devices/options

[Markus Armbruster]

Amit Shah <address@hidden> writes:

> Hello,
>
> This is a rebase of the patchset I'd sent earlier.
>
> I add the 4/4 patch, documenting common block device properties.
> Other than that, the usual notes apply: this is just the start, just
> getting the framework in place and a few examples so that people can
> then pick up and start documenting their devices and options.  We want
> to see all of the devices covered, and hopefully turn on
> build_bug_on() on an empty doc string.
>
> Maintainers should perhaps also look for patches that introduce
> options without documentation.
>
> That's the long-term goal (over 0.14).  For short-term, I'll be
> preparing follow-on patches that add doc strings for a few more
> options and perhaps bug people based on git history as to what
> documentation is to be added for some options.
>
> If this looks acceptable, please apply!

For QMP, we'll need to cover more than just device properties, and in
more detail than just a help text, but this looks like a sensible step
forward.