From nobody Mon May 20 21:02:35 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1560180401; cv=none; d=zoho.com; s=zohoarc; b=PwabWj0WDqAfZHMNu3G7WhZ/pNrbTGABtPOv0VSCANxUlTv/b9Wg++1/tu8Fz/vwzHkyYOWLssofpsnc2BS1VHX43/pVij0TNR1wcJuKSiYXdzYeMxSA1VDSNEzKkj2zwImEU65ZGh1gY3buxoZaQXwOvTeymV/zQR+QNlhVoLs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1560180401; 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:ARC-Authentication-Results; bh=IgI2nYXtMTWQuZTo46tbwj7ydKAr5pCkN5Cp13BKZXc=; b=EPEdMJYqBkb2jaLk5hHAOsL0dG51ErvO4aFj+nVYNU3blwwJaewt7yt4TstxkS5HNS8jCURtACGDpWZwUDQqvPj2Dki5G4hwUFBFLgY/Nu0PTEABqfQ6Awr0zvpq4/iyJ0VCsl9gFxK2oZOBt2i81w2x4ugH/EhqqqAszR6eRHc= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1560180401002644.6353573320854; Mon, 10 Jun 2019 08:26:41 -0700 (PDT) Received: from localhost ([::1]:47672 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haMBw-0005Gb-EV for importer@patchew.org; Mon, 10 Jun 2019 11:26:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47147) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haMAL-00045v-KG for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:25:00 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1haMAE-0004h4-CJ for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:24:56 -0400 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]:35185) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1haMAD-0004fS-5B for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:24:49 -0400 Received: by mail-wr1-x442.google.com with SMTP id m3so9649413wrv.2 for ; Mon, 10 Jun 2019 08:24:48 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b203sm11945920wmd.41.2019.06.10.08.24.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 10 Jun 2019 08:24:46 -0700 (PDT) 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=IgI2nYXtMTWQuZTo46tbwj7ydKAr5pCkN5Cp13BKZXc=; b=qCnz51+ce5UAT3cU/HBxcMyxzpuW93Q1N12QYcGSKlRM07DR04484zdYuU3HjOecOj EW2lVW+ZLhVzrrm3t2cMfcgNShY6gY2z1KKf6VpE2xiEXH4R5gpgYueviLZlCisZLntV ZU5aWioqaRl6aMdDeCjT2v1G0ReqwgzM6FP5mypdlQBT5a73OAiLdL99Z0kWySw7kHr8 ivvLR1+WCJyHoSS4gdsJ+dVBy9PEY2WqbmGGsdpx7CIZ1RcI5GSZdmT6u56nhjZOv/Ne p0zHpRdt77Akj4QGPgh+EzGFGzJiPcaE1xMvcQ/w5Ws2hLUMHPG9VCilEKand1+H8IyY 59Pw== 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=IgI2nYXtMTWQuZTo46tbwj7ydKAr5pCkN5Cp13BKZXc=; b=VwSrV6n1M9CvO7ybIcC3yFwWG6VbclhA48YYfK65Z4LBevmV115Wtln2WKeH3KOd1r wKvZT7T3PVySSCtCkle3xT+5HBhXlspoIG41DJf4fm99p7O+RWbp3hxw+sI6FisuUJmG I41GxU/7Ai83+CwpTb8JM7sTUULV+bj6HjdbQrwHMNIU5VwU/vZFwzvJ+vTGxiIxkj15 Edx0OMuowyhScsUdHA01WcSIS2cphDGDOuX1DetcJUt7vtBnvBiDgkNGzvHTVwH+vaV0 Z7Q+ZDmPwPE/Xh0WfIifPVQ3bohEbY2FW0v/rJD1mZSz5PvIk5jOe1FYKI592gXu18p3 hWAg== X-Gm-Message-State: APjAAAU6cy7V1wPF4NPvN2w4a2vemquB5ffS5PaSw4TlcBNfXgIWB0Xt Jg2eSusP1u0xfzCH8+HblUgDJdvWDYkDow== X-Google-Smtp-Source: APXvYqxkxhB+Bxei8PVYb4jshaBR+NAv2hfcQcGFDSdU/PXALPxcVyRcz6TRL/KH9W5u7GmYWg0bUw== X-Received: by 2002:a05:6000:1289:: with SMTP id f9mr7319935wrx.125.1560180287503; Mon, 10 Jun 2019 08:24:47 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Mon, 10 Jun 2019 16:24:43 +0100 Message-Id: <20190610152444.20859-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190610152444.20859-1-peter.maydell@linaro.org> References: <20190610152444.20859-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::442 Subject: [Qemu-devel] [PATCH 1/2] docs/specs/index.rst: Fix minor syntax issues 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 , John Snow , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , David Gibson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The docs/specs/index.rst has a couple of minor issues which we didn't notice because we weren't building the manual: * the ToC entry for the new PPC XIVE docs points to a nonexistent file * the initial comment needs to be marked by '..', not '.', or it will appear in the output * the title doesn't match the capitialization used by the existing interop or devel manuals, and uses 'full-system emulation' rather than the 'system emulation' that the interop manual title uses Fix these minor issues before we start trying to build the manual. Signed-off-by: Peter Maydell Acked-by: Aleksandar Markovic Reviewed-by: C=C3=A9dric Le Goater --- docs/specs/index.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/specs/index.rst b/docs/specs/index.rst index 2e927519c2e..40adb97c5eb 100644 --- a/docs/specs/index.rst +++ b/docs/specs/index.rst @@ -1,8 +1,8 @@ -. This is the top level page for the 'specs' manual +.. This is the top level page for the 'specs' manual =20 =20 -QEMU full-system emulation guest hardware specifications -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D +QEMU System Emulation Guest Hardware Specifications +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D =20 =20 Contents: @@ -10,4 +10,5 @@ Contents: .. toctree:: :maxdepth: 2 =20 - xive + ppc-xive + ppc-spapr-xive --=20 2.20.1 From nobody Mon May 20 21:02:35 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1560180406; cv=none; d=zoho.com; s=zohoarc; b=kBVkCj5ivsGgqshsRjgzzgpR9MXBiCo4In5ogqELjtNSrWs87Ik03yA/A8LmCRnVU9GpzyrHfzvwDJc9j46XRchzz4CwZYvbM4/udEoMyhe1eeSyHucz5btwkJFsjcsHVSp7Ap2smCAKyqkiAi/gY7uE5hqRihaoTAOHEMWOAFo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1560180406; 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:ARC-Authentication-Results; bh=wf1rBZIYOLaVLqVG55fM2V+yvtysYWVZ87PUdH2633g=; b=LeXUefLBoPHYNYZOfTTHyNHHaRt9UNWxTfxc7Gc0Lr++IXkXJF0DjkGlGuA1O96Sq6VtgvCbifqvlFLqtmHj9QqPdz9RJAJ8BB/nTxub7GhsoclWnKQccBFDVdqS6QwpLBoPmZAIiSkMqJxtzGuJhXv81DteLoakfetVUmKU1N8= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1560180406795143.11005671799342; Mon, 10 Jun 2019 08:26:46 -0700 (PDT) Received: from localhost ([::1]:47676 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haMC3-0005Uz-Qq for importer@patchew.org; Mon, 10 Jun 2019 11:26:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47179) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haMAR-00047n-AD for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:25:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1haMAL-0004lW-MM for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:25:01 -0400 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:40960) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1haMAJ-0004gE-SS for qemu-devel@nongnu.org; Mon, 10 Jun 2019 11:24:57 -0400 Received: by mail-wr1-x429.google.com with SMTP id c2so9612240wrm.8 for ; Mon, 10 Jun 2019 08:24:49 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b203sm11945920wmd.41.2019.06.10.08.24.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 10 Jun 2019 08:24:48 -0700 (PDT) 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=wf1rBZIYOLaVLqVG55fM2V+yvtysYWVZ87PUdH2633g=; b=wjaPkB9VNtyhPdtjVqaEI/wNv+iFQkJg9SjNkTiKRwkJlEcW80U6JRPHoCroFGvWmH VmAeZYm6Vxl0tQdin/Q4M3tFOTj7Krq7HoZOfNjLlRadhvwRCJj8JFYXlaClohyO272L fAbWGjG8RIR44NOPD8sg1zWWMN236M5HhqbjZO1LkjOnBgPgg38DPISVSMwcyyeYmiHA y2RAhjlp4DJXiMYbjzidujZRYVRQnUT+OrAR0yIwlgaMeI6pU0I49mPRyNc+8bzdUZ0t jYaaKTyYozWMcAJ3RO575DRsPn2DaA5L5QfBgqLmKgRUrvTqvrfFQx+8AbrBQY2oGF0B mTVA== 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=wf1rBZIYOLaVLqVG55fM2V+yvtysYWVZ87PUdH2633g=; b=pxQDY73YwgOrc5fP6/xD/BNqm8ZokdyHU9Y+P594FiIktlTOKDMoZKNAGGOeZqxxL9 1W8EeRZc+E1/3gMB5jx/5uIZcR6EN8sftgqRFUNePmRkQCppGuWyZYjftiPj8UBSOS9m jtBxu2XvEnmkwtCrgELJAAS00NUx0xY9S/7sMApO3PLnfLMeVOTVS/MtimF0io525Y2V xuT+DkInUltXBpK/ubVIwRIPmfAYETI5avS+4JWZn07DOZ75DbtSe1kg6hpOcPV0oktd X0Gl8hk2hSp18oIBOoR5kOy9mK09SShEVSX1TTT5J48WtHKlnihs+b3FP3qWAMCuZoj/ 39zw== X-Gm-Message-State: APjAAAUUfZENrcjEmNx10ds60ALQxS7ueFI5HdhXFonrxGhE56fPzZ2X 4XvEU1E5b6TDKZGgQX6XH4d9rcU3bEgIpA== X-Google-Smtp-Source: APXvYqz+jAS8gcqDQjN6QcHK6jaaUn0mLBXMfnUX7jRK7qu4vqDtahkM9rOQLkARyOpRi+9PhbACcw== X-Received: by 2002:a05:6000:104e:: with SMTP id c14mr33946197wrx.71.1560180288663; Mon, 10 Jun 2019 08:24:48 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Mon, 10 Jun 2019 16:24:44 +0100 Message-Id: <20190610152444.20859-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190610152444.20859-1-peter.maydell@linaro.org> References: <20190610152444.20859-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::429 Subject: [Qemu-devel] [PATCH 2/2] docs: Build and install specs manual 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 , John Snow , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , David Gibson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Now we have some rST format docs in the docs/specs/ manual, we should actually build and install it. Signed-off-by: Peter Maydell Acked-by: Aleksandar Markovic --- Makefile | 7 ++++++- docs/specs/conf.py | 16 ++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/specs/conf.py diff --git a/Makefile b/Makefile index 8e2fc6624c3..cfb18f15254 100644 --- a/Makefile +++ b/Makefile @@ -731,6 +731,7 @@ distclean: clean rm -rf .doctrees $(call clean-manual,devel) $(call clean-manual,interop) + $(call clean-manual,specs) for d in $(TARGET_DIRS); do \ rm -rf $$d || exit 1 ; \ done @@ -781,6 +782,7 @@ endef .PHONY: install-sphinxdocs install-sphinxdocs: sphinxdocs $(call install-manual,interop) + $(call install-manual,specs) =20 install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" @@ -962,7 +964,7 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak # 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 +sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop= /index.html $(MANUAL_BUILDDIR)/specs/index.html =20 # Canned command to build a single manual build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b= html -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctrees/$= 1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$= 1") @@ -975,6 +977,9 @@ $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps= ,devel) $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(call build-manual,interop) =20 +$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) + $(call build-manual,specs) + qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 diff --git a/docs/specs/conf.py b/docs/specs/conf.py new file mode 100644 index 00000000000..4d56f3ae13c --- /dev/null +++ b/docs/specs/conf.py @@ -0,0 +1,16 @@ +# -*- 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' --=20 2.20.1