Re: [PATCH] build: Build and install the info manual.

[Peter Maydell]

On Fri, 25 Sep 2020 at 07:27, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:
>
> Take advantage of the Sphinx texinfo backend to generate a QEMU info
> manual.  The texinfo format allows for more structure and info readers
> provide more advanced navigation capabilities compared to manpages
> readers.

Not providing an info manual (or indeed any format other than HTML
and manpages) was a deliberate design choice. The rationale is that
checking that multiple document formats all ended up rendering
correctly is more work than people will in practice put in (as
demonstrated by various errors in the old HTML rendering, for
instance).

That said, maybe other people will disagree with me.

> * configure (infodir): Add the --infodir option, which allows
> configuring the directory under which the info manuals are installed.
> * docs/index.rst: Include the top level documents to prevent
> warnings (treated as errors by sphinx-build).

This isn't the right thing. You should be pointing sphinx-build
at each of the individual manuals (system, interop, etc) and
generating one info file for each. This is because we generate
manuals for each of these including the 'devel' manual, but
we don't want to install 'devel', because it's developer-facing
and not needed by end-users of QEMU. If you do that then you
won't find you have problems with the orphan top level documents.

(We really need to move those orphan docs into the right places
in the manual structure at some point.)

> * docs/meson.build (sphinxinfo): Add new target.

You've forgotten your Signed-off-by: line.

thanks
-- PMM