From nobody Tue Feb 10 04:17:06 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1602799082; cv=none; d=zohomail.com; s=zohoarc; b=oLgE/BnGvaxgsCPJpzM2Y1tdSlACNbU5pS4cPperoiddPxyhnsuBgP2AxdS7lNbOVpvcBfUUKkdEE02jxf/hYrscAZ4fMlLbwnvB8hB36MDWazCy4jWfCN6torgUQ8dgOXtUpO/df6AjwNl/YRZLQliIs7d+PI+mtzOPm1pGXjo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1602799082; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=g4cbzeU6YRPy8GRPuXVDcztIxUIPrUKh5dgrp8W1QMM=; b=Eo1JgzSe3T9jrdkJXB4JDvMCoAvSzranESqGUoM2YDj6y55DD5l8rxB5S39p50ULafXEJzMBk+8yvfo7yiqtdLKeqzxcJJxgd/IrzXFsWOxdocGEeKrHqATlM0a62O74BLN70ODGKuELGoOX/Mdb0BWSa5rP9AIdnWlzohLbHNw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1602799082725207.450100858798; Thu, 15 Oct 2020 14:58:02 -0700 (PDT) Received: from localhost ([::1]:56470 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kTBG5-0005iN-C1 for importer@patchew.org; Thu, 15 Oct 2020 17:58:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52696) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kTBCN-0000yU-KW for qemu-devel@nongnu.org; Thu, 15 Oct 2020 17:54:11 -0400 Received: from mail-pf1-x42d.google.com ([2607:f8b0:4864:20::42d]:32814) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kTBCK-0005IK-BR for qemu-devel@nongnu.org; Thu, 15 Oct 2020 17:54:11 -0400 Received: by mail-pf1-x42d.google.com with SMTP id j18so256367pfa.0 for ; Thu, 15 Oct 2020 14:54:07 -0700 (PDT) Received: from localhost.localdomain ([103.94.185.75]) by smtp.googlemail.com with ESMTPSA id f66sm252856pfa.59.2020.10.15.14.54.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Oct 2020 14:54:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=g4cbzeU6YRPy8GRPuXVDcztIxUIPrUKh5dgrp8W1QMM=; b=SChUWRIWmF0t+r6Pn4xrKpsFLbRg2uhq+78MLX9CmGUVN5b2+ZZ9d5zwESEOOPtMIV qtFHzTX3PD+Mmf6XkBE0YGOtNyMLwwWzNm462rkAgnQ2A9S4+Cid2oGuvALfy+rLXbWz 0b649TF4fhPcBNf9tCin1g1uzULc/60z+ewrwinSZp5hIqdcsiRwV5WcjmFFpY8jChh7 eXAHPP0tyxi4hLlvlSsKUHgVTX0rQ11EXsgx/pQcXz0LqkvWaRntPDcMUWPqKP9WNkX+ HyDZFKtRo58ySTWt0xeh/2PkUbBWReHjvzdnl6fFDz3bsuQkQjtLlEqUouirzO1iy8S/ dy+A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=g4cbzeU6YRPy8GRPuXVDcztIxUIPrUKh5dgrp8W1QMM=; b=Ik/zRpVg6TdS5Vma+B8ADPX5znPF1KkxcthDcbozrLXcb9n2XugLvEow2GZPj7U14V GrjuITr/3uX5/nJrk0raMd2f+mneWqzzVSDJj30TqB+TLU6uhpWap4Pm5cppxf5HJWzx rJoJSXfAK+MFN2lYLyyeELQcBluwcMf65pO6zHOVguooguAFQlzo2t2Gprx/Warauf7s vvFjwP1YPor1ggJzK0l+Cu8+NDnFKH+YajA6U7khasMaoBQyG/j81rnA6LNEUBg4HOAp GUPOMC3Fwk4tQQ9g4PxekO15Wni3PeAgWiPfjhM0S0k+Bs3g3Oh/vsjaIES+Gg5vbZtv PTjA== X-Gm-Message-State: AOAM531zwOkoOba5jXIgsCqEwBRf+QgKBBINzGYbofi0f/AITaI1RWNX 3uDeA1q0X/853bBmfrn7vGBJ7vllJHCWCAES X-Google-Smtp-Source: ABdhPJxJIYXgej6SwcOP3S6GmA3rRxBtiio99AkPLxBwihKNNzcFjcjA6v6ZKsp7/SCqkozpntjv6Q== X-Received: by 2002:a63:e443:: with SMTP id i3mr477093pgk.289.1602798846124; Thu, 15 Oct 2020 14:54:06 -0700 (PDT) From: Yonggang Luo To: qemu-devel@nongnu.org Subject: [PATCH v3 3/4] meson: Move the detection logic for sphinx to meson Date: Fri, 16 Oct 2020 05:53:44 +0800 Message-Id: <20201015215345.173-4-luoyonggang@gmail.com> X-Mailer: git-send-email 2.28.0.windows.1 In-Reply-To: <20201015215345.173-1-luoyonggang@gmail.com> References: <20201015215345.173-1-luoyonggang@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::42d; envelope-from=luoyonggang@gmail.com; helo=mail-pf1-x42d.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Paolo Bonzini , Yonggang Luo Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @gmail.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Yonggang Luo --- configure | 59 +++-------------------------------- docs/meson.build | 4 +-- meson.build | 59 ++++++++++++++++++++++++++++++----- meson_options.txt | 5 ++- tests/qapi-schema/meson.build | 2 +- 5 files changed, 63 insertions(+), 66 deletions(-) diff --git a/configure b/configure index 1ce31f97b4..ff593a8542 100755 --- a/configure +++ b/configure @@ -297,7 +297,7 @@ brlapi=3D"" curl=3D"" iconv=3D"auto" curses=3D"auto" -docs=3D"" +docs=3D"auto" fdt=3D"auto" netmap=3D"no" sdl=3D"auto" @@ -822,15 +822,6 @@ do fi done =20 -sphinx_build=3D -for binary in sphinx-build-3 sphinx-build -do - if has "$binary" - then - sphinx_build=3D$(command -v "$binary") - break - fi -done =20 # Check for ancillary tools used in testing genisoimage=3D @@ -1226,9 +1217,9 @@ for opt do ;; --disable-crypto-afalg) crypto_afalg=3D"no" ;; - --disable-docs) docs=3D"no" + --disable-docs) docs=3D"disabled" ;; - --enable-docs) docs=3D"yes" + --enable-docs) docs=3D"enabled" ;; --disable-vhost-net) vhost_net=3D"no" ;; @@ -4413,45 +4404,6 @@ if check_include linux/btrfs.h ; then btrfs=3Dyes fi =20 -# If we're making warnings fatal, apply this to Sphinx runs as well -sphinx_werror=3D"" -if test "$werror" =3D "yes"; then - sphinx_werror=3D"-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" !=3D "no" ; then - if has_sphinx_build; then - sphinx_ok=3Dyes - else - sphinx_ok=3Dno - fi - if test "$sphinx_ok" =3D "yes"; then - docs=3Dyes - else - if test "$docs" =3D "yes" ; then - if has $sphinx_build && test "$sphinx_ok" !=3D "yes"; then - echo "Warning: $sphinx_build exists but it is either too old or us= es too old a Python version" >&2 - fi - feature_not_found "docs" "Install a Python 3 version of python-sphin= x" - fi - docs=3Dno - fi -fi - # Search for bswap_32 function byteswap_h=3Dno cat > $TMPC << EOF @@ -6087,9 +6039,6 @@ qemu_version=3D$(head $source_path/VERSION) echo "PKGVERSION=3D$pkgversion" >>$config_host_mak echo "SRC_PATH=3D$source_path" >> $config_host_mak echo "TARGET_DIRS=3D$target_list" >> $config_host_mak -if [ "$docs" =3D "yes" ] ; then - echo "BUILD_DOCS=3Dyes" >> $config_host_mak -fi if test "$modules" =3D "yes"; then # $shacmd can generate a hash started with digit, which the compiler doe= sn't # like as an symbol. So prefix it with an underscore @@ -6794,7 +6743,6 @@ fi echo "ROMS=3D$roms" >> $config_host_mak echo "MAKE=3D$make" >> $config_host_mak echo "PYTHON=3D$python" >> $config_host_mak -echo "SPHINX_BUILD=3D$sphinx_build" >> $config_host_mak echo "GENISOIMAGE=3D$genisoimage" >> $config_host_mak echo "MESON=3D$meson" >> $config_host_mak echo "CC=3D$cc" >> $config_host_mak @@ -7076,6 +7024,7 @@ NINJA=3D${ninja:-$PWD/ninjatool} $meson setup \ -Dgettext=3D$gettext -Dxkbcommon=3D$xkbcommon -Du2f=3D$u2f \ -Dcapstone=3D$capstone -Dslirp=3D$slirp -Dfdt=3D$fdt \ -Diconv=3D$iconv -Dcurses=3D$curses \ + -Ddocs=3D$docs -Dsphinx_build=3D$sphinx_build \ $cross_arg \ "$PWD" "$source_path" =20 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=3D@DEPFILE@', + command: SPHINX_ARGS + ['-Ddepfile=3D@DEPFILE@', '-Ddepfile_stamp=3D@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', privat= e_dir, input_dir, meson.current_build_dir()]) endif endforeach diff --git a/meson.build b/meson.build index 8156df8b71..ddd64d6df5 100644 --- a/meson.build +++ b/meson.build @@ -17,7 +17,13 @@ cc =3D meson.get_compiler('c') config_host =3D keyval.load(meson.current_build_dir() / 'config-host.mak') enable_modules =3D 'CONFIG_MODULES' in config_host enable_static =3D 'CONFIG_STATIC' in config_host -build_docs =3D '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 =3D meson.current_build_dir() / 'config-temp' =20 if get_option('qemu_suffix').startswith('/') error('qemu_suffix cannot start with a /') @@ -1235,14 +1241,53 @@ foreach d : hx_headers endforeach genh +=3D hxdep =20 -SPHINX_ARGS =3D [config_host['SPHINX_BUILD'], - '-Dversion=3D' + meson.project_version(), - '-Drelease=3D' + config_host['PKGVERSION']] +sphinx_build =3D not_found +sphinx_build_option =3D get_option('sphinx_build') +if sphinx_build_option =3D=3D '' + sphinx_build =3D find_program('sphinx-build', required: false) +else + sphinx_build =3D find_program(sphinx_build_option, required: false) +endif =20 +SPHINX_TEST_ARGS =3D [] +# If we're making warnings fatal, apply this to Sphinx runs as well if get_option('werror') - SPHINX_ARGS +=3D [ '-W' ] + SPHINX_TEST_ARGS +=3D [ '-W' ] +endif + +build_docs =3D false +docs_option =3D 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 =3D 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() =3D=3D 0 + build_docs =3D true + else + if docs_option.enabled() + if sphinx_build_option !=3D '' + warning('Warning: @0@ exists but it is either too old or uses to= o 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 =20 +SPHINX_ARGS =3D [] +if build_docs: + SPHINX_ARGS =3D [sphinx_build] + SPHINX_ARGS +=3D SPHINX_TEST_ARGS + SPHINX_ARGS +=3D ['-Dversion=3D' + meson.project_version(), '-Drelease= =3D' + config_host['PKGVERSION']] + sphinx_extn_depends =3D [ meson.source_root() / 'docs/sphinx/depfile.py', meson.source_root() / 'docs/sphinx/hxtool.py', meson.source_root() / 'docs/sphinx/kerneldoc.py', @@ -1918,7 +1963,7 @@ summary_info +=3D {'QEMU_CFLAGS': config_host['= QEMU_CFLAGS']} summary_info +=3D {'QEMU_LDFLAGS': config_host['QEMU_LDFLAGS']} summary_info +=3D {'make': config_host['MAKE']} summary_info +=3D {'python': '@0@ (version: @1@)'.format(python= .full_path(), python.language_version())} -summary_info +=3D {'sphinx-build': config_host['SPHINX_BUILD']} +summary_info +=3D {'sphinx-build': sphinx_build.found()} summary_info +=3D {'genisoimage': config_host['GENISOIMAGE']} # TODO: add back version summary_info +=3D {'slirp support': slirp_opt =3D=3D 'disabled' ? fals= e : slirp_opt} @@ -1986,7 +2031,7 @@ if config_host.has_key('CONFIG_XEN_BACKEND') summary_info +=3D {'xen ctrl version': config_host['CONFIG_XEN_CTRL_INT= ERFACE_VERSION']} endif summary_info +=3D {'brlapi support': config_host.has_key('CONFIG_BRLAPI= ')} -summary_info +=3D {'Documentation': config_host.has_key('BUILD_DOCS')} +summary_info +=3D {'Documentation': build_docs} summary_info +=3D {'PIE': get_option('b_pie')} summary_info +=3D {'vde support': config_host.has_key('CONFIG_VDE')} summary_info +=3D {'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 buildi= ng 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 =3D 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=3Ddoc-good', --=20 2.28.0.windows.1