From nobody Mon Feb 9 11:30:18 2026 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1579788180; cv=none; d=zohomail.com; s=zohoarc; b=US55TpYjPVpOM459KlPxEF9miV8Of5co4grI1NGoSA6SZ9PKV9jxmve1x6cMKo4G8n2qRUuzUFqjKmAAcNjyqf471A48SZMhlkZsbU9QQggkXVbmRPo/FHgeDkzudMzXHZUj1iZvDZAMAQUlpJAFUI81NG/pioKho1pdg/KMc8k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579788180; h=Content-Type: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=lxR2CPoTBdsqUlKhDMI0yaffCU2qFxmoxCDzO85rOPA=; b=TycesJZoqKgCMvnjVsLbp9BQgPOi/KCBVKR5AOvwmUWug/OAgopEhfP7BCzSkYIUP+QtkKTkUeH3hjg6FSYweTtkCMuc7xDfTAC/cLWaZDFwEPDDMEdNnSpe3x2wYlqtm7auMIOZ5fib4c9XNdkMsjxlIzzyzBWLkXjl55U9+3I= 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 1579788180656566.9627545047982; Thu, 23 Jan 2020 06:03:00 -0800 (PST) Received: from localhost ([::1]:57594 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iud4T-0005GJ-QO for importer@patchew.org; Thu, 23 Jan 2020 09:02:57 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:40921) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iub9U-0002y1-FS for qemu-devel@nongnu.org; Thu, 23 Jan 2020 07:00:01 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iub9T-0005U8-45 for qemu-devel@nongnu.org; Thu, 23 Jan 2020 07:00:00 -0500 Received: from us-smtp-1.mimecast.com ([207.211.31.81]:38704 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iub9T-0005Tn-0U for qemu-devel@nongnu.org; Thu, 23 Jan 2020 06:59:59 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-267-zo4JF0osN3uJ8StNm7YaOA-1; Thu, 23 Jan 2020 06:59:55 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id E438A18A6EC1 for ; Thu, 23 Jan 2020 11:59:54 +0000 (UTC) Received: from dgilbert-t580.localhost (unknown [10.36.118.0]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3C54285782; Thu, 23 Jan 2020 11:59:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1579780798; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=lxR2CPoTBdsqUlKhDMI0yaffCU2qFxmoxCDzO85rOPA=; b=DGHO7PAcN+4Fp5tm39R3VW8Ix0m4UqpLTE2BRncMMgH+oQP7dpxR9jCf2lt4kFqvuYewZM 6AD4eYqwGckFBQjA98ENcdmHD1ZW7R3aQ5f1CKPVr2xkfHGBEWfLRluawMrXeAlhVaYtxl LYw28C98mR7lzkD4aUxt5APDO1GM90w= From: "Dr. David Alan Gilbert (git)" To: qemu-devel@nongnu.org, stefanha@redhat.com Subject: [PULL 058/111] docs: Add docs/tools Date: Thu, 23 Jan 2020 11:57:48 +0000 Message-Id: <20200123115841.138849-59-dgilbert@redhat.com> In-Reply-To: <20200123115841.138849-1-dgilbert@redhat.com> References: <20200123115841.138849-1-dgilbert@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: zo4JF0osN3uJ8StNm7YaOA-1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 207.211.31.81 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 @redhat.com) Content-Type: text/plain; charset="utf-8" From: "Dr. David Alan Gilbert" Create docs/tools based on docs/dev based on docs/devel. Signed-off-by: Dr. David Alan Gilbert Reviewed-by: Philippe Mathieu-Daud=C3=A9 Tested-by: Philippe Mathieu-Daud=C3=A9 Signed-off-by: Dr. David Alan Gilbert --- Makefile | 9 ++++++++- docs/index.rst | 1 + docs/tools/conf.py | 16 ++++++++++++++++ docs/tools/index.rst | 12 ++++++++++++ 4 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/tools/conf.py create mode 100644 docs/tools/index.rst diff --git a/Makefile b/Makefile index 6b4b075a92..60c35a9dd3 100644 --- a/Makefile +++ b/Makefile @@ -823,6 +823,7 @@ endef install-sphinxdocs: sphinxdocs $(call install-manual,interop) $(call install-manual,specs) + $(call install-manual,tools) =20 install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" @@ -1010,7 +1011,10 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.m= ak # and handles "don't rebuild things unless necessary" itself. # The '.doctrees' files are cached information to speed this up. .PHONY: sphinxdocs -sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop= /index.html $(MANUAL_BUILDDIR)/specs/index.html +sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ + $(MANUAL_BUILDDIR)/interop/index.html \ + $(MANUAL_BUILDDIR)/specs/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') @@ -1030,6 +1034,9 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-= deps,interop) $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(call build-manual,specs,html) =20 +$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) + $(call build-manual,tools,html) + $(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop) $(call build-manual,interop,man) =20 diff --git a/docs/index.rst b/docs/index.rst index baa5791c17..f15ca17bf4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,4 +13,5 @@ Welcome to QEMU's documentation! interop/index devel/index specs/index + tools/index =20 diff --git a/docs/tools/conf.py b/docs/tools/conf.py new file mode 100644 index 0000000000..f9f76ff597 --- /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' + diff --git a/docs/tools/index.rst b/docs/tools/index.rst new file mode 100644 index 0000000000..adbcd3bc72 --- /dev/null +++ b/docs/tools/index.rst @@ -0,0 +1,12 @@ +.. This is the top level page for the 'tools' manual. + + +QEMU tools +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This manual documents various tools included with QEMU. + +Contents: + +.. toctree:: + :maxdepth: 2 --=20 2.24.1