Re: [PATCH v5 00/20] Convert QAPI doc comments to generate rST instead of texinfo

[Peter Maydell]

On Mon, 10 Aug 2020 at 20:50, Peter Maydell <peter.maydell@linaro.org> wrote:
> This series switches all our QAPI doc comments over from
> texinfo format to rST. It then removes all the texinfo
> machinery, because this was the last user of texinfo.
>
> This is largely just a rebase of patchset v4 to current master.

> There are a few things I have left out of this initial series:

I realized there is something I forgot to add to this "left out" list:

Sphinx needs to know what all the input files which go into
a document are, as it builds up dependencies to tell it whether
to rebuild the output or not. The docs/sphinx/qapidoc.py
plugin adds such a dependency on the file that the .rst
docs reference (eg qapi/qapi-schema.json) but it does not
have a mechanism for adding dependencies when that .json
file uses an 'include' to pull in other .json files.

I'm not sure whether the scripts/qapi code supports telling
a consumer of the parsed info about this -- is it sufficient
for QAPISchemaGenRSTVisitor to implement the 'visit_include'
method, find the path to the included .qapi file from the
arguments and call Sphinx's env.notedependency(), or do we
need to do something more complicated to get the list of
all the included .qapi files ?

thanks
-- PMM