qemu-devel
[Top][All Lists]
Advanced

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

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


From: Peter Maydell
Subject: Re: [PATCH] build: Build and install the info manual.
Date: Sat, 26 Sep 2020 22:34:22 +0100

On Sat, 26 Sep 2020 at 05:36, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:
> > 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.
>
> Is this the only reason individual manuals are being generated?  It
> makes sense for the manpages (which have their own macros), but
> otherwise (for HTML and info) introduces a lot of complexity for not
> much gain, in my opinion.  Users not wanting to know about devel
> internals can simply skip that section; no harm done.

It is the best way we found for getting Sphinx to do what we wanted.
I agree that it would be nicer to have one manual with all the user
facing parts in it, but it is apparently not possible to do that without
shipping the devel docs to users, which we didn't want to do.

thanks
-- PMM



reply via email to

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