From nobody Mon Feb 9 09:54:28 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=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1610122550; cv=none; d=zohomail.com; s=zohoarc; b=fVnChFOioQ2GUYXg//GgDRtDZYiXSyiv9BgInfBfj8lM2NC+/y37TLlsp3rCkfxxKiX/kf/q/L4Xm03fhoePU8MasTT5McSmzwao69XMevu6uKvwunuMR+ZprloRoHVFAQcuwOLfjvg/ZQaN7X0x5yXGIl8F37vCy32AYyL7s7A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610122550; 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=O028dnlMv5NS+Rmaj3Ia6Zadv1Cc6n7rptblmwTUcIA=; b=KqXp5ts3Fzs0V8uuForedfOSuZzjnttWf496HaAGn4sLCz9V9QUsNAIZ2byFpNL1X5mIfYdMaOFlJNgtdaZ+cF7wM0pQ/RR7mXunQDQAaaE2N3jyDhEpEPC5BXdaCQAkJqaGzQnICQFMhdyPZSwvmNtoHcBf5GaHR1enFAUtiZk= 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 1610122550473637.1795889556392; Fri, 8 Jan 2021 08:15:50 -0800 (PST) Received: from localhost ([::1]:50260 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kxuQX-0007ea-A9 for importer@patchew.org; Fri, 08 Jan 2021 11:15:49 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:58642) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kxuPA-0006Oe-GP for qemu-devel@nongnu.org; Fri, 08 Jan 2021 11:14:24 -0500 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]:38219) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kxuP7-0000Qu-J9 for qemu-devel@nongnu.org; Fri, 08 Jan 2021 11:14:24 -0500 Received: by mail-wm1-x334.google.com with SMTP id g185so8880664wmf.3 for ; Fri, 08 Jan 2021 08:14:21 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id m8sm13261765wmc.27.2021.01.08.08.14.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Jan 2021 08:14:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=O028dnlMv5NS+Rmaj3Ia6Zadv1Cc6n7rptblmwTUcIA=; b=QChpvsNS15XwhER+0Z0h7QZYYhVddgTT91HV0m65N7dyIt/mO2hL3B+Mfx2GoBxtRv SkMOkHcnjkrK0h3Gp/nJPvyAk5tNAWwignZKn8MknYbvo3AHKqrYmj6feJ97BLjh6TRv lHoVRcAgW+zQDcdpr5M85WxqhoYhXZMKFvGp0f1UlwfrCAq3pIjz9tHvECCrjzhn9vc+ Dvn4xMhPhKNps/KA4E7OPH/Zg2x9LxM06seX/3n+ZpkdHWEtHbCxYdHfwMQsTmtGPdpB LQ/OzOOkQMf3rwX21ekWqk9aGBUIpb2MEDE5SeTOSy4YRTvTYyDvUOJCgnB7ArFeTDO9 HhFw== 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=O028dnlMv5NS+Rmaj3Ia6Zadv1Cc6n7rptblmwTUcIA=; b=BA5QdM4NQ4RKfC9X4SOBVGEPD6+2wqiBCs9fyIe2aRS8KeOpzSNSRPn4sec6/X0982 ArHzvEXkG6Zhh+QyjhjT/qM6RQwdqXAyB2qn5njPadHle5Tsu0G6Qc+eZ2LEoT1CodHI OgSIk+xAHnpoN6y4VXZpWiyCMPBIJO0soPDDMQ8XcafqrIMgGyY3/wnuasynRs0Zm/nW HRAD3CxwjoB5Os7ZsPR/BX2Odvk6wrtPCvSa6hKFEpF8dfX2iRGJG4F/zS0KgrLr0m9f MssMNGNpU6ki6s613AOiBrBIvPzXofMsHxqd9+4oPjRDjtayTqcA4JeN9owzOJoYJCiC xuTQ== X-Gm-Message-State: AOAM532sV1BGucvZB/UR9tQxvD5tTe8XNS4H2i4yrRdoKrPDNuHUr1l5 R3y4Xxv2RrW9HB2Sdmq/4yJ+X2fZ0W3f9g== X-Google-Smtp-Source: ABdhPJwsCotJ0yrchHqEPQA2skE9QCNqILqJDYjnxWM6tFds/n1UvqmHNZTba3aEwCvD2y6RAeEcig== X-Received: by 2002:a05:600c:410d:: with SMTP id j13mr3680809wmi.95.1610122459844; Fri, 08 Jan 2021 08:14:19 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 1/2] docs: Add qemu-storage-daemon(1) manpage to meson.build Date: Fri, 8 Jan 2021 16:14:15 +0000 Message-Id: <20210108161416.21129-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210108161416.21129-1-peter.maydell@linaro.org> References: <20210108161416.21129-1-peter.maydell@linaro.org> 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=2a00:1450:4864:20::334; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x334.google.com 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, 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 , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @linaro.org) Content-Type: text/plain; charset="utf-8" In commit 1982e1602d15 we added a new qemu-storage-daemon(1) manpage. At the moment new manpages have to be listed both in the conf.py for Sphinx and also in docs/meson.build for Meson. We forgot the second of those -- correct the omission. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- docs/meson.build | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/meson.build b/docs/meson.build index 71641b4fe07..fae9849b79b 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -62,6 +62,7 @@ if build_docs 'qemu-img.1': (have_tools ? 'man1' : ''), 'qemu-nbd.8': (have_tools ? 'man8' : ''), 'qemu-pr-helper.8': (have_tools ? 'man8' : ''), + 'qemu-storage-daemon.1': (have_tools ? 'man1' : ''), 'qemu-trace-stap.1': (config_host.has_key('CONFIG_TRACE_SYSTEMTAP'= ) ? 'man1' : ''), 'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''), 'virtiofsd.1': (have_virtiofsd ? 'man1' : ''), --=20 2.20.1 From nobody Mon Feb 9 09:54:28 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=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1610122746; cv=none; d=zohomail.com; s=zohoarc; b=bdY68VBu1n9Ms+V8hQsAeX16FrMezYPHsrvzl1KD+7b49S+8XdFnda8cQjp+gxvg3EBLZ9p9zFHCkl2diMh1GsyxciQbtcYpj2PqMeKQre51YW5gF1F8o2OrMkf3cDZxaOy/rLWqZ6qzCRAe8sY8JNJRFc1iORGusPaF78aDFQE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610122746; 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=Un1VQuwXoivaXAg7ERrxYvXlvakqirx7nivm/GWK83Q=; b=ZfXoNQ3T6PlhLguXn2lre3kDuVbcJAbmKIyWYWB+1GmCuhNoQNDqsDd6yIwJ4X+OdABulXDXTjZJGwyd8gxt5ckBz2H5lAXz3yA2FMMmbbeVdJTGXgrmWpzSMunUxulZpEl/0s81Aqog9UaRtsv1TyPKtpxBCWpTyqFpm2Wr6ws= 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 1610122745979725.9547461541088; Fri, 8 Jan 2021 08:19:05 -0800 (PST) Received: from localhost ([::1]:54796 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kxuTg-0001mO-Q9 for importer@patchew.org; Fri, 08 Jan 2021 11:19:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:58652) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kxuPB-0006RH-U5 for qemu-devel@nongnu.org; Fri, 08 Jan 2021 11:14:25 -0500 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:40748) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kxuP9-0000Rd-8i for qemu-devel@nongnu.org; Fri, 08 Jan 2021 11:14:25 -0500 Received: by mail-wr1-x42f.google.com with SMTP id 91so9543332wrj.7 for ; Fri, 08 Jan 2021 08:14:22 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id m8sm13261765wmc.27.2021.01.08.08.14.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Jan 2021 08:14:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Un1VQuwXoivaXAg7ERrxYvXlvakqirx7nivm/GWK83Q=; b=XhLPX1vU71WDThNUghLA5W4hfhpHxjuxcwhm2rTInuWZ0OXMSFOjYO0sdMiyITXAOH S/h2BeUNWUZIiy6AWBkTi7jSsDVMcVbraudHmzb0ZUjvThU5iru8j8paaYvqP3hRhrUN OWxhfJ0Z90s6FNOoFqEUsM0pW3Di5TOHqpYZO6P0uipQZYJMvE3XEHgUKsqZC+qoxZMj 41/9QwM9EzwT/HQ/HKvxyam8EyszHFDNsdCSt+2Zhv7kuVutTKkpOVyiq/6vp3F2u11D EWjtRHamq7KbJRzSuBiF7vKtWb7ygM/zJc79pnP2ibkuXvhDvhzhtYAhUlN1k3Tq3rcF In2A== 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=Un1VQuwXoivaXAg7ERrxYvXlvakqirx7nivm/GWK83Q=; b=LWzawWZ1Y65eVY7ozWmNCanwP0dK29fmmoUTecxfeeYt+NnjeBR/QfmOsK1z6nRjNU 9vgOm6WN5UJAQgHIs62hearSgv/AD8UkU4o9+gQ/2rEv29L9lPXcFe5VWUxoIUVcNPHn mp0ZF0BIo+kekoB6n2Une5/E08LmWCh1ubP4sLmOSzl1bPl2DVkDQEG/39OAjEL8cqlZ n/N/WCCewF/kmq9T7GmaoCDOFxuZxn4721qDFbicSU4uWVHnJftmAM+w30mwQlrlFza4 Ipzkfj2DvGiKOB1LDEohcND+jyh3xnlyMi6h1BMO5okMBc1t4A20gKhGIUBIZ5IBmGzN AdNQ== X-Gm-Message-State: AOAM531ZYpT4Cg9AaTXlrvqSe71wC5v2/Yonbr+VyN30JlPnAV1U+dQq jErvncU6XYzkoB1xiCvTEonAwm8We5oznA== X-Google-Smtp-Source: ABdhPJxOR70O6PDTVresrAw4HOWNkCGEo3IpTGuOkAwIjvJuzaOmkgcqnTTduLRot6jfFdpzrGf2/A== X-Received: by 2002:adf:f7d2:: with SMTP id a18mr4318278wrq.47.1610122461246; Fri, 08 Jan 2021 08:14:21 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 2/2] docs: Build and install all the docs in a single manual Date: Fri, 8 Jan 2021 16:14:16 +0000 Message-Id: <20210108161416.21129-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210108161416.21129-1-peter.maydell@linaro.org> References: <20210108161416.21129-1-peter.maydell@linaro.org> 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=2a00:1450:4864:20::42f; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42f.google.com 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, 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 , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @linaro.org) Content-Type: text/plain; charset="utf-8" When we first converted our documentation to Sphinx, we split it into multiple manuals (system, interop, tools, etc), which are all built separately. The primary driver for this was wanting to be able to avoid shipping the 'devel' manual to end-users. However, this is working against the grain of the way Sphinx wants to be used and causes some annoyances: * Cross-references between documents become much harder or possibly impossible * There is no single index to the whole documentation * Within one manual there's no links or table-of-contents info that lets you easily navigate to the others * The devel manual doesn't get published on the QEMU website (it would be nice to able to refer to it there) Merely hiding our developer documentation from end users seems like it's not enough benefit for these costs. Combine all the documentation into a single manual (the same way that the readthedocs site builds it) and install the whole thing. The previous manual divisions remain as the new top level sections in the manual. * The per-manual conf.py files are no longer needed * The man_pages[] specifications previously in each per-manual conf.py move to the top level conf.py * docs/meson.build logic is simplified as we now only need to run Sphinx once for the HTML and then once for the manpages5B * The old index.html.in that produced the top-level page with links to each manual is no longer needed Unfortunately this means that we now have to build the HTML documentation into docs/manual in the build tree rather than directly into docs/; otherwise it is too awkward to ensure we install only the built manual and not also the dependency info, stamp file, etc. The manual still ends up in the same place in the final installed directory, but anybody who was consulting documentation from within the build tree will have to adjust where they're looking. Signed-off-by: Peter Maydell Reviewed-by: Paolo Bonzini --- v1->v2: rebase to cope with the two new manpages since v1 --- docs/conf.py | 46 ++++++++++++++++++++++++++++++- docs/devel/conf.py | 15 ----------- docs/index.html.in | 17 ------------ docs/interop/conf.py | 28 ------------------- docs/meson.build | 64 +++++++++++++++++--------------------------- docs/specs/conf.py | 16 ----------- docs/system/conf.py | 28 ------------------- docs/tools/conf.py | 37 ------------------------- docs/user/conf.py | 15 ----------- 9 files changed, 70 insertions(+), 196 deletions(-) delete mode 100644 docs/devel/conf.py delete mode 100644 docs/index.html.in delete mode 100644 docs/interop/conf.py delete mode 100644 docs/specs/conf.py delete mode 100644 docs/system/conf.py delete mode 100644 docs/tools/conf.py delete mode 100644 docs/user/conf.py diff --git a/docs/conf.py b/docs/conf.py index d40d8ff37ba..2ee61118725 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -224,7 +224,51 @@ latex_documents =3D [ =20 # -- Options for manual page output --------------------------------------- # Individual manual/conf.py can override this to create man pages -man_pages =3D [] +man_pages =3D [ + ('interop/qemu-ga', 'qemu-ga', + 'QEMU Guest Agent', + ['Michael Roth '], 8), + ('interop/qemu-ga-ref', 'qemu-ga-ref', + 'QEMU Guest Agent Protocol Reference', + [], 7), + ('interop/qemu-qmp-ref', 'qemu-qmp-ref', + 'QEMU QMP Reference Manual', + [], 7), + ('interop/qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref', + 'QEMU Storage Daemon QMP Reference Manual', + [], 7), + ('system/qemu-manpage', 'qemu', + 'QEMU User Documentation', + ['Fabrice Bellard'], 1), + ('system/qemu-block-drivers', 'qemu-block-drivers', + 'QEMU block drivers reference', + ['Fabrice Bellard and the QEMU Project developers'], 7), + ('system/qemu-cpu-models', 'qemu-cpu-models', + 'QEMU CPU Models', + ['The QEMU Project developers'], 7), + ('tools/qemu-img', 'qemu-img', + 'QEMU disk image utility', + ['Fabrice Bellard'], 1), + ('tools/qemu-nbd', 'qemu-nbd', + 'QEMU Disk Network Block Device Server', + ['Anthony Liguori '], 8), + ('tools/qemu-pr-helper', 'qemu-pr-helper', + 'QEMU persistent reservation helper', + [], 8), + ('tools/qemu-storage-daemon', 'qemu-storage-daemon', + 'QEMU storage daemon', + [], 1), + ('tools/qemu-trace-stap', 'qemu-trace-stap', + 'QEMU SystemTap trace tool', + [], 1), + ('tools/virtfs-proxy-helper', 'virtfs-proxy-helper', + 'QEMU 9p virtfs proxy filesystem helper', + ['M. Mohan Kumar'], 1), + ('tools/virtiofsd', 'virtiofsd', + 'QEMU virtio-fs shared file system daemon', + ['Stefan Hajnoczi ', + 'Masayoshi Mizuma '], 1), +] =20 # -- Options for Texinfo output ------------------------------------------- =20 diff --git a/docs/devel/conf.py b/docs/devel/conf.py deleted file mode 100644 index 7441f87e7f5..00000000000 --- a/docs/devel/conf.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'devel' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D u'Developer''s Guide' diff --git a/docs/index.html.in b/docs/index.html.in deleted file mode 100644 index 33db4396ac8..00000000000 --- a/docs/index.html.in +++ /dev/null @@ -1,17 +0,0 @@ - - - - - QEMU @VERSION@ Documentation - - -

QEMU @VERSION@ Documentation

- - - diff --git a/docs/interop/conf.py b/docs/interop/conf.py deleted file mode 100644 index f4370aaa13f..00000000000 --- a/docs/interop/conf.py +++ /dev/null @@ -1,28 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'interop' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D u'System Emulation Management and In= teroperability Guide' - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages =3D [ - ('qemu-ga', 'qemu-ga', u'QEMU Guest Agent', - ['Michael Roth '], 8), - ('qemu-ga-ref', 'qemu-ga-ref', 'QEMU Guest Agent Protocol Reference', - [], 7), - ('qemu-qmp-ref', 'qemu-qmp-ref', 'QEMU QMP Reference Manual', - [], 7), - ('qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref', - 'QEMU Storage Daemon QMP Reference Manual', [], 7), -] diff --git a/docs/meson.build b/docs/meson.build index fae9849b79b..bb14eaebd3b 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -46,19 +46,11 @@ if build_docs meson.source_root() / 'docs/sphinx/qmp_lexer.py', qapi_gen_depends ] =20 - configure_file(output: 'index.html', - input: files('index.html.in'), - configuration: {'VERSION': meson.project_version()}, - install_dir: qemu_docdir) - manuals =3D [ 'devel', 'interop', 'tools', 'specs', 'system', 'user' ] man_pages =3D { - 'interop' : { 'qemu-ga.8': (have_tools ? 'man8' : ''), 'qemu-ga-ref.7': 'man7', 'qemu-qmp-ref.7': 'man7', 'qemu-storage-daemon-qmp-ref.7': (have_tools ? 'man7' : ''), - }, - 'tools': { 'qemu-img.1': (have_tools ? 'man1' : ''), 'qemu-nbd.8': (have_tools ? 'man8' : ''), 'qemu-pr-helper.8': (have_tools ? 'man8' : ''), @@ -66,53 +58,47 @@ if build_docs 'qemu-trace-stap.1': (config_host.has_key('CONFIG_TRACE_SYSTEMTAP'= ) ? 'man1' : ''), 'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''), 'virtiofsd.1': (have_virtiofsd ? 'man1' : ''), - }, - 'system': { 'qemu.1': 'man1', 'qemu-block-drivers.7': 'man7', 'qemu-cpu-models.7': 'man7' - }, } =20 sphinxdocs =3D [] sphinxmans =3D [] - foreach manual : manuals - private_dir =3D meson.current_build_dir() / (manual + '.p') - output_dir =3D meson.current_build_dir() / manual - input_dir =3D meson.current_source_dir() / manual =20 - this_manual =3D custom_target(manual + ' manual', + private_dir =3D meson.current_build_dir() / 'manual.p' + output_dir =3D meson.current_build_dir() / 'manual' + input_dir =3D meson.current_source_dir() + + this_manual =3D custom_target('QEMU manual', build_by_default: build_docs, - output: [manual + '.stamp'], - input: [files('conf.py'), files(manual / 'conf.py')], - depfile: manual + '.d', + output: 'docs.stamp', + input: files('conf.py'), + depfile: 'docs.d', depend_files: sphinx_extn_depends, command: [SPHINX_ARGS, '-Ddepfile=3D@DEPFILE@', '-Ddepfile_stamp=3D@OUTPUT0@', '-b', 'html', '-d', private_dir, input_dir, output_dir]) - sphinxdocs +=3D this_manual - if build_docs and manual !=3D 'devel' - install_subdir(output_dir, install_dir: qemu_docdir) - endif + sphinxdocs +=3D this_manual + install_subdir(output_dir, install_dir: qemu_docdir, strip_directory: tr= ue) =20 - these_man_pages =3D [] - install_dirs =3D [] - foreach page, section : man_pages.get(manual, {}) - these_man_pages +=3D page - install_dirs +=3D section =3D=3D '' ? false : get_option('mandir') /= section - endforeach - if these_man_pages.length() > 0 - sphinxmans +=3D custom_target(manual + ' man pages', - build_by_default: build_docs, - output: these_man_pages, - input: this_manual, - install: build_docs, - install_dir: install_dirs, - command: [SPHINX_ARGS, '-b', 'man', '-d', private= _dir, - input_dir, meson.current_build_dir()]) - endif + these_man_pages =3D [] + install_dirs =3D [] + foreach page, section : man_pages + these_man_pages +=3D page + install_dirs +=3D section =3D=3D '' ? false : get_option('mandir') / s= ection endforeach + + sphinxmans +=3D custom_target('QEMU man pages', + build_by_default: build_docs, + output: these_man_pages, + input: this_manual, + install: build_docs, + install_dir: install_dirs, + command: [SPHINX_ARGS, '-b', 'man', '-d', pr= ivate_dir, + input_dir, meson.current_build_dir= ()]) + alias_target('sphinxdocs', sphinxdocs) alias_target('html', sphinxdocs) alias_target('man', sphinxmans) diff --git a/docs/specs/conf.py b/docs/specs/conf.py deleted file mode 100644 index 4d56f3ae13c..00000000000 --- a/docs/specs/conf.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'specs' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D \ - u'System Emulation Guest Hardware Specifications' diff --git a/docs/system/conf.py b/docs/system/conf.py deleted file mode 100644 index 6251849fefc..00000000000 --- a/docs/system/conf.py +++ /dev/null @@ -1,28 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'system' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D u'System Emulation User''s Guide' - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages =3D [ - ('qemu-manpage', 'qemu', u'QEMU User Documentation', - ['Fabrice Bellard'], 1), - ('qemu-block-drivers', 'qemu-block-drivers', - u'QEMU block drivers reference', - ['Fabrice Bellard and the QEMU Project developers'], 7), - ('qemu-cpu-models', 'qemu-cpu-models', - u'QEMU CPU Models', - ['The QEMU Project developers'], 7) -] diff --git a/docs/tools/conf.py b/docs/tools/conf.py deleted file mode 100644 index 7072d993246..00000000000 --- a/docs/tools/conf.py +++ /dev/null @@ -1,37 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'tools' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D \ - u'Tools Guide' - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages =3D [ - ('qemu-img', 'qemu-img', u'QEMU disk image utility', - ['Fabrice Bellard'], 1), - ('qemu-storage-daemon', 'qemu-storage-daemon', u'QEMU storage daemon', - [], 1), - ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', - ['Anthony Liguori '], 8), - ('qemu-pr-helper', 'qemu-pr-helper', 'QEMU persistent reservation help= er', - [], 8), - ('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool', - [], 1), - ('virtfs-proxy-helper', 'virtfs-proxy-helper', - u'QEMU 9p virtfs proxy filesystem helper', - ['M. Mohan Kumar'], 1), - ('virtiofsd', 'virtiofsd', u'QEMU virtio-fs shared file system daemon', - ['Stefan Hajnoczi ', - 'Masayoshi Mizuma '], 1), -] diff --git a/docs/user/conf.py b/docs/user/conf.py deleted file mode 100644 index 4b09aedd454..00000000000 --- a/docs/user/conf.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QEMU documentation build configuration file for the 'user' manual. -# -# This includes the top level conf file and then makes any necessary tweak= s. -import sys -import os - -qemu_docdir =3D os.path.abspath("..") -parent_config =3D os.path.join(qemu_docdir, "conf.py") -exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) - -# This slightly misuses the 'description', but is the best way to get -# the manual title to appear in the sidebar. -html_theme_options['description'] =3D u'User Mode Emulation User''s Guide' --=20 2.20.1