| Message ID | 20201015220626.418-4-luoyonggang@gmail.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Fixes docs building on msys2/mingw | expand |
Here is a better way to write the meson test:
if get_option('sphinx_build') == ''
sphinx_build = find_program(['sphinx-build-3', 'sphinx-build'],
required: get_option('docs'))
else
sphinx_build = find_program(get_option('sphinx_build'),
required: get_option('docs'))
endif
SPHINX_ARGS = [sphinx_build]
# If we're making warnings fatal, apply this to Sphinx runs as well
if get_option('werror')
SPHINX_TEST_ARGS += [ '-W' ]
endif
# Check if tools are available to build documentation.
build_docs = false
if sphinx_build.found()
# This is a bit awkward but works: create a trivial document and
# try to run it with our configuration file (which enforces a
# version requirement). This will fail if sphinx-build is too old.
run_command('mkdir', ['-p', tmpdir / 'sphinx'])
run_command('touch', [tmpdir / 'sphinx/index.rst'])
sphinx_build_test_out = run_command(SPHINX_ARGS + [
'-c', meson.current_source_dir() / 'docs',
'-b', 'html', tmpdir / 'sphinx',
tmpdir / 'sphinx/out'])
build_docs = (sphinx_build_test_out.returncode() == 0)
endif
if not build_docs
if sphinx_build_option != ''
warning('@0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option))
endif
if get_option('docs').enabled()
error('Install a Python 3 version of python-sphinx')
endif
endif
On 16/10/20 00:06, Yonggang Luo wrote:
> Signed-off-by: Yonggang Luo <luoyonggang@gmail.com>
> ---
> configure | 59 +++-------------------------------
> docs/meson.build | 4 +--
> meson.build | 60 +++++++++++++++++++++++++++++++----
> meson_options.txt | 5 ++-
> tests/qapi-schema/meson.build | 2 +-
> 5 files changed, 64 insertions(+), 66 deletions(-)
>
> diff --git a/configure b/configure
> index 1ce31f97b4..ff593a8542 100755
> --- a/configure
> +++ b/configure
> @@ -297,7 +297,7 @@ brlapi=""
> curl=""
> iconv="auto"
> curses="auto"
> -docs=""
> +docs="auto"
> fdt="auto"
> netmap="no"
> sdl="auto"
> @@ -822,15 +822,6 @@ do
> fi
> done
>
> -sphinx_build=
> -for binary in sphinx-build-3 sphinx-build
> -do
> - if has "$binary"
> - then
> - sphinx_build=$(command -v "$binary")
> - break
> - fi
> -done
>
> # Check for ancillary tools used in testing
> genisoimage=
> @@ -1226,9 +1217,9 @@ for opt do
> ;;
> --disable-crypto-afalg) crypto_afalg="no"
> ;;
> - --disable-docs) docs="no"
> + --disable-docs) docs="disabled"
> ;;
> - --enable-docs) docs="yes"
> + --enable-docs) docs="enabled"
> ;;
> --disable-vhost-net) vhost_net="no"
> ;;
> @@ -4413,45 +4404,6 @@ if check_include linux/btrfs.h ; then
> btrfs=yes
> fi
>
> -# If we're making warnings fatal, apply this to Sphinx runs as well
> -sphinx_werror=""
> -if test "$werror" = "yes"; then
> - sphinx_werror="-W"
> -fi
> -
> -# Check we have a new enough version of sphinx-build
> -has_sphinx_build() {
> - # This is a bit awkward but works: create a trivial document and
> - # try to run it with our configuration file (which enforces a
> - # version requirement). This will fail if either
> - # sphinx-build doesn't exist at all or if it is too old.
> - mkdir -p "$TMPDIR1/sphinx"
> - touch "$TMPDIR1/sphinx/index.rst"
> - "$sphinx_build" $sphinx_werror -c "$source_path/docs" \
> - -b html "$TMPDIR1/sphinx" \
> - "$TMPDIR1/sphinx/out" >> config.log 2>&1
> -}
> -
> -# Check if tools are available to build documentation.
> -if test "$docs" != "no" ; then
> - if has_sphinx_build; then
> - sphinx_ok=yes
> - else
> - sphinx_ok=no
> - fi
> - if test "$sphinx_ok" = "yes"; then
> - docs=yes
> - else
> - if test "$docs" = "yes" ; then
> - if has $sphinx_build && test "$sphinx_ok" != "yes"; then
> - echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2
> - fi
> - feature_not_found "docs" "Install a Python 3 version of python-sphinx"
> - fi
> - docs=no
> - fi
> -fi
> -
> # Search for bswap_32 function
> byteswap_h=no
> cat > $TMPC << EOF
> @@ -6087,9 +6039,6 @@ qemu_version=$(head $source_path/VERSION)
> echo "PKGVERSION=$pkgversion" >>$config_host_mak
> echo "SRC_PATH=$source_path" >> $config_host_mak
> echo "TARGET_DIRS=$target_list" >> $config_host_mak
> -if [ "$docs" = "yes" ] ; then
> - echo "BUILD_DOCS=yes" >> $config_host_mak
> -fi
> if test "$modules" = "yes"; then
> # $shacmd can generate a hash started with digit, which the compiler doesn't
> # like as an symbol. So prefix it with an underscore
> @@ -6794,7 +6743,6 @@ fi
> echo "ROMS=$roms" >> $config_host_mak
> echo "MAKE=$make" >> $config_host_mak
> echo "PYTHON=$python" >> $config_host_mak
> -echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak
> echo "GENISOIMAGE=$genisoimage" >> $config_host_mak
> echo "MESON=$meson" >> $config_host_mak
> echo "CC=$cc" >> $config_host_mak
> @@ -7076,6 +7024,7 @@ NINJA=${ninja:-$PWD/ninjatool} $meson setup \
> -Dgettext=$gettext -Dxkbcommon=$xkbcommon -Du2f=$u2f \
> -Dcapstone=$capstone -Dslirp=$slirp -Dfdt=$fdt \
> -Diconv=$iconv -Dcurses=$curses \
> + -Ddocs=$docs -Dsphinx_build=$sphinx_build \
> $cross_arg \
> "$PWD" "$source_path"
>
> diff --git a/docs/meson.build b/docs/meson.build
> index 0340d489ac..f566809a6a 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -37,7 +37,7 @@ if build_docs
> input: [files('conf.py'), files(manual / 'conf.py')],
> depfile: manual + '.d',
> depend_files: sphinx_extn_depends,
> - command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@',
> + command: SPHINX_ARGS + ['-Ddepfile=@DEPFILE@',
> '-Ddepfile_stamp=@OUTPUT0@',
> '-b', 'html', '-d', private_dir,
> input_dir, output_dir])
> @@ -59,7 +59,7 @@ if build_docs
> input: this_manual,
> install: build_docs,
> install_dir: install_dirs,
> - command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir,
> + command: SPHINX_ARGS + ['-b', 'man', '-d', private_dir,
> input_dir, meson.current_build_dir()])
> endif
> endforeach
> diff --git a/meson.build b/meson.build
> index 8156df8b71..8940468208 100644
> --- a/meson.build
> +++ b/meson.build
> @@ -17,7 +17,13 @@ cc = meson.get_compiler('c')
> config_host = keyval.load(meson.current_build_dir() / 'config-host.mak')
> enable_modules = 'CONFIG_MODULES' in config_host
> enable_static = 'CONFIG_STATIC' in config_host
> -build_docs = 'BUILD_DOCS' in config_host
> +
> +# Temporary directory used for files created while
> +# configure runs. Since it is in the build directory
> +# we can safely blow away any previous version of it
> +# (and we need not jump through hoops to try to delete
> +# it when configure exits.)
> +tmpdir = meson.current_build_dir() / 'config-temp'
>
> if get_option('qemu_suffix').startswith('/')
> error('qemu_suffix cannot start with a /')
> @@ -1235,12 +1241,52 @@ foreach d : hx_headers
> endforeach
> genh += hxdep
>
> -SPHINX_ARGS = [config_host['SPHINX_BUILD'],
> - '-Dversion=' + meson.project_version(),
> - '-Drelease=' + config_host['PKGVERSION']]
> +sphinx_build = not_found
> +sphinx_build_option = get_option('sphinx_build')
> +if sphinx_build_option == ''
> + sphinx_build = find_program('sphinx-build', required: false)
> +else
> + sphinx_build = find_program(sphinx_build_option, required: false)
> +endif
>
> +SPHINX_TEST_ARGS = []
> +# If we're making warnings fatal, apply this to Sphinx runs as well
> if get_option('werror')
> - SPHINX_ARGS += [ '-W' ]
> + SPHINX_TEST_ARGS += [ '-W' ]
> +endif
> +
> +build_docs = false
> +docs_option = get_option('docs')
> +# Check if tools are available to build documentation.
> +if sphinx_build.found() and not docs_option.disabled()
> + # This is a bit awkward but works: create a trivial document and
> + # try to run it with our configuration file (which enforces a
> + # version requirement). This will fail if either
> + # sphinx-build doesn't exist at all or if it is too old.
> + run_command('mkdir', ['-p', tmpdir / 'sphinx'])
> + run_command('touch', [tmpdir / 'sphinx/index.rst'])
> + sphinx_build_test_out = run_command(sphinx_build, SPHINX_TEST_ARGS + [
> + '-c', meson.current_source_dir() / 'docs',
> + '-b', 'html', tmpdir / 'sphinx',
> + tmpdir / 'sphinx/out'])
> + if sphinx_build_test_out.returncode() == 0
> + build_docs = true
> + else
> + if docs_option.enabled()
> + if sphinx_build_option != ''
> + warning('Warning: @0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option))
> + endif
> + error('Warning: Install a Python 3 version of python-sphinx')
> + endif
> + # do not building docs
> + endif
> +endif
> +
> +SPHINX_ARGS = []
> +if build_docs
> + SPHINX_ARGS = [sphinx_build]
> + SPHINX_ARGS += SPHINX_TEST_ARGS
> + SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']]
> endif
>
> sphinx_extn_depends = [ meson.source_root() / 'docs/sphinx/depfile.py',
> @@ -1918,7 +1964,7 @@ summary_info += {'QEMU_CFLAGS': config_host['QEMU_CFLAGS']}
> summary_info += {'QEMU_LDFLAGS': config_host['QEMU_LDFLAGS']}
> summary_info += {'make': config_host['MAKE']}
> summary_info += {'python': '@0@ (version: @1@)'.format(python.full_path(), python.language_version())}
> -summary_info += {'sphinx-build': config_host['SPHINX_BUILD']}
> +summary_info += {'sphinx-build': sphinx_build.found()}
> summary_info += {'genisoimage': config_host['GENISOIMAGE']}
> # TODO: add back version
> summary_info += {'slirp support': slirp_opt == 'disabled' ? false : slirp_opt}
> @@ -1986,7 +2032,7 @@ if config_host.has_key('CONFIG_XEN_BACKEND')
> summary_info += {'xen ctrl version': config_host['CONFIG_XEN_CTRL_INTERFACE_VERSION']}
> endif
> summary_info += {'brlapi support': config_host.has_key('CONFIG_BRLAPI')}
> -summary_info += {'Documentation': config_host.has_key('BUILD_DOCS')}
> +summary_info += {'Documentation': build_docs}
> summary_info += {'PIE': get_option('b_pie')}
> summary_info += {'vde support': config_host.has_key('CONFIG_VDE')}
> summary_info += {'netmap support': config_host.has_key('CONFIG_NETMAP')}
> diff --git a/meson_options.txt b/meson_options.txt
> index e6cb1e589b..0e3fa7136b 100644
> --- a/meson_options.txt
> +++ b/meson_options.txt
> @@ -1,8 +1,11 @@
> option('qemu_suffix', type : 'string', value: 'qemu',
> description: 'Suffix for QEMU data/modules/config directories (can be empty)')
> +option('docs', type : 'feature', value : 'auto',
> + description: 'Documentations build support')
> option('docdir', type : 'string', value : 'doc',
> description: 'Base directory for documentation installation (can be empty)')
> -
> +option('sphinx_build', type : 'string', value : '',
> + description: 'Use specified sphinx-build [$sphinx_build] for building document (default to be empty)')
> option('gettext', type : 'boolean', value : true,
> description: 'Localization of the GTK+ user interface')
> option('sparse', type : 'feature', value : 'auto',
> diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build
> index 1f222a7a13..961b8367a9 100644
> --- a/tests/qapi-schema/meson.build
> +++ b/tests/qapi-schema/meson.build
> @@ -237,7 +237,7 @@ qapi_doc_out = custom_target('QAPI rST doc',
> # we want it to always really run the QAPI doc
> # generation code. It also means we don't
> # clutter up the build dir with the cache.
> - command: [SPHINX_ARGS,
> + command: SPHINX_ARGS + [
> '-b', 'text', '-E',
> '-c', meson.source_root() / 'docs',
> '-D', 'master_doc=doc-good',
>
On Fri, Oct 16, 2020 at 3:46 PM Paolo Bonzini <pbonzini@redhat.com> wrote: > > Here is a better way to write the meson test: > > if get_option('sphinx_build') == '' > sphinx_build = find_program(['sphinx-build-3', 'sphinx-build'], > required: get_option('docs')) > else > sphinx_build = find_program(get_option('sphinx_build'), > required: get_option('docs')) > endif > > SPHINX_ARGS = [sphinx_build] > # If we're making warnings fatal, apply this to Sphinx runs as well > if get_option('werror') > SPHINX_TEST_ARGS += [ '-W' ] > endif > > # Check if tools are available to build documentation. > build_docs = false > if sphinx_build.found() > # This is a bit awkward but works: create a trivial document and > # try to run it with our configuration file (which enforces a > # version requirement). This will fail if sphinx-build is too old. > run_command('mkdir', ['-p', tmpdir / 'sphinx']) > run_command('touch', [tmpdir / 'sphinx/index.rst']) > sphinx_build_test_out = run_command(SPHINX_ARGS + [ > '-c', meson.current_source_dir() / 'docs', > '-b', 'html', tmpdir / 'sphinx', > tmpdir / 'sphinx/out']) > build_docs = (sphinx_build_test_out.returncode() == 0) > endif There is subtle error here, when sphinx_build not found, there is SPHINX_ARGS should be [], otherwise, latter place using SPHINX_ARGS have not found sphinx_build will cause error by meson .. I'll add else SPHINX_ARGS = [] endif > > if not build_docs > if sphinx_build_option != '' > warning('@0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option)) > endif > if get_option('docs').enabled() > error('Install a Python 3 version of python-sphinx') > endif > endif > > > > On 16/10/20 00:06, Yonggang Luo wrote: > > Signed-off-by: Yonggang Luo <luoyonggang@gmail.com> > > --- > > configure | 59 +++------------------------------- > > docs/meson.build | 4 +-- > > meson.build | 60 +++++++++++++++++++++++++++++++---- > > meson_options.txt | 5 ++- > > tests/qapi-schema/meson.build | 2 +- > > 5 files changed, 64 insertions(+), 66 deletions(-) > > > > diff --git a/configure b/configure > > index 1ce31f97b4..ff593a8542 100755 > > --- a/configure > > +++ b/configure > > @@ -297,7 +297,7 @@ brlapi="" > > curl="" > > iconv="auto" > > curses="auto" > > -docs="" > > +docs="auto" > > fdt="auto" > > netmap="no" > > sdl="auto" > > @@ -822,15 +822,6 @@ do > > fi > > done > > > > -sphinx_build= > > -for binary in sphinx-build-3 sphinx-build > > -do > > - if has "$binary" > > - then > > - sphinx_build=$(command -v "$binary") > > - break > > - fi > > -done > > > > # Check for ancillary tools used in testing > > genisoimage= > > @@ -1226,9 +1217,9 @@ for opt do > > ;; > > --disable-crypto-afalg) crypto_afalg="no" > > ;; > > - --disable-docs) docs="no" > > + --disable-docs) docs="disabled" > > ;; > > - --enable-docs) docs="yes" > > + --enable-docs) docs="enabled" > > ;; > > --disable-vhost-net) vhost_net="no" > > ;; > > @@ -4413,45 +4404,6 @@ if check_include linux/btrfs.h ; then > > btrfs=yes > > fi > > > > -# If we're making warnings fatal, apply this to Sphinx runs as well > > -sphinx_werror="" > > -if test "$werror" = "yes"; then > > - sphinx_werror="-W" > > -fi > > - > > -# Check we have a new enough version of sphinx-build > > -has_sphinx_build() { > > - # This is a bit awkward but works: create a trivial document and > > - # try to run it with our configuration file (which enforces a > > - # version requirement). This will fail if either > > - # sphinx-build doesn't exist at all or if it is too old. > > - mkdir -p "$TMPDIR1/sphinx" > > - touch "$TMPDIR1/sphinx/index.rst" > > - "$sphinx_build" $sphinx_werror -c "$source_path/docs" \ > > - -b html "$TMPDIR1/sphinx" \ > > - "$TMPDIR1/sphinx/out" >> config.log 2>&1 > > -} > > - > > -# Check if tools are available to build documentation. > > -if test "$docs" != "no" ; then > > - if has_sphinx_build; then > > - sphinx_ok=yes > > - else > > - sphinx_ok=no > > - fi > > - if test "$sphinx_ok" = "yes"; then > > - docs=yes > > - else > > - if test "$docs" = "yes" ; then > > - if has $sphinx_build && test "$sphinx_ok" != "yes"; then > > - echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2 > > - fi > > - feature_not_found "docs" "Install a Python 3 version of python-sphinx" > > - fi > > - docs=no > > - fi > > -fi > > - > > # Search for bswap_32 function > > byteswap_h=no > > cat > $TMPC << EOF > > @@ -6087,9 +6039,6 @@ qemu_version=$(head $source_path/VERSION) > > echo "PKGVERSION=$pkgversion" >>$config_host_mak > > echo "SRC_PATH=$source_path" >> $config_host_mak > > echo "TARGET_DIRS=$target_list" >> $config_host_mak > > -if [ "$docs" = "yes" ] ; then > > - echo "BUILD_DOCS=yes" >> $config_host_mak > > -fi > > if test "$modules" = "yes"; then > > # $shacmd can generate a hash started with digit, which the compiler doesn't > > # like as an symbol. So prefix it with an underscore > > @@ -6794,7 +6743,6 @@ fi > > echo "ROMS=$roms" >> $config_host_mak > > echo "MAKE=$make" >> $config_host_mak > > echo "PYTHON=$python" >> $config_host_mak > > -echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak > > echo "GENISOIMAGE=$genisoimage" >> $config_host_mak > > echo "MESON=$meson" >> $config_host_mak > > echo "CC=$cc" >> $config_host_mak > > @@ -7076,6 +7024,7 @@ NINJA=${ninja:-$PWD/ninjatool} $meson setup \ > > -Dgettext=$gettext -Dxkbcommon=$xkbcommon -Du2f=$u2f \ > > -Dcapstone=$capstone -Dslirp=$slirp -Dfdt=$fdt \ > > -Diconv=$iconv -Dcurses=$curses \ > > + -Ddocs=$docs -Dsphinx_build=$sphinx_build \ > > $cross_arg \ > > "$PWD" "$source_path" > > > > diff --git a/docs/meson.build b/docs/meson.build > > index 0340d489ac..f566809a6a 100644 > > --- a/docs/meson.build > > +++ b/docs/meson.build > > @@ -37,7 +37,7 @@ if build_docs > > input: [files('conf.py'), files(manual / 'conf.py')], > > depfile: manual + '.d', > > depend_files: sphinx_extn_depends, > > - command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@', > > + command: SPHINX_ARGS + ['-Ddepfile=@DEPFILE@', > > '-Ddepfile_stamp=@OUTPUT0@', > > '-b', 'html', '-d', private_dir, > > input_dir, output_dir]) > > @@ -59,7 +59,7 @@ if build_docs > > input: this_manual, > > install: build_docs, > > install_dir: install_dirs, > > - command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir, > > + command: SPHINX_ARGS + ['-b', 'man', '-d', private_dir, > > input_dir, meson.current_build_dir()]) > > endif > > endforeach > > diff --git a/meson.build b/meson.build > > index 8156df8b71..8940468208 100644 > > --- a/meson.build > > +++ b/meson.build > > @@ -17,7 +17,13 @@ cc = meson.get_compiler('c') > > config_host = keyval.load(meson.current_build_dir() / 'config-host.mak') > > enable_modules = 'CONFIG_MODULES' in config_host > > enable_static = 'CONFIG_STATIC' in config_host > > -build_docs = 'BUILD_DOCS' in config_host > > + > > +# Temporary directory used for files created while > > +# configure runs. Since it is in the build directory > > +# we can safely blow away any previous version of it > > +# (and we need not jump through hoops to try to delete > > +# it when configure exits.) > > +tmpdir = meson.current_build_dir() / 'config-temp' > > > > if get_option('qemu_suffix').startswith('/') > > error('qemu_suffix cannot start with a /') > > @@ -1235,12 +1241,52 @@ foreach d : hx_headers > > endforeach > > genh += hxdep > > > > -SPHINX_ARGS = [config_host['SPHINX_BUILD'], > > - '-Dversion=' + meson.project_version(), > > - '-Drelease=' + config_host['PKGVERSION']] > > +sphinx_build = not_found > > +sphinx_build_option = get_option('sphinx_build') > > +if sphinx_build_option == '' > > + sphinx_build = find_program('sphinx-build', required: false) > > +else > > + sphinx_build = find_program(sphinx_build_option, required: false) > > +endif > > > > +SPHINX_TEST_ARGS = [] > > +# If we're making warnings fatal, apply this to Sphinx runs as well > > if get_option('werror') > > - SPHINX_ARGS += [ '-W' ] > > + SPHINX_TEST_ARGS += [ '-W' ] > > +endif > > + > > +build_docs = false > > +docs_option = get_option('docs') > > +# Check if tools are available to build documentation. > > +if sphinx_build.found() and not docs_option.disabled() > > + # This is a bit awkward but works: create a trivial document and > > + # try to run it with our configuration file (which enforces a > > + # version requirement). This will fail if either > > + # sphinx-build doesn't exist at all or if it is too old. > > + run_command('mkdir', ['-p', tmpdir / 'sphinx']) > > + run_command('touch', [tmpdir / 'sphinx/index.rst']) > > + sphinx_build_test_out = run_command(sphinx_build, SPHINX_TEST_ARGS + [ > > + '-c', meson.current_source_dir() / 'docs', > > + '-b', 'html', tmpdir / 'sphinx', > > + tmpdir / 'sphinx/out']) > > + if sphinx_build_test_out.returncode() == 0 > > + build_docs = true > > + else > > + if docs_option.enabled() > > + if sphinx_build_option != '' > > + warning('Warning: @0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option)) > > + endif > > + error('Warning: Install a Python 3 version of python-sphinx') > > + endif > > + # do not building docs > > + endif > > +endif > > + > > +SPHINX_ARGS = [] > > +if build_docs > > + SPHINX_ARGS = [sphinx_build] > > + SPHINX_ARGS += SPHINX_TEST_ARGS > > + SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']] > > endif > > > > sphinx_extn_depends = [ meson.source_root() / 'docs/sphinx/depfile.py', > > @@ -1918,7 +1964,7 @@ summary_info += {'QEMU_CFLAGS': config_host['QEMU_CFLAGS']} > > summary_info += {'QEMU_LDFLAGS': config_host['QEMU_LDFLAGS']} > > summary_info += {'make': config_host['MAKE']} > > summary_info += {'python': '@0@ (version: @1@)'.format(python.full_path(), python.language_version())} > > -summary_info += {'sphinx-build': config_host['SPHINX_BUILD']} > > +summary_info += {'sphinx-build': sphinx_build.found()} > > summary_info += {'genisoimage': config_host['GENISOIMAGE']} > > # TODO: add back version > > summary_info += {'slirp support': slirp_opt == 'disabled' ? false : slirp_opt} > > @@ -1986,7 +2032,7 @@ if config_host.has_key('CONFIG_XEN_BACKEND') > > summary_info += {'xen ctrl version': config_host['CONFIG_XEN_CTRL_INTERFACE_VERSION']} > > endif > > summary_info += {'brlapi support': config_host.has_key('CONFIG_BRLAPI')} > > -summary_info += {'Documentation': config_host.has_key('BUILD_DOCS')} > > +summary_info += {'Documentation': build_docs} > > summary_info += {'PIE': get_option('b_pie')} > > summary_info += {'vde support': config_host.has_key('CONFIG_VDE')} > > summary_info += {'netmap support': config_host.has_key('CONFIG_NETMAP')} > > diff --git a/meson_options.txt b/meson_options.txt > > index e6cb1e589b..0e3fa7136b 100644 > > --- a/meson_options.txt > > +++ b/meson_options.txt > > @@ -1,8 +1,11 @@ > > option('qemu_suffix', type : 'string', value: 'qemu', > > description: 'Suffix for QEMU data/modules/config directories (can be empty)') > > +option('docs', type : 'feature', value : 'auto', > > + description: 'Documentations build support') > > option('docdir', type : 'string', value : 'doc', > > description: 'Base directory for documentation installation (can be empty)') > > - > > +option('sphinx_build', type : 'string', value : '', > > + description: 'Use specified sphinx-build [$sphinx_build] for building document (default to be empty)') > > option('gettext', type : 'boolean', value : true, > > description: 'Localization of the GTK+ user interface') > > option('sparse', type : 'feature', value : 'auto', > > diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build > > index 1f222a7a13..961b8367a9 100644 > > --- a/tests/qapi-schema/meson.build > > +++ b/tests/qapi-schema/meson.build > > @@ -237,7 +237,7 @@ qapi_doc_out = custom_target('QAPI rST doc', > > # we want it to always really run the QAPI doc > > # generation code. It also means we don't > > # clutter up the build dir with the cache. > > - command: [SPHINX_ARGS, > > + command: SPHINX_ARGS + [ > > '-b', 'text', '-E', > > '-c', meson.source_root() / 'docs', > > '-D', 'master_doc=doc-good', > > > -- 此致 礼 罗勇刚 Yours sincerely, Yonggang Luo <div dir="ltr"><br><br>On Fri, Oct 16, 2020 at 3:46 PM Paolo Bonzini <<a href="mailto:pbonzini@redhat.com">pbonzini@redhat.com</a>> wrote:<br>><br>> Here is a better way to write the meson test:<br>><br>> if get_option('sphinx_build') == ''<br>> sphinx_build = find_program(['sphinx-build-3', 'sphinx-build'],<br>> required: get_option('docs'))<br>> else<br>> sphinx_build = find_program(get_option('sphinx_build'),<br>> required: get_option('docs'))<br>> endif<br>><br>> SPHINX_ARGS = [sphinx_build]<br>> # If we're making warnings fatal, apply this to Sphinx runs as well<br>> if get_option('werror')<br>> SPHINX_TEST_ARGS += [ '-W' ]<br>> endif<br>><br>> # Check if tools are available to build documentation.<br>> build_docs = false<br>> if sphinx_build.found()<br>> # This is a bit awkward but works: create a trivial document and<br>> # try to run it with our configuration file (which enforces a<br>> # version requirement). This will fail if sphinx-build is too old.<br>> run_command('mkdir', ['-p', tmpdir / 'sphinx'])<br>> run_command('touch', [tmpdir / 'sphinx/index.rst'])<br>> sphinx_build_test_out = run_command(SPHINX_ARGS + [<br>> '-c', meson.current_source_dir() / 'docs',<br>> '-b', 'html', tmpdir / 'sphinx',<br>> tmpdir / 'sphinx/out'])<br>> build_docs = (sphinx_build_test_out.returncode() == 0)<br>> endif<br>There is subtle error here, when sphinx_build not found, there is SPHINX_ARGS should be [],<div>otherwise, latter place using SPHINX_ARGS have not found sphinx_build will cause error by meson</div><div>..</div><div>I'll add</div><div><br></div><div>else</div><div> SPHINX_ARGS = [] <br></div><div>endif</div><div><br>><br>> if not build_docs<br>> if sphinx_build_option != ''<br>> warning('@0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option))<br>> endif<br>> if get_option('docs').enabled()<br>> error('Install a Python 3 version of python-sphinx')<br>> endif<br>> endif<br>><br>><br>><br>> On 16/10/20 00:06, Yonggang Luo wrote:<br>> > Signed-off-by: Yonggang Luo <<a href="mailto:luoyonggang@gmail.com">luoyonggang@gmail.com</a>><br>> > ---<br>> > configure | 59 +++-------------------------------<br>> > docs/meson.build | 4 +--<br>> > meson.build | 60 +++++++++++++++++++++++++++++++----<br>> > meson_options.txt | 5 ++-<br>> > tests/qapi-schema/meson.build | 2 +-<br>> > 5 files changed, 64 insertions(+), 66 deletions(-)<br>> ><br>> > diff --git a/configure b/configure<br>> > index 1ce31f97b4..ff593a8542 100755<br>> > --- a/configure<br>> > +++ b/configure<br>> > @@ -297,7 +297,7 @@ brlapi=""<br>> > curl=""<br>> > iconv="auto"<br>> > curses="auto"<br>> > -docs=""<br>> > +docs="auto"<br>> > fdt="auto"<br>> > netmap="no"<br>> > sdl="auto"<br>> > @@ -822,15 +822,6 @@ do<br>> > fi<br>> > done<br>> ><br>> > -sphinx_build=<br>> > -for binary in sphinx-build-3 sphinx-build<br>> > -do<br>> > - if has "$binary"<br>> > - then<br>> > - sphinx_build=$(command -v "$binary")<br>> > - break<br>> > - fi<br>> > -done<br>> ><br>> > # Check for ancillary tools used in testing<br>> > genisoimage=<br>> > @@ -1226,9 +1217,9 @@ for opt do<br>> > ;;<br>> > --disable-crypto-afalg) crypto_afalg="no"<br>> > ;;<br>> > - --disable-docs) docs="no"<br>> > + --disable-docs) docs="disabled"<br>> > ;;<br>> > - --enable-docs) docs="yes"<br>> > + --enable-docs) docs="enabled"<br>> > ;;<br>> > --disable-vhost-net) vhost_net="no"<br>> > ;;<br>> > @@ -4413,45 +4404,6 @@ if check_include linux/btrfs.h ; then<br>> > btrfs=yes<br>> > fi<br>> ><br>> > -# If we're making warnings fatal, apply this to Sphinx runs as well<br>> > -sphinx_werror=""<br>> > -if test "$werror" = "yes"; then<br>> > - sphinx_werror="-W"<br>> > -fi<br>> > -<br>> > -# Check we have a new enough version of sphinx-build<br>> > -has_sphinx_build() {<br>> > - # This is a bit awkward but works: create a trivial document and<br>> > - # try to run it with our configuration file (which enforces a<br>> > - # version requirement). This will fail if either<br>> > - # sphinx-build doesn't exist at all or if it is too old.<br>> > - mkdir -p "$TMPDIR1/sphinx"<br>> > - touch "$TMPDIR1/sphinx/index.rst"<br>> > - "$sphinx_build" $sphinx_werror -c "$source_path/docs" \<br>> > - -b html "$TMPDIR1/sphinx" \<br>> > - "$TMPDIR1/sphinx/out" >> config.log 2>&1<br>> > -}<br>> > -<br>> > -# Check if tools are available to build documentation.<br>> > -if test "$docs" != "no" ; then<br>> > - if has_sphinx_build; then<br>> > - sphinx_ok=yes<br>> > - else<br>> > - sphinx_ok=no<br>> > - fi<br>> > - if test "$sphinx_ok" = "yes"; then<br>> > - docs=yes<br>> > - else<br>> > - if test "$docs" = "yes" ; then<br>> > - if has $sphinx_build && test "$sphinx_ok" != "yes"; then<br>> > - echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2<br>> > - fi<br>> > - feature_not_found "docs" "Install a Python 3 version of python-sphinx"<br>> > - fi<br>> > - docs=no<br>> > - fi<br>> > -fi<br>> > -<br>> > # Search for bswap_32 function<br>> > byteswap_h=no<br>> > cat > $TMPC << EOF<br>> > @@ -6087,9 +6039,6 @@ qemu_version=$(head $source_path/VERSION)<br>> > echo "PKGVERSION=$pkgversion" >>$config_host_mak<br>> > echo "SRC_PATH=$source_path" >> $config_host_mak<br>> > echo "TARGET_DIRS=$target_list" >> $config_host_mak<br>> > -if [ "$docs" = "yes" ] ; then<br>> > - echo "BUILD_DOCS=yes" >> $config_host_mak<br>> > -fi<br>> > if test "$modules" = "yes"; then<br>> > # $shacmd can generate a hash started with digit, which the compiler doesn't<br>> > # like as an symbol. So prefix it with an underscore<br>> > @@ -6794,7 +6743,6 @@ fi<br>> > echo "ROMS=$roms" >> $config_host_mak<br>> > echo "MAKE=$make" >> $config_host_mak<br>> > echo "PYTHON=$python" >> $config_host_mak<br>> > -echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak<br>> > echo "GENISOIMAGE=$genisoimage" >> $config_host_mak<br>> > echo "MESON=$meson" >> $config_host_mak<br>> > echo "CC=$cc" >> $config_host_mak<br>> > @@ -7076,6 +7024,7 @@ NINJA=${ninja:-$PWD/ninjatool} $meson setup \<br>> > -Dgettext=$gettext -Dxkbcommon=$xkbcommon -Du2f=$u2f \<br>> > -Dcapstone=$capstone -Dslirp=$slirp -Dfdt=$fdt \<br>> > -Diconv=$iconv -Dcurses=$curses \<br>> > + -Ddocs=$docs -Dsphinx_build=$sphinx_build \<br>> > $cross_arg \<br>> > "$PWD" "$source_path"<br>> ><br>> > diff --git a/docs/meson.build b/docs/meson.build<br>> > index 0340d489ac..f566809a6a 100644<br>> > --- a/docs/meson.build<br>> > +++ b/docs/meson.build<br>> > @@ -37,7 +37,7 @@ if build_docs<br>> > input: [files('conf.py'), files(manual / 'conf.py')],<br>> > depfile: manual + '.d',<br>> > depend_files: sphinx_extn_depends,<br>> > - command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@',<br>> > + command: SPHINX_ARGS + ['-Ddepfile=@DEPFILE@',<br>> > '-Ddepfile_stamp=@OUTPUT0@',<br>> > '-b', 'html', '-d', private_dir,<br>> > input_dir, output_dir])<br>> > @@ -59,7 +59,7 @@ if build_docs<br>> > input: this_manual,<br>> > install: build_docs,<br>> > install_dir: install_dirs,<br>> > - command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir,<br>> > + command: SPHINX_ARGS + ['-b', 'man', '-d', private_dir,<br>> > input_dir, meson.current_build_dir()])<br>> > endif<br>> > endforeach<br>> > diff --git a/meson.build b/meson.build<br>> > index 8156df8b71..8940468208 100644<br>> > --- a/meson.build<br>> > +++ b/meson.build<br>> > @@ -17,7 +17,13 @@ cc = meson.get_compiler('c')<br>> > config_host = keyval.load(meson.current_build_dir() / 'config-host.mak')<br>> > enable_modules = 'CONFIG_MODULES' in config_host<br>> > enable_static = 'CONFIG_STATIC' in config_host<br>> > -build_docs = 'BUILD_DOCS' in config_host<br>> > +<br>> > +# Temporary directory used for files created while<br>> > +# configure runs. Since it is in the build directory<br>> > +# we can safely blow away any previous version of it<br>> > +# (and we need not jump through hoops to try to delete<br>> > +# it when configure exits.)<br>> > +tmpdir = meson.current_build_dir() / 'config-temp'<br>> ><br>> > if get_option('qemu_suffix').startswith('/')<br>> > error('qemu_suffix cannot start with a /')<br>> > @@ -1235,12 +1241,52 @@ foreach d : hx_headers<br>> > endforeach<br>> > genh += hxdep<br>> ><br>> > -SPHINX_ARGS = [config_host['SPHINX_BUILD'],<br>> > - '-Dversion=' + meson.project_version(),<br>> > - '-Drelease=' + config_host['PKGVERSION']]<br>> > +sphinx_build = not_found<br>> > +sphinx_build_option = get_option('sphinx_build')<br>> > +if sphinx_build_option == ''<br>> > + sphinx_build = find_program('sphinx-build', required: false)<br>> > +else<br>> > + sphinx_build = find_program(sphinx_build_option, required: false)<br>> > +endif<br>> ><br>> > +SPHINX_TEST_ARGS = []<br>> > +# If we're making warnings fatal, apply this to Sphinx runs as well<br>> > if get_option('werror')<br>> > - SPHINX_ARGS += [ '-W' ]<br>> > + SPHINX_TEST_ARGS += [ '-W' ]<br>> > +endif<br>> > +<br>> > +build_docs = false<br>> > +docs_option = get_option('docs')<br>> > +# Check if tools are available to build documentation.<br>> > +if sphinx_build.found() and not docs_option.disabled()<br>> > + # This is a bit awkward but works: create a trivial document and<br>> > + # try to run it with our configuration file (which enforces a<br>> > + # version requirement). This will fail if either<br>> > + # sphinx-build doesn't exist at all or if it is too old.<br>> > + run_command('mkdir', ['-p', tmpdir / 'sphinx'])<br>> > + run_command('touch', [tmpdir / 'sphinx/index.rst'])<br>> > + sphinx_build_test_out = run_command(sphinx_build, SPHINX_TEST_ARGS + [<br>> > + '-c', meson.current_source_dir() / 'docs',<br>> > + '-b', 'html', tmpdir / 'sphinx',<br>> > + tmpdir / 'sphinx/out'])<br>> > + if sphinx_build_test_out.returncode() == 0<br>> > + build_docs = true<br>> > + else<br>> > + if docs_option.enabled()<br>> > + if sphinx_build_option != ''<br>> > + warning('Warning: @0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option))<br>> > + endif<br>> > + error('Warning: Install a Python 3 version of python-sphinx')<br>> > + endif<br>> > + # do not building docs<br>> > + endif<br>> > +endif<br>> > +<br>> > +SPHINX_ARGS = []<br>> > +if build_docs<br>> > + SPHINX_ARGS = [sphinx_build]<br>> > + SPHINX_ARGS += SPHINX_TEST_ARGS<br>> > + SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']]<br>> > endif<br>> ><br>> > sphinx_extn_depends = [ meson.source_root() / 'docs/sphinx/depfile.py',<br>> > @@ -1918,7 +1964,7 @@ summary_info += {'QEMU_CFLAGS': config_host['QEMU_CFLAGS']}<br>> > summary_info += {'QEMU_LDFLAGS': config_host['QEMU_LDFLAGS']}<br>> > summary_info += {'make': config_host['MAKE']}<br>> > summary_info += {'python': '@0@ (version: @1@)'.format(python.full_path(), python.language_version())}<br>> > -summary_info += {'sphinx-build': config_host['SPHINX_BUILD']}<br>> > +summary_info += {'sphinx-build': sphinx_build.found()}<br>> > summary_info += {'genisoimage': config_host['GENISOIMAGE']}<br>> > # TODO: add back version<br>> > summary_info += {'slirp support': slirp_opt == 'disabled' ? false : slirp_opt}<br>> > @@ -1986,7 +2032,7 @@ if config_host.has_key('CONFIG_XEN_BACKEND')<br>> > summary_info += {'xen ctrl version': config_host['CONFIG_XEN_CTRL_INTERFACE_VERSION']}<br>> > endif<br>> > summary_info += {'brlapi support': config_host.has_key('CONFIG_BRLAPI')}<br>> > -summary_info += {'Documentation': config_host.has_key('BUILD_DOCS')}<br>> > +summary_info += {'Documentation': build_docs}<br>> > summary_info += {'PIE': get_option('b_pie')}<br>> > summary_info += {'vde support': config_host.has_key('CONFIG_VDE')}<br>> > summary_info += {'netmap support': config_host.has_key('CONFIG_NETMAP')}<br>> > diff --git a/meson_options.txt b/meson_options.txt<br>> > index e6cb1e589b..0e3fa7136b 100644<br>> > --- a/meson_options.txt<br>> > +++ b/meson_options.txt<br>> > @@ -1,8 +1,11 @@<br>> > option('qemu_suffix', type : 'string', value: 'qemu',<br>> > description: 'Suffix for QEMU data/modules/config directories (can be empty)')<br>> > +option('docs', type : 'feature', value : 'auto',<br>> > + description: 'Documentations build support')<br>> > option('docdir', type : 'string', value : 'doc',<br>> > description: 'Base directory for documentation installation (can be empty)')<br>> > -<br>> > +option('sphinx_build', type : 'string', value : '',<br>> > + description: 'Use specified sphinx-build [$sphinx_build] for building document (default to be empty)')<br>> > option('gettext', type : 'boolean', value : true,<br>> > description: 'Localization of the GTK+ user interface')<br>> > option('sparse', type : 'feature', value : 'auto',<br>> > diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build<br>> > index 1f222a7a13..961b8367a9 100644<br>> > --- a/tests/qapi-schema/meson.build<br>> > +++ b/tests/qapi-schema/meson.build<br>> > @@ -237,7 +237,7 @@ qapi_doc_out = custom_target('QAPI rST doc',<br>> > # we want it to always really run the QAPI doc<br>> > # generation code. It also means we don't<br>> > # clutter up the build dir with the cache.<br>> > - command: [SPHINX_ARGS,<br>> > + command: SPHINX_ARGS + [<br>> > '-b', 'text', '-E',<br>> > '-c', meson.source_root() / 'docs',<br>> > '-D', 'master_doc=doc-good',<br>> ><br>><br><br><br>--<br> 此致<br>礼<br>罗勇刚<br>Yours<br> sincerely,<br>Yonggang Luo<br></div></div>
On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote: > >> build_docs = false >> if sphinx_build.found() >> # This is a bit awkward but works: create a trivial document and >> # try to run it with our configuration file (which enforces a >> # version requirement). This will fail if sphinx-build is too old. >> run_command('mkdir', ['-p', tmpdir / 'sphinx']) >> run_command('touch', [tmpdir / 'sphinx/index.rst']) >> sphinx_build_test_out = run_command(SPHINX_ARGS + [ >> '-c', meson.current_source_dir() / 'docs', >> '-b', 'html', tmpdir / 'sphinx', >> tmpdir / 'sphinx/out']) >> build_docs = (sphinx_build_test_out.returncode() == 0) >> endif > There is subtle error here, when sphinx_build not found, there is > SPHINX_ARGS should be [], > otherwise, latter place using SPHINX_ARGS have not found sphinx_build > will cause error by meson > .. > I'll add > > else > SPHINX_ARGS = [] > endif All uses of SPHINX_ARGS are protected by build_docs, and in turn build_docs is false if "not sphinx_build.found()". Am I missing something? Paolo
On Fri, Oct 16, 2020 at 3:57 PM Paolo Bonzini <pbonzini@redhat.com> wrote: > > On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote: > > > >> build_docs = false > >> if sphinx_build.found() > >> # This is a bit awkward but works: create a trivial document and > >> # try to run it with our configuration file (which enforces a > >> # version requirement). This will fail if sphinx-build is too old. > >> run_command('mkdir', ['-p', tmpdir / 'sphinx']) > >> run_command('touch', [tmpdir / 'sphinx/index.rst']) > >> sphinx_build_test_out = run_command(SPHINX_ARGS + [ > >> '-c', meson.current_source_dir() / 'docs', > >> '-b', 'html', tmpdir / 'sphinx', > >> tmpdir / 'sphinx/out']) > >> build_docs = (sphinx_build_test_out.returncode() == 0) > >> endif > > There is subtle error here, when sphinx_build not found, there is > > SPHINX_ARGS should be [], > > otherwise, latter place using SPHINX_ARGS have not found sphinx_build > > will cause error by meson > > .. > > I'll add > > > > else > > SPHINX_ARGS = [] > > endif > > All uses of SPHINX_ARGS are protected by build_docs, and in turn > build_docs is false if "not sphinx_build.found()". Am I missing something? Not all protected, missed in qapi/schema tests > > Paolo > -- 此致 礼 罗勇刚 Yours sincerely, Yonggang Luo <div dir="ltr"><br><br>On Fri, Oct 16, 2020 at 3:57 PM Paolo Bonzini <<a href="mailto:pbonzini@redhat.com">pbonzini@redhat.com</a>> wrote:<br>><br>> On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote:<br>> ><br>> >> build_docs = false<br>> >> if sphinx_build.found()<br>> >> # This is a bit awkward but works: create a trivial document and<br>> >> # try to run it with our configuration file (which enforces a<br>> >> # version requirement). This will fail if sphinx-build is too old.<br>> >> run_command('mkdir', ['-p', tmpdir / 'sphinx'])<br>> >> run_command('touch', [tmpdir / 'sphinx/index.rst'])<br>> >> sphinx_build_test_out = run_command(SPHINX_ARGS + [<br>> >> '-c', meson.current_source_dir() / 'docs',<br>> >> '-b', 'html', tmpdir / 'sphinx',<br>> >> tmpdir / 'sphinx/out'])<br>> >> build_docs = (sphinx_build_test_out.returncode() == 0)<br>> >> endif<br>> > There is subtle error here, when sphinx_build not found, there is<br>> > SPHINX_ARGS should be [],<br>> > otherwise, latter place using SPHINX_ARGS have not found sphinx_build<br>> > will cause error by meson<br>> > ..<br>> > I'll add<br>> ><br>> > else<br>> > SPHINX_ARGS = [] <br>> > endif<br>><br>> All uses of SPHINX_ARGS are protected by build_docs, and in turn<br>> build_docs is false if "not sphinx_build.found()". Am I missing something?<div>Not all protected, missed in qapi/schema tests<br>><br>> Paolo<br>><br><br><br>--<br> 此致<br>礼<br>罗勇刚<br>Yours<br> sincerely,<br>Yonggang Luo</div></div>
On Fri, Oct 16, 2020 at 3:57 PM Paolo Bonzini <pbonzini@redhat.com> wrote: > > On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote: > > > >> build_docs = false > >> if sphinx_build.found() > >> # This is a bit awkward but works: create a trivial document and > >> # try to run it with our configuration file (which enforces a > >> # version requirement). This will fail if sphinx-build is too old. > >> run_command('mkdir', ['-p', tmpdir / 'sphinx']) > >> run_command('touch', [tmpdir / 'sphinx/index.rst']) > >> sphinx_build_test_out = run_command(SPHINX_ARGS + [ > >> '-c', meson.current_source_dir() / 'docs', > >> '-b', 'html', tmpdir / 'sphinx', > >> tmpdir / 'sphinx/out']) > >> build_docs = (sphinx_build_test_out.returncode() == 0) > >> endif > > There is subtle error here, when sphinx_build not found, there is > > SPHINX_ARGS should be [], > > otherwise, latter place using SPHINX_ARGS have not found sphinx_build > > will cause error by meson > > .. > > I'll add > > > > else > > SPHINX_ARGS = [] > > endif > > All uses of SPHINX_ARGS are protected by build_docs, and in turn > build_docs is false if "not sphinx_build.found()". Am I missing something? > > Paolo > Rfer to https://github.com/lygstate/qemu/runs/1261141240?check_suite_focus=true -- 此致 礼 罗勇刚 Yours sincerely, Yonggang Luo <div dir="ltr"><br><br>On Fri, Oct 16, 2020 at 3:57 PM Paolo Bonzini <<a href="mailto:pbonzini@redhat.com">pbonzini@redhat.com</a>> wrote:<br>><br>> On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote:<br>> ><br>> >> build_docs = false<br>> >> if sphinx_build.found()<br>> >> # This is a bit awkward but works: create a trivial document and<br>> >> # try to run it with our configuration file (which enforces a<br>> >> # version requirement). This will fail if sphinx-build is too old.<br>> >> run_command('mkdir', ['-p', tmpdir / 'sphinx'])<br>> >> run_command('touch', [tmpdir / 'sphinx/index.rst'])<br>> >> sphinx_build_test_out = run_command(SPHINX_ARGS + [<br>> >> '-c', meson.current_source_dir() / 'docs',<br>> >> '-b', 'html', tmpdir / 'sphinx',<br>> >> tmpdir / 'sphinx/out'])<br>> >> build_docs = (sphinx_build_test_out.returncode() == 0)<br>> >> endif<br>> > There is subtle error here, when sphinx_build not found, there is<br>> > SPHINX_ARGS should be [],<br>> > otherwise, latter place using SPHINX_ARGS have not found sphinx_build<br>> > will cause error by meson<br>> > ..<br>> > I'll add<br>> ><br>> > else<br>> > SPHINX_ARGS = [] <br>> > endif<br>><br>> All uses of SPHINX_ARGS are protected by build_docs, and in turn<br>> build_docs is false if "not sphinx_build.found()". Am I missing something?<br>><br>> Paolo<br>><br>Rfer to <a href="https://github.com/lygstate/qemu/runs/1261141240?check_suite_focus=true">https://github.com/lygstate/qemu/runs/1261141240?check_suite_focus=true</a><br><br>--<br> 此致<br>礼<br>罗勇刚<br>Yours<br> sincerely,<br>Yonggang Luo</div>
On 16/10/20 09:57, Paolo Bonzini wrote: > On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote: >> >>> build_docs = false >>> if sphinx_build.found() >>> # This is a bit awkward but works: create a trivial document and >>> # try to run it with our configuration file (which enforces a >>> # version requirement). This will fail if sphinx-build is too old. >>> run_command('mkdir', ['-p', tmpdir / 'sphinx']) >>> run_command('touch', [tmpdir / 'sphinx/index.rst']) >>> sphinx_build_test_out = run_command(SPHINX_ARGS + [ >>> '-c', meson.current_source_dir() / 'docs', >>> '-b', 'html', tmpdir / 'sphinx', >>> tmpdir / 'sphinx/out']) >>> build_docs = (sphinx_build_test_out.returncode() == 0) >>> endif >> There is subtle error here, when sphinx_build not found, there is >> SPHINX_ARGS should be [], >> otherwise, latter place using SPHINX_ARGS have not found sphinx_build >> will cause error by meson >> .. >> I'll add >> >> else >> SPHINX_ARGS = [] >> endif > > All uses of SPHINX_ARGS are protected by build_docs, and in turn > build_docs is false if "not sphinx_build.found()". Am I missing something? Ah there are uses in tests/ too, those should all be under "if build_docs" too. Paolo
On Fri, Oct 16, 2020 at 4:05 PM Paolo Bonzini <pbonzini@redhat.com> wrote: > > On 16/10/20 09:57, Paolo Bonzini wrote: > > On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote: > >> > >>> build_docs = false > >>> if sphinx_build.found() > >>> # This is a bit awkward but works: create a trivial document and > >>> # try to run it with our configuration file (which enforces a > >>> # version requirement). This will fail if sphinx-build is too old. > >>> run_command('mkdir', ['-p', tmpdir / 'sphinx']) > >>> run_command('touch', [tmpdir / 'sphinx/index.rst']) > >>> sphinx_build_test_out = run_command(SPHINX_ARGS + [ > >>> '-c', meson.current_source_dir() / 'docs', > >>> '-b', 'html', tmpdir / 'sphinx', > >>> tmpdir / 'sphinx/out']) > >>> build_docs = (sphinx_build_test_out.returncode() == 0) > >>> endif > >> There is subtle error here, when sphinx_build not found, there is > >> SPHINX_ARGS should be [], > >> otherwise, latter place using SPHINX_ARGS have not found sphinx_build > >> will cause error by meson > >> .. > >> I'll add > >> > >> else > >> SPHINX_ARGS = [] > >> endif > > > > All uses of SPHINX_ARGS are protected by build_docs, and in turn > > build_docs is false if "not sphinx_build.found()". Am I missing something? > > Ah there are uses in tests/ too, those should all be under "if > build_docs" too. Yeap, I did it before, but that changes a lot and not easy to review, you can do it in separate patch. Anyway setting SPHINX_ARGS to [] are more robust. > > Paolo > -- 此致 礼 罗勇刚 Yours sincerely, Yonggang Luo <div dir="ltr"><br><br>On Fri, Oct 16, 2020 at 4:05 PM Paolo Bonzini <<a href="mailto:pbonzini@redhat.com">pbonzini@redhat.com</a>> wrote:<br>><br>> On 16/10/20 09:57, Paolo Bonzini wrote:<br>> > On 16/10/20 09:52, 罗勇刚(Yonggang Luo) wrote:<br>> >><br>> >>> build_docs = false<br>> >>> if sphinx_build.found()<br>> >>> # This is a bit awkward but works: create a trivial document and<br>> >>> # try to run it with our configuration file (which enforces a<br>> >>> # version requirement). This will fail if sphinx-build is too old.<br>> >>> run_command('mkdir', ['-p', tmpdir / 'sphinx'])<br>> >>> run_command('touch', [tmpdir / 'sphinx/index.rst'])<br>> >>> sphinx_build_test_out = run_command(SPHINX_ARGS + [<br>> >>> '-c', meson.current_source_dir() / 'docs',<br>> >>> '-b', 'html', tmpdir / 'sphinx',<br>> >>> tmpdir / 'sphinx/out'])<br>> >>> build_docs = (sphinx_build_test_out.returncode() == 0)<br>> >>> endif<br>> >> There is subtle error here, when sphinx_build not found, there is<br>> >> SPHINX_ARGS should be [],<br>> >> otherwise, latter place using SPHINX_ARGS have not found sphinx_build<br>> >> will cause error by meson<br>> >> ..<br>> >> I'll add<br>> >><br>> >> else<br>> >> SPHINX_ARGS = [] <br>> >> endif<br>> ><br>> > All uses of SPHINX_ARGS are protected by build_docs, and in turn<br>> > build_docs is false if "not sphinx_build.found()". Am I missing something?<br>><br>> Ah there are uses in tests/ too, those should all be under "if<br>> build_docs" too.<div>Yeap, I did it before, but that changes a lot and not easy to review, you can do it in separate patch.</div><div>Anyway setting SPHINX_ARGS to [] are more robust.<br>><br>> Paolo<br>><br><br><br>--<br> 此致<br>礼<br>罗勇刚<br>Yours<br> sincerely,<br>Yonggang Luo</div></div>
diff --git a/configure b/configure index 1ce31f97b4..ff593a8542 100755 --- a/configure +++ b/configure @@ -297,7 +297,7 @@ brlapi="" curl="" iconv="auto" curses="auto" -docs="" +docs="auto" fdt="auto" netmap="no" sdl="auto" @@ -822,15 +822,6 @@ do fi done -sphinx_build= -for binary in sphinx-build-3 sphinx-build -do - if has "$binary" - then - sphinx_build=$(command -v "$binary") - break - fi -done # Check for ancillary tools used in testing genisoimage= @@ -1226,9 +1217,9 @@ for opt do ;; --disable-crypto-afalg) crypto_afalg="no" ;; - --disable-docs) docs="no" + --disable-docs) docs="disabled" ;; - --enable-docs) docs="yes" + --enable-docs) docs="enabled" ;; --disable-vhost-net) vhost_net="no" ;; @@ -4413,45 +4404,6 @@ if check_include linux/btrfs.h ; then btrfs=yes fi -# If we're making warnings fatal, apply this to Sphinx runs as well -sphinx_werror="" -if test "$werror" = "yes"; then - sphinx_werror="-W" -fi - -# Check we have a new enough version of sphinx-build -has_sphinx_build() { - # This is a bit awkward but works: create a trivial document and - # try to run it with our configuration file (which enforces a - # version requirement). This will fail if either - # sphinx-build doesn't exist at all or if it is too old. - mkdir -p "$TMPDIR1/sphinx" - touch "$TMPDIR1/sphinx/index.rst" - "$sphinx_build" $sphinx_werror -c "$source_path/docs" \ - -b html "$TMPDIR1/sphinx" \ - "$TMPDIR1/sphinx/out" >> config.log 2>&1 -} - -# Check if tools are available to build documentation. -if test "$docs" != "no" ; then - if has_sphinx_build; then - sphinx_ok=yes - else - sphinx_ok=no - fi - if test "$sphinx_ok" = "yes"; then - docs=yes - else - if test "$docs" = "yes" ; then - if has $sphinx_build && test "$sphinx_ok" != "yes"; then - echo "Warning: $sphinx_build exists but it is either too old or uses too old a Python version" >&2 - fi - feature_not_found "docs" "Install a Python 3 version of python-sphinx" - fi - docs=no - fi -fi - # Search for bswap_32 function byteswap_h=no cat > $TMPC << EOF @@ -6087,9 +6039,6 @@ qemu_version=$(head $source_path/VERSION) echo "PKGVERSION=$pkgversion" >>$config_host_mak echo "SRC_PATH=$source_path" >> $config_host_mak echo "TARGET_DIRS=$target_list" >> $config_host_mak -if [ "$docs" = "yes" ] ; then - echo "BUILD_DOCS=yes" >> $config_host_mak -fi if test "$modules" = "yes"; then # $shacmd can generate a hash started with digit, which the compiler doesn't # like as an symbol. So prefix it with an underscore @@ -6794,7 +6743,6 @@ fi echo "ROMS=$roms" >> $config_host_mak echo "MAKE=$make" >> $config_host_mak echo "PYTHON=$python" >> $config_host_mak -echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak echo "GENISOIMAGE=$genisoimage" >> $config_host_mak echo "MESON=$meson" >> $config_host_mak echo "CC=$cc" >> $config_host_mak @@ -7076,6 +7024,7 @@ NINJA=${ninja:-$PWD/ninjatool} $meson setup \ -Dgettext=$gettext -Dxkbcommon=$xkbcommon -Du2f=$u2f \ -Dcapstone=$capstone -Dslirp=$slirp -Dfdt=$fdt \ -Diconv=$iconv -Dcurses=$curses \ + -Ddocs=$docs -Dsphinx_build=$sphinx_build \ $cross_arg \ "$PWD" "$source_path" diff --git a/docs/meson.build b/docs/meson.build index 0340d489ac..f566809a6a 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -37,7 +37,7 @@ if build_docs input: [files('conf.py'), files(manual / 'conf.py')], depfile: manual + '.d', depend_files: sphinx_extn_depends, - command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@', + command: SPHINX_ARGS + ['-Ddepfile=@DEPFILE@', '-Ddepfile_stamp=@OUTPUT0@', '-b', 'html', '-d', private_dir, input_dir, output_dir]) @@ -59,7 +59,7 @@ if build_docs input: this_manual, install: build_docs, install_dir: install_dirs, - command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir, + command: SPHINX_ARGS + ['-b', 'man', '-d', private_dir, input_dir, meson.current_build_dir()]) endif endforeach diff --git a/meson.build b/meson.build index 8156df8b71..8940468208 100644 --- a/meson.build +++ b/meson.build @@ -17,7 +17,13 @@ cc = meson.get_compiler('c') config_host = keyval.load(meson.current_build_dir() / 'config-host.mak') enable_modules = 'CONFIG_MODULES' in config_host enable_static = 'CONFIG_STATIC' in config_host -build_docs = 'BUILD_DOCS' in config_host + +# Temporary directory used for files created while +# configure runs. Since it is in the build directory +# we can safely blow away any previous version of it +# (and we need not jump through hoops to try to delete +# it when configure exits.) +tmpdir = meson.current_build_dir() / 'config-temp' if get_option('qemu_suffix').startswith('/') error('qemu_suffix cannot start with a /') @@ -1235,12 +1241,52 @@ foreach d : hx_headers endforeach genh += hxdep -SPHINX_ARGS = [config_host['SPHINX_BUILD'], - '-Dversion=' + meson.project_version(), - '-Drelease=' + config_host['PKGVERSION']] +sphinx_build = not_found +sphinx_build_option = get_option('sphinx_build') +if sphinx_build_option == '' + sphinx_build = find_program('sphinx-build', required: false) +else + sphinx_build = find_program(sphinx_build_option, required: false) +endif +SPHINX_TEST_ARGS = [] +# If we're making warnings fatal, apply this to Sphinx runs as well if get_option('werror') - SPHINX_ARGS += [ '-W' ] + SPHINX_TEST_ARGS += [ '-W' ] +endif + +build_docs = false +docs_option = get_option('docs') +# Check if tools are available to build documentation. +if sphinx_build.found() and not docs_option.disabled() + # This is a bit awkward but works: create a trivial document and + # try to run it with our configuration file (which enforces a + # version requirement). This will fail if either + # sphinx-build doesn't exist at all or if it is too old. + run_command('mkdir', ['-p', tmpdir / 'sphinx']) + run_command('touch', [tmpdir / 'sphinx/index.rst']) + sphinx_build_test_out = run_command(sphinx_build, SPHINX_TEST_ARGS + [ + '-c', meson.current_source_dir() / 'docs', + '-b', 'html', tmpdir / 'sphinx', + tmpdir / 'sphinx/out']) + if sphinx_build_test_out.returncode() == 0 + build_docs = true + else + if docs_option.enabled() + if sphinx_build_option != '' + warning('Warning: @0@ exists but it is either too old or uses too old a Python version'.format(sphinx_build_option)) + endif + error('Warning: Install a Python 3 version of python-sphinx') + endif + # do not building docs + endif +endif + +SPHINX_ARGS = [] +if build_docs + SPHINX_ARGS = [sphinx_build] + SPHINX_ARGS += SPHINX_TEST_ARGS + SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']] endif sphinx_extn_depends = [ meson.source_root() / 'docs/sphinx/depfile.py', @@ -1918,7 +1964,7 @@ summary_info += {'QEMU_CFLAGS': config_host['QEMU_CFLAGS']} summary_info += {'QEMU_LDFLAGS': config_host['QEMU_LDFLAGS']} summary_info += {'make': config_host['MAKE']} summary_info += {'python': '@0@ (version: @1@)'.format(python.full_path(), python.language_version())} -summary_info += {'sphinx-build': config_host['SPHINX_BUILD']} +summary_info += {'sphinx-build': sphinx_build.found()} summary_info += {'genisoimage': config_host['GENISOIMAGE']} # TODO: add back version summary_info += {'slirp support': slirp_opt == 'disabled' ? false : slirp_opt} @@ -1986,7 +2032,7 @@ if config_host.has_key('CONFIG_XEN_BACKEND') summary_info += {'xen ctrl version': config_host['CONFIG_XEN_CTRL_INTERFACE_VERSION']} endif summary_info += {'brlapi support': config_host.has_key('CONFIG_BRLAPI')} -summary_info += {'Documentation': config_host.has_key('BUILD_DOCS')} +summary_info += {'Documentation': build_docs} summary_info += {'PIE': get_option('b_pie')} summary_info += {'vde support': config_host.has_key('CONFIG_VDE')} summary_info += {'netmap support': config_host.has_key('CONFIG_NETMAP')} diff --git a/meson_options.txt b/meson_options.txt index e6cb1e589b..0e3fa7136b 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -1,8 +1,11 @@ option('qemu_suffix', type : 'string', value: 'qemu', description: 'Suffix for QEMU data/modules/config directories (can be empty)') +option('docs', type : 'feature', value : 'auto', + description: 'Documentations build support') option('docdir', type : 'string', value : 'doc', description: 'Base directory for documentation installation (can be empty)') - +option('sphinx_build', type : 'string', value : '', + description: 'Use specified sphinx-build [$sphinx_build] for building document (default to be empty)') option('gettext', type : 'boolean', value : true, description: 'Localization of the GTK+ user interface') option('sparse', type : 'feature', value : 'auto', diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build index 1f222a7a13..961b8367a9 100644 --- a/tests/qapi-schema/meson.build +++ b/tests/qapi-schema/meson.build @@ -237,7 +237,7 @@ qapi_doc_out = custom_target('QAPI rST doc', # we want it to always really run the QAPI doc # generation code. It also means we don't # clutter up the build dir with the cache. - command: [SPHINX_ARGS, + command: SPHINX_ARGS + [ '-b', 'text', '-E', '-c', meson.source_root() / 'docs', '-D', 'master_doc=doc-good',
Signed-off-by: Yonggang Luo <luoyonggang@gmail.com> --- configure | 59 +++------------------------------- docs/meson.build | 4 +-- meson.build | 60 +++++++++++++++++++++++++++++++---- meson_options.txt | 5 ++- tests/qapi-schema/meson.build | 2 +- 5 files changed, 64 insertions(+), 66 deletions(-)