[PATCH] docs: set CONFDIR when running sphinx

[PATCH] docs: set CONFDIR when running sphinx

[marcandre.lureau]

From: Marc-André Lureau <marcandre.lureau@redhat.com>

The default configuration path /etc/qemu can be overriden with configure
options, and the generated documentation used to reflect it.

Fixes regression introduced in commit
f8aa24ea9a82da38370470c6bc0eaa393999edfe ("meson: sphinx-build").

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1902537
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 docs/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/meson.build b/docs/meson.build
index ebd85d59f9..bb8fe4c9e4 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -9,7 +9,7 @@ endif
 # Check if tools are available to build documentation.
 build_docs = false
 if sphinx_build.found()
-  SPHINX_ARGS = [sphinx_build]
+  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
   # If we're making warnings fatal, apply this to Sphinx runs as well
   if get_option('werror')
     SPHINX_ARGS += [ '-W' ]
-- 
2.29.0

Re: [PATCH] docs: set CONFDIR when running sphinx

[Paolo Bonzini]

On 01/12/20 19:37, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> The default configuration path /etc/qemu can be overriden with configure
> options, and the generated documentation used to reflect it.
> 
> Fixes regression introduced in commit
> f8aa24ea9a82da38370470c6bc0eaa393999edfe ("meson: sphinx-build").
> 
> Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1902537
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>   docs/meson.build | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/meson.build b/docs/meson.build
> index ebd85d59f9..bb8fe4c9e4 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -9,7 +9,7 @@ endif
>   # Check if tools are available to build documentation.
>   build_docs = false
>   if sphinx_build.found()
> -  SPHINX_ARGS = [sphinx_build]
> +  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
>     # If we're making warnings fatal, apply this to Sphinx runs as well
>     if get_option('werror')
>       SPHINX_ARGS += [ '-W' ]
> 

I can queue the patch, but I also wouldn't mind removing support for 
/etc/qemu completely.  I'm not sure why one would use it.  Eduardo?

Re: [PATCH] docs: set CONFDIR when running sphinx

[Eduardo Habkost]

On Wed, Dec 02, 2020 at 10:05:50AM +0100, Paolo Bonzini wrote:
> On 01/12/20 19:37, marcandre.lureau@redhat.com wrote:
> > From: Marc-André Lureau <marcandre.lureau@redhat.com>
> > 
> > The default configuration path /etc/qemu can be overriden with configure
> > options, and the generated documentation used to reflect it.
> > 
> > Fixes regression introduced in commit
> > f8aa24ea9a82da38370470c6bc0eaa393999edfe ("meson: sphinx-build").
> > 
> > Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1902537
> > Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> > ---
> >   docs/meson.build | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/docs/meson.build b/docs/meson.build
> > index ebd85d59f9..bb8fe4c9e4 100644
> > --- a/docs/meson.build
> > +++ b/docs/meson.build
> > @@ -9,7 +9,7 @@ endif
> >   # Check if tools are available to build documentation.
> >   build_docs = false
> >   if sphinx_build.found()
> > -  SPHINX_ARGS = [sphinx_build]
> > +  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
> >     # If we're making warnings fatal, apply this to Sphinx runs as well
> >     if get_option('werror')
> >       SPHINX_ARGS += [ '-W' ]
> > 
> 
> I can queue the patch, but I also wouldn't mind removing support for
> /etc/qemu completely.  I'm not sure why one would use it.  Eduardo?

I agree, and I had a series for this 3 years ago.

I guess I need to my keep my word and finally submit v5 of the series:
https://lore.kernel.org/qemu-devel/20171005123414.GE4015@localhost.localdomain/

-- 
Eduardo

Re: [PATCH] docs: set CONFDIR when running sphinx

[Marc-André Lureau]

[-- Attachment #1: Type: text/plain, Size: 1925 bytes --]

Hi

On Wed, Dec 2, 2020 at 11:55 PM Eduardo Habkost <ehabkost@redhat.com> wrote:

> On Wed, Dec 02, 2020 at 10:05:50AM +0100, Paolo Bonzini wrote:
> > On 01/12/20 19:37, marcandre.lureau@redhat.com wrote:
> > > From: Marc-André Lureau <marcandre.lureau@redhat.com>
> > >
> > > The default configuration path /etc/qemu can be overriden with
> configure
> > > options, and the generated documentation used to reflect it.
> > >
> > > Fixes regression introduced in commit
> > > f8aa24ea9a82da38370470c6bc0eaa393999edfe ("meson: sphinx-build").
> > >
> > > Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1902537
> > > Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> > > ---
> > >   docs/meson.build | 2 +-
> > >   1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/docs/meson.build b/docs/meson.build
> > > index ebd85d59f9..bb8fe4c9e4 100644
> > > --- a/docs/meson.build
> > > +++ b/docs/meson.build
> > > @@ -9,7 +9,7 @@ endif
> > >   # Check if tools are available to build documentation.
> > >   build_docs = false
> > >   if sphinx_build.found()
> > > -  SPHINX_ARGS = [sphinx_build]
> > > +  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
> > >     # If we're making warnings fatal, apply this to Sphinx runs as well
> > >     if get_option('werror')
> > >       SPHINX_ARGS += [ '-W' ]
> > >
> >
> > I can queue the patch, but I also wouldn't mind removing support for
> > /etc/qemu completely.  I'm not sure why one would use it.  Eduardo?
>
> I agree, and I had a series for this 3 years ago.
>
> I guess I need to my keep my word and finally submit v5 of the series:
>
> https://lore.kernel.org/qemu-devel/20171005123414.GE4015@localhost.localdomain/
>

Note that the original bug that prompted this fix is about qemu-ga
configuration though.

Paolo, please queue the patch. thanks!

-- 
Marc-André Lureau

[-- Attachment #2: Type: text/html, Size: 3099 bytes --]

Re: [PATCH] docs: set CONFDIR when running sphinx

[Paolo Bonzini]

On 03/12/20 11:28, Marc-André Lureau wrote:
> Note that the original bug that prompted this fix is about qemu-ga 
> configuration though.
> 
> Paolo, please queue the patch. thanks!

Done.

Paolo