From nobody Thu Nov 13 19:24:55 2025 Delivered-To: importer@patchew.org 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; 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=1582628607; cv=none; d=zohomail.com; s=zohoarc; b=hMdcwckBO1eDwlQHGBANN0s7hlCyucORsQIUma9a3mAT8dCRCOsJ73BORRgwmcPAH6EsuFZaUQ+vmL2F7vzQp1z9M7nECUEgxi3FrPubp811RYjOnrvmiFLTZxsUIwJweHtoshTJgtfe34NS9AWANlViuBPRWj/cz5EbXtKpsw4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1582628607; h=Content-Transfer-Encoding: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=pdxIq/NO+K6PV8qogHqN82Q6uuaSbpCxqiilOGy4s0U=; b=G3ls7QDAlcSv2uXu+q1duw9q8XVC/ioIaNVlUYJOOkK9X6pIoHkI7iEea6bSyn/5aA3s3RAFGFeP4H8yjKIJXqdhNL+pfKGph0o9NqZtOk0dMDnrIW9u0vrrBRh+rblCtVmb4eWjLzf/JjD3Cbx5kAAerSmJV6Sbug3muUIBMcU= 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 158262860689828.056401740687306; Tue, 25 Feb 2020 03:03:26 -0800 (PST) Received: from localhost ([::1]:52520 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Xzo-0005rT-VZ for importer@patchew.org; Tue, 25 Feb 2020 06:03:24 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:38823) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Xyk-0004tA-N0 for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:22 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j6Xyg-00077X-Pi for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:18 -0500 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:52396) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j6Xyg-000761-IB for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:14 -0500 Received: by mail-wm1-x32c.google.com with SMTP id p9so2527324wmc.2 for ; Tue, 25 Feb 2020 03:02:11 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id n8sm22483092wrx.42.2020.02.25.03.02.07 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2020 03:02:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=pdxIq/NO+K6PV8qogHqN82Q6uuaSbpCxqiilOGy4s0U=; b=MKz3Vnx+GIRe3qVZhciHc5WbP36mXDpYkTb1Ptwf2SEULnboLci3I+pEQ1wNGYdvd2 KAm4lVadZ4V3GU0mFVJPr0V423kzE+jpvGG0LhxkcEznAixj/keIxi+/BAEXVyGet9ZW JSIo050uTi05Y/UFsPMqng0qt2AyKq4gawEQWt0hKa0LkaZLBPPIrtvQC6HIReccNT19 IsI3HymxAugAXzfZ3WRqsyYffvcTOG8ibZhsu7WB6b4SscDVXshQbIDJX9ByhBXJwNvH mB4VyhJ61ERFP1/RZTa+hcm5G4jQ6veZD2TnvH4XSJL4CffcW6hq6Z9FwQWgmTa69dYG K/+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pdxIq/NO+K6PV8qogHqN82Q6uuaSbpCxqiilOGy4s0U=; b=Bw5y9ySPtUiRt9vaPyiAHmFPKDUMRZKH8ehXmrX8t+J353MhX5KxmwQGJn11Bjvqzd 7lbXaNqCT+syt8iI6mrrH02O2AZqdRYWw7vTdrXsdzRNVtPo5TpNST+6GQtrXiw+/TLF kk8HFsBNu6Qa7HD4E2JG3f/waoU3d0P0uswGDTlFahIltmoRy795xlC9JMZlFNFrRNjx nkwZVn3P3puAYll1HvnvMhwiN7r9F5qts6mzzdxkCy0HldCU3Lu6eAxSxKnBco070bzU 39RQZP0MTFvFMpHnl3fOczUQt4NWKHvdl0bGgUbjuwqVbbE6VgiABFGdINnxZlbxS/Ls 59/A== X-Gm-Message-State: APjAAAUebJbaamVr7riTHwxycixMec9PspDZHocT1ELFQvXWQdWltOiD z9CbJyQEnDeQDokkun/3hEc65whkPNWrLg== X-Google-Smtp-Source: APXvYqzNy0eZLkU35MNy4I8URmfdMYgXMytQwZAsiilfW8Bk4Dc1jpKU/+ouF/9xCKJxcu6KGzF5fw== X-Received: by 2002:a7b:c4cc:: with SMTP id g12mr5041242wmk.68.1582628529119; Tue, 25 Feb 2020 03:02:09 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 1/3] docs: Create new 'tools' manual Date: Tue, 25 Feb 2020 11:02:02 +0000 Message-Id: <20200225110204.30662-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200225110204.30662-1-peter.maydell@linaro.org> References: <20200225110204.30662-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32c 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: , 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" Some of the documentation for QEMU "tools" which are standalone binaries like qemu-img is an awkward fit in our current 5-manual split. We've put it into "interop", but they're not really about interoperability. Create a new top level manual "tools" which will be a better home for this documentation. This commit creates an empty initial manual; we will move the relevant documentation files in a subsequent commit. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Acked-by: Paolo Bonzini Message-id: 20200217155415.30949-2-peter.maydell@linaro.org --- Makefile | 8 +++++++- docs/index.html.in | 1 + docs/index.rst | 1 + docs/tools/conf.py | 16 ++++++++++++++++ docs/tools/index.rst | 11 +++++++++++ 5 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/tools/conf.py create mode 100644 docs/tools/index.rst diff --git a/Makefile b/Makefile index 15f8e53d050..c4c2eba7a7c 100644 --- a/Makefile +++ b/Makefile @@ -786,6 +786,7 @@ distclean: clean $(call clean-manual,interop) $(call clean-manual,specs) $(call clean-manual,system) + $(call clean-manual,tools) for d in $(TARGET_DIRS); do \ rm -rf $$d || exit 1 ; \ done @@ -843,6 +844,7 @@ install-sphinxdocs: sphinxdocs $(call install-manual,interop) $(call install-manual,specs) $(call install-manual,system) + $(call install-manual,tools) =20 install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" @@ -1036,7 +1038,8 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ $(MANUAL_BUILDDIR)/interop/index.html \ $(MANUAL_BUILDDIR)/specs/index.html \ - $(MANUAL_BUILDDIR)/system/index.html + $(MANUAL_BUILDDIR)/system/index.html \ + $(MANUAL_BUILDDIR)/tools/index.html =20 # Canned command to build a single manual # Arguments: $1 =3D manual name, $2 =3D Sphinx builder ('html' or 'man') @@ -1069,6 +1072,9 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-de= ps,specs) $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(call build-manual,system,html) =20 +$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) + $(call build-manual,tools,html) + $(call define-manpage-rule,interop,\ qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ virtiofsd.1 virtfs-proxy-helper.1,\ diff --git a/docs/index.html.in b/docs/index.html.in index 8512933d145..cf61b1cf448 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -13,6 +13,7 @@
  • System Emulation Management= and Interoperability Guide
  • System Emulation Guest Hardwa= re Specifications
  • System Emulation User's Guid= e
    • +
  • Tools Guide
    • diff --git a/docs/index.rst b/docs/index.rst index 46405d4f077..acd604fa8a9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,3 +14,4 @@ Welcome to QEMU's documentation! devel/index specs/index system/index + tools/index diff --git a/docs/tools/conf.py b/docs/tools/conf.py new file mode 100644 index 00000000000..56461110b9d --- /dev/null +++ b/docs/tools/conf.py @@ -0,0 +1,16 @@ +# -*- 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' diff --git a/docs/tools/index.rst b/docs/tools/index.rst new file mode 100644 index 00000000000..c5a4a13ec7a --- /dev/null +++ b/docs/tools/index.rst @@ -0,0 +1,11 @@ +.. This is the top level page for the 'tools' manual + + +QEMU Tools Guide +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + +Contents: + +.. toctree:: + :maxdepth: 2 --=20 2.20.1 From nobody Thu Nov 13 19:24:55 2025 Delivered-To: importer@patchew.org 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; 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=1582628606; cv=none; d=zohomail.com; s=zohoarc; b=bB3NVAxpNIdoWkh96cM4g3L3lWqW4gynIIwJN9w+laqpOEVRrO1hYDAcH58SymAJ8+m1HubEiRaOSzLgg2NFYJ5GgDkX7trOw4aR0/mqTT2aLCCULY6aOjmAKdO1Lt+oH3THrpuNeMac4E0x4CbSbNP7KOsedbmbdmaRI6bA0zU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1582628606; h=Content-Transfer-Encoding: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=2WeRFxRDj29Rw57/hlFSEnuTXmXxVpiUVgtHYi4nBgQ=; b=XhKOEEpZXsazM0jl70pXkjEBAjYemiw+ZwpxGWcWWROI/zHHaQlYtcD6thLfVG6PQTRatvn9ewz2fxWNKOHCMsokJPV97jdcQJ1LFq/48xMnhu3x6eoKQdafGM5Nyt+N9TLR0xA6AQnSZZmC9KXT8Fgs56IOKTDUbod3c5yqmSY= 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 1582628606502249.47101669622873; Tue, 25 Feb 2020 03:03:26 -0800 (PST) Received: from localhost ([::1]:52516 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Xzo-0005rE-PB for importer@patchew.org; Tue, 25 Feb 2020 06:03:24 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:38820) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Xyk-0004sp-N4 for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:22 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j6Xyg-00077N-Lz for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:18 -0500 Received: from mail-wr1-x42a.google.com ([2a00:1450:4864:20::42a]:45151) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j6Xyg-00076F-Fi for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:14 -0500 Received: by mail-wr1-x42a.google.com with SMTP id g3so14142274wrs.12 for ; Tue, 25 Feb 2020 03:02:12 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id n8sm22483092wrx.42.2020.02.25.03.02.09 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2020 03:02:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=2WeRFxRDj29Rw57/hlFSEnuTXmXxVpiUVgtHYi4nBgQ=; b=us8CBfRkUh6PwMMzAeIMdFOve4vmfj3T4QgEXnW3tXuRY6cvWkaf0mtRJc99EgbgEZ jqHqcZsj7ra0MaSIj4lKjtZ9LQIvl4GcYOXppB9z+FzgrvRoVRB1OTVEs8kDc+tkkGXF kkYgrwNg2Iv4TmKXywNXk2thysFLCCjoHrSnZxHIqotjLOPp5/3VHwPuwUIZJUlQilrb VWoEHXdWMwWbgEiVRCY+5Ai9PU+s6XbNfuyEL1Xa6svd5ENno3sgacIlVDpKmsvRKwfv +nzqhCEwW8FrbWhfXbgrlDTn9ZiGPPIBDfsVnusrrBNq4wi6XKb0Gv8lBLTnwNo+R/3s Nazw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=2WeRFxRDj29Rw57/hlFSEnuTXmXxVpiUVgtHYi4nBgQ=; b=Ar8Fsd7IkiUT0tiyeIjrUF0+A2W64KAmcA/qlxzJrZKwOjLLzLZzgTYBDsH5nE2zjD IrE7Zb3iE/dDprGZTEjdzXbmKhqGONoQ1hSwuz+YopUkosRPGCxSHmLXuKcbcLhWByqU oSw1/xX6K63GfVwWDNt4c5Q6l0ltW6My4QN4lEBhpBMJNqzVfijjsiJngvENRDnyf6gE 5HRw9CqfivI4v4ofXTTOB/KmMbgeXy20AHrgxCArl29cPJ0MamehnprleZNP4vIBXIZ6 VLi0nzqp7ej1d2LhWp6+YosCVg8JaQcgwTUl+el6Xk5QSVaJVl//t3t3VGqM6s3RlJWJ Euzg== X-Gm-Message-State: APjAAAXkOzsHCsuYQfRBzVHpM26yt/g6XbIZpqD5PvuzWFW8hghb9LOb wD7s8ki9GiFdiO3zpnSjvLQosUKHG30R6Q== X-Google-Smtp-Source: APXvYqzN3GpptnWglr1sHzqpr5fi36O37NokdPsxQcInJMu9m3rCJacQn0Njs9sKw5d1z+NrVKGfDA== X-Received: by 2002:a5d:534d:: with SMTP id t13mr76229720wrv.77.1582628530594; Tue, 25 Feb 2020 03:02:10 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 2/3] docs: Move qemu-option-trace.rst.inc to docs/ Date: Tue, 25 Feb 2020 11:02:03 +0000 Message-Id: <20200225110204.30662-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200225110204.30662-1-peter.maydell@linaro.org> References: <20200225110204.30662-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42a 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: , 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" The qemu-option-trace.rst.inc file contains a rST documentation fragment which describes trace options common to qemu-nbd and qemu-img. We put this file into interop/, but we'd like to move the qemu-nbd and qemu-img files into the tools/ manual. We could move the .rst.inc file along with them, but we're eventually going to want to use it for the main QEMU binary options documentation too, and that will be in system/. So move qemu-option-trace.rst.inc to the top-level docs/ directory, where all these files can include it via .. include:: ../qemu-option-trace.rst.inc This does have the slight downside that we now need to explicitly tell Make which manuals use this file rather than relying on a wildcard for all .rst.inc in the manual. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Acked-by: Paolo Bonzini Message-id: 20200217155415.30949-3-peter.maydell@linaro.org --- Makefile | 5 ++--- docs/interop/qemu-img.rst | 2 +- docs/interop/qemu-nbd.rst | 2 +- docs/{interop =3D> }/qemu-option-trace.rst.inc | 0 4 files changed, 4 insertions(+), 5 deletions(-) rename docs/{interop =3D> }/qemu-option-trace.rst.inc (100%) diff --git a/Makefile b/Makefile index c4c2eba7a7c..4a27be1cde9 100644 --- a/Makefile +++ b/Makefile @@ -1049,7 +1049,6 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ build-manual =3D $(call quiet-command,CONFDIR=3D"$(qemu_confdir)" $(SPHINX= _BUILD) $(if $(V),,-q) -W -b $2 -D version=3D$(VERSION) -D release=3D"$(FUL= L_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"= SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) \ - $(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \ $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py # Macro to write out the rule and dependencies for building manpages # Usage: $(call define-manpage-rule,manualname,manpage1 manpage2...[,extra= deps]) @@ -1063,7 +1062,7 @@ endef $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel) $(call build-manual,devel,html) =20 -$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx +$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc $(call build-manual,interop,html) =20 $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) @@ -1078,7 +1077,7 @@ $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-de= ps,tools) $(call define-manpage-rule,interop,\ qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ virtiofsd.1 virtfs-proxy-helper.1,\ - $(SRC_PATH)/qemu-img-cmds.hx) + $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst= .inc) =20 $(call define-manpage-rule,system,qemu-block-drivers.7) =20 diff --git a/docs/interop/qemu-img.rst b/docs/interop/qemu-img.rst index 5f40137c100..0080f83a76c 100644 --- a/docs/interop/qemu-img.rst +++ b/docs/interop/qemu-img.rst @@ -34,7 +34,7 @@ Standard options: =20 .. option:: -T, --trace [[enable=3D]PATTERN][,events=3DFILE][,file=3DFILE] =20 - .. include:: qemu-option-trace.rst.inc + .. include:: ../qemu-option-trace.rst.inc =20 The following commands are supported: =20 diff --git a/docs/interop/qemu-nbd.rst b/docs/interop/qemu-nbd.rst index e5484031005..667861cb22e 100644 --- a/docs/interop/qemu-nbd.rst +++ b/docs/interop/qemu-nbd.rst @@ -188,7 +188,7 @@ driver options if ``--image-opts`` is specified. =20 .. option:: -T, --trace [[enable=3D]PATTERN][,events=3DFILE][,file=3DFILE] =20 - .. include:: qemu-option-trace.rst.inc + .. include:: ../qemu-option-trace.rst.inc =20 Examples -------- diff --git a/docs/interop/qemu-option-trace.rst.inc b/docs/qemu-option-trac= e.rst.inc similarity index 100% rename from docs/interop/qemu-option-trace.rst.inc rename to docs/qemu-option-trace.rst.inc --=20 2.20.1 From nobody Thu Nov 13 19:24:55 2025 Delivered-To: importer@patchew.org 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; 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=1582628672; cv=none; d=zohomail.com; s=zohoarc; b=DM3nN1CQsaVtyAFBN/4ljKydeT6powi34Y3KIsZyhLINwqyMt1KwKD2jlmD6q369A5R+T7+nOxYxyX0SX0sqYRBhjmo4IubGqk/PxNMkvWWW7kBa6wfDey8DTGjJaA7s5H5xxLsR4/ycKuQOOywhT1Qd66JeEoCzMxBNI+Fzxyk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1582628672; h=Content-Transfer-Encoding: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=PtxbDOBMx6p+An2FpQ44ggkkspN0k4H+aZiaMFFsuGI=; b=Kj7fRniMnQ64HdGnrkKHNeDf+/Or6F5BFFI1nCrVWFFraYnFDe4Xc8nMVAPoucrvhzUVjCdIIjVTD1DKJkYxqDxzBkE38rUtEBKOV1R+Wqu4lix1qypeMFF7tAPLmVtFRFgLAvWsvizZNGOoZtJj7Xru4htoveWPid2hj3M2mfM= 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 1582628672078804.9970260141665; Tue, 25 Feb 2020 03:04:32 -0800 (PST) Received: from localhost ([::1]:52542 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Y0s-0007Zp-TW for importer@patchew.org; Tue, 25 Feb 2020 06:04:30 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:38840) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j6Xym-0004tv-DD for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:27 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j6Xyg-00077d-Q0 for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:20 -0500 Received: from mail-wm1-x331.google.com ([2a00:1450:4864:20::331]:55943) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j6Xyg-00076Z-IH for qemu-devel@nongnu.org; Tue, 25 Feb 2020 06:02:14 -0500 Received: by mail-wm1-x331.google.com with SMTP id q9so2513087wmj.5 for ; Tue, 25 Feb 2020 03:02:13 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id n8sm22483092wrx.42.2020.02.25.03.02.10 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2020 03:02:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=PtxbDOBMx6p+An2FpQ44ggkkspN0k4H+aZiaMFFsuGI=; b=xVood9GLoeTzxCRdKpAzMFN6Vk5jQAxOgFEz+voNNzXBQLXsXjZuVQ9UdQQ+Y0q6aA HkIflEFjIv1xwrUjmP4y1LJkgMfoGq7pfMZsRAIssVJbCp0sIfa2A9iJl44qM3gldW22 5UlBVge0ban7Vf7F1KfsVuFGEVPl9R1PKP1gQfAe/X0FAUuFqvIHzO/SJ9jRs0jjZQXn O4ejSrsxnqwyhH2GQY0g5UVMmto+R3Bg7ByZc3+LE0IvjC1C6dhzm+HbHgW55yPVqRrR R/NLdzefP+dRgKIvMuKTQltOG/rHSLsGwKT6tVCSFlfEKz84O2aUcRzPZpidxsl2Ccb1 Xqww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=PtxbDOBMx6p+An2FpQ44ggkkspN0k4H+aZiaMFFsuGI=; b=m7anyoqDK/JHMaV9l7B0hDdyhq3UJAyJC30iknUlrhlgPG2x+a2r9/p1DVOxVc7LDT qXQdlgUy/uX/ESfFcTh44RYxYinmMh8XZ0/u94GdVo1WTFvJI55WUgGYK1qhpProxfDP rzPmkgSxft+XI2L0oLCYGgQAW9YE5u9SbbsT+4hpwuqBILdH5nYUx4wiSTrq4Gi4LuLF HJ9qJHjasHecHuEN1o8TpbLzF3OS7NoVwLAhOzbEJDvk+pUZKWxhMEMqUAZLotHixUfT HFJeKbRI8ULw2bq53AC5CV1+YTlibLvxXZls3T67tfvl9R/ExsE9U9pfiZEuH9RV20Le U7gg== X-Gm-Message-State: APjAAAVwo1A9DwsKlkTH2GeYe9gcbEgbHefDEY3rfs396DOhj3DVPfGp 1Tvi/XfOwHP4+zNxuNbUDHzyvBYgh1Ipcg== X-Google-Smtp-Source: APXvYqwPsxU+pyWxcxOstNFzk+t0ezYkCaUsb/G71BHhF+5wiZcmNLE/W1N8CpMlkAnQMNSblb0AEQ== X-Received: by 2002:a1c:2645:: with SMTP id m66mr4574920wmm.98.1582628531895; Tue, 25 Feb 2020 03:02:11 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 3/3] docs: Move tools documentation to tools manual Date: Tue, 25 Feb 2020 11:02:04 +0000 Message-Id: <20200225110204.30662-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200225110204.30662-1-peter.maydell@linaro.org> References: <20200225110204.30662-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::331 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: , 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" Move the following tools documentation files to the new tools manual: docs/interop/qemu-img.rst docs/interop/qemu-nbd.rst docs/interop/virtfs-proxy-helper.rst docs/interop/qemu-trace-stap.rst docs/interop/virtiofsd.rst Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Acked-by: Paolo Bonzini Message-id: 20200217155415.30949-4-peter.maydell@linaro.org --- Makefile | 34 ++++++++++--------- docs/interop/conf.py | 12 ------- docs/interop/index.rst | 5 --- docs/tools/conf.py | 17 ++++++++++ docs/tools/index.rst | 6 ++++ docs/{interop =3D> tools}/qemu-img.rst | 0 docs/{interop =3D> tools}/qemu-nbd.rst | 0 docs/{interop =3D> tools}/qemu-trace-stap.rst | 0 .../virtfs-proxy-helper.rst | 0 docs/{interop =3D> tools}/virtiofsd.rst | 0 10 files changed, 41 insertions(+), 33 deletions(-) rename docs/{interop =3D> tools}/qemu-img.rst (100%) rename docs/{interop =3D> tools}/qemu-nbd.rst (100%) rename docs/{interop =3D> tools}/qemu-trace-stap.rst (100%) rename docs/{interop =3D> tools}/virtfs-proxy-helper.rst (100%) rename docs/{interop =3D> tools}/virtiofsd.rst (100%) diff --git a/Makefile b/Makefile index 4a27be1cde9..aa9cc0b5847 100644 --- a/Makefile +++ b/Makefile @@ -345,11 +345,11 @@ endif =20 ifdef BUILD_DOCS DOCS=3Dqemu-doc.html qemu-doc.txt qemu.1 -DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-img.1 -DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-nbd.8 +DOCS+=3D$(MANUAL_BUILDDIR)/tools/qemu-img.1 +DOCS+=3D$(MANUAL_BUILDDIR)/tools/qemu-nbd.8 DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-ga.8 ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy) -DOCS+=3D$(MANUAL_BUILDDIR)/interop/virtiofsd.1 +DOCS+=3D$(MANUAL_BUILDDIR)/tools/virtiofsd.1 endif DOCS+=3D$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/= interop/qemu-qmp-ref.7 @@ -357,10 +357,10 @@ DOCS+=3Ddocs/interop/qemu-ga-ref.html docs/interop/qe= mu-ga-ref.txt docs/interop/qe DOCS+=3Ddocs/qemu-cpu-models.7 DOCS+=3D$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS -DOCS+=3D$(MANUAL_BUILDDIR)/interop/virtfs-proxy-helper.1 +DOCS+=3D$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1 endif ifdef CONFIG_TRACE_SYSTEMTAP -DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-trace-stap.1 +DOCS+=3D$(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1 endif else DOCS=3D @@ -861,12 +861,12 @@ ifdef CONFIG_POSIX $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR= )$(mandir)/man7" $(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7" ifeq ($(CONFIG_TOOLS),y) - $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-img.1 "$(DESTDIR)$(mandir= )/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-img.1 "$(DESTDIR)$(mandir)/= man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" - $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-nbd.8 "$(DESTDIR)$(mandir= )/man8" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-nbd.8 "$(DESTDIR)$(mandir)/= man8" endif ifdef CONFIG_TRACE_SYSTEMTAP - $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-trace-stap.1 "$(DESTDIR)$= (mandir)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1 "$(DESTDIR)$(m= andir)/man1" endif ifneq (,$(findstring qemu-ga,$(TOOLS))) $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)= /man8" @@ -877,10 +877,10 @@ endif endif ifdef CONFIG_VIRTFS $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" - $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/virtfs-proxy-helper.1 "$(DESTD= IR)$(mandir)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1 "$(DESTDIR= )$(mandir)/man1" endif ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy) - $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/virtiofsd.1 "$(DESTDIR)$(mandi= r)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtiofsd.1 "$(DESTDIR)$(mandir)= /man1" endif =20 install-datadir: @@ -1062,7 +1062,7 @@ endef $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel) $(call build-manual,devel,html) =20 -$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc +$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(call build-manual,interop,html) =20 $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) @@ -1071,16 +1071,18 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-= deps,specs) $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(call build-manual,system,html) =20 -$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) +$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)= /qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc $(call build-manual,tools,html) =20 -$(call define-manpage-rule,interop,\ - qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ - virtiofsd.1 virtfs-proxy-helper.1,\ - $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst= .inc) +$(call define-manpage-rule,interop,qemu-ga.8) =20 $(call define-manpage-rule,system,qemu-block-drivers.7) =20 +$(call define-manpage-rule,tools,\ + qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ + virtiofsd.1 virtfs-proxy-helper.1,\ + $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst= .inc) + $(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version= .h @mkdir -p "$(MANUAL_BUILDDIR)" $(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \ diff --git a/docs/interop/conf.py b/docs/interop/conf.py index b3cda17042c..42ce7e3d365 100644 --- a/docs/interop/conf.py +++ b/docs/interop/conf.py @@ -19,16 +19,4 @@ html_theme_options['description'] =3D u'System Emulation= Management and Interopera man_pages =3D [ ('qemu-ga', 'qemu-ga', u'QEMU Guest Agent', ['Michael Roth '], 8), - ('qemu-img', 'qemu-img', u'QEMU disk image utility', - ['Fabrice Bellard'], 1), - ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', - ['Anthony Liguori '], 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/interop/index.rst b/docs/interop/index.rst index e8455b4270c..049387ac6de 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -18,10 +18,5 @@ Contents: live-block-operations pr-helper qemu-ga - qemu-img - qemu-nbd - qemu-trace-stap vhost-user vhost-user-gpu - virtfs-proxy-helper - virtiofsd diff --git a/docs/tools/conf.py b/docs/tools/conf.py index 56461110b9d..9052d17d6d4 100644 --- a/docs/tools/conf.py +++ b/docs/tools/conf.py @@ -14,3 +14,20 @@ exec(compile(open(parent_config, "rb").read(), parent_co= nfig, 'exec')) # 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-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', + ['Anthony Liguori '], 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/tools/index.rst b/docs/tools/index.rst index c5a4a13ec7a..232ce9f3e46 100644 --- a/docs/tools/index.rst +++ b/docs/tools/index.rst @@ -9,3 +9,9 @@ Contents: =20 .. toctree:: :maxdepth: 2 + + qemu-img + qemu-nbd + qemu-trace-stap + virtfs-proxy-helper + virtiofsd diff --git a/docs/interop/qemu-img.rst b/docs/tools/qemu-img.rst similarity index 100% rename from docs/interop/qemu-img.rst rename to docs/tools/qemu-img.rst diff --git a/docs/interop/qemu-nbd.rst b/docs/tools/qemu-nbd.rst similarity index 100% rename from docs/interop/qemu-nbd.rst rename to docs/tools/qemu-nbd.rst diff --git a/docs/interop/qemu-trace-stap.rst b/docs/tools/qemu-trace-stap.= rst similarity index 100% rename from docs/interop/qemu-trace-stap.rst rename to docs/tools/qemu-trace-stap.rst diff --git a/docs/interop/virtfs-proxy-helper.rst b/docs/tools/virtfs-proxy= -helper.rst similarity index 100% rename from docs/interop/virtfs-proxy-helper.rst rename to docs/tools/virtfs-proxy-helper.rst diff --git a/docs/interop/virtiofsd.rst b/docs/tools/virtiofsd.rst similarity index 100% rename from docs/interop/virtiofsd.rst rename to docs/tools/virtiofsd.rst --=20 2.20.1