[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH] qemu-ga: Convert invocation documentation to rS
From: |
Peter Maydell |
Subject: |
Re: [Qemu-devel] [PATCH] qemu-ga: Convert invocation documentation to rST |
Date: |
Mon, 10 Jun 2019 15:11:23 +0100 |
On Mon, 10 Jun 2019 at 14:56, Paolo Bonzini <address@hidden> wrote:
>
> On 10/06/19 15:45, Peter Maydell wrote:
> > +# Canned command to build manpages from a single manual
> > +build-manpages = $(call quiet-command,CONFDIR="$(qemu_confdir)"
> > sphinx-build $(if $(V),,-q) -W -n -b man -D version=$(VERSION) -D
> > release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1
> > $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
>
>
> ...
>
> > +# The rst_epilog fragment is effectively included in every rST file.
> > +# We use it to define substitutions based on build config that
> > +# can then be used in the documentation. The fallback if the
> > +# environment variable is not set is for the benefit of readthedocs
> > +# style document building; our Makefile always sets the variable.
> > +confdir = os.getenv('CONFDIR', "/usr/local/etc")
>
> This should be /usr/local/etc/qemu is you want $(qemu_confdir) above and
> not $(sysconfdir).
>
> But since we always set the variable when building from the QEMU build
> system, perhaps "/etc" or "/etc/qemu" is a more useful default when
> building the manual outside QEMU?
Yeah, I wasn't sure what to set this to either...
thanks
-- PMM