From patchwork Mon Jun 17 14:57:40 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 167081 Delivered-To: patch@linaro.org Received: by 2002:a92:4782:0:0:0:0:0 with SMTP id e2csp3056780ilk; Mon, 17 Jun 2019 09:16:54 -0700 (PDT) X-Google-Smtp-Source: APXvYqxd2iIF63uyR6OT39cyb73xdJtLE/pzUIuPpzYqgGQtabezmHgJgLW1p+FaDzjct3lC1K5s X-Received: by 2002:a17:906:708d:: with SMTP id b13mr16258981ejk.89.1560788214584; Mon, 17 Jun 2019 09:16:54 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1560788214; cv=none; d=google.com; s=arc-20160816; b=IM3FKEpfVKKfnl3iQDE//vgze1aH80y50KL8UUtEcLeRyHuc6BS0cxgtqrR/RhyCbr jFMiaEUDuZ0lhXrJSCePeUhGuSi5mgLo500iwETHN3DU3AZNq29mLmVQfUG1WYJYTC+3 nzkK+Mds8GsRgzxto/D4bpKYvRdawDrBGHhfuKAY4E64FUQXfvBX2tAkj5Gx60kZ7vzv n9mlave0TZEoqu3yOJsLOYAKUUwAVoV0gBiytEIzNWYVdJUKZa03fb5OgYi5OGKNCyGV 5qkcj8ACXWkBw+eFrHXEjxvMOLSFlV6vbI5q0OpOKqUOF3nRjhG5vDXJAsZlLSwD26zK wW/w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=aoRd/IN7MHr76s2KiDTvTo7JU64fLK5LtzUk1fqaZJY=; b=p4KE3dkOlwNXnyBNj5p19x3d/gIPcwShAdQPKvhAFyJNcHk6OqNO2TEi2/2Fa2PjIa VJHeNX+nuCFituFHXPKbx5EQnBAM9NwZv7sww1nO6giMECyY6cHb/OC3WRcYeqdyw9kq 0pqPgAIXit9NEpzOL03M13gRJ4+DKEJfgbPcy/H3ySIv71kXF/D20sQMYBqhwpyg3dB2 Pj4SaAEo7QHbpkjYTOvN1LABylQ2CSZQVuMsQ6USxSk5jszINA4c73GlNtU/fmWQ3Mve 9XZMKiw+ybHfqKWs3sMW5gl4SJWN5gOnceg0X7onoPDuinrmjeLIA5we2jERrwKl9aPX MtKg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=bYvfy6vw; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id t55si8318090edd.95.2019.06.17.09.16.54 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 17 Jun 2019 09:16:54 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=bYvfy6vw; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:49016 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hcuJR-0001Kw-Ha for patch@linaro.org; Mon, 17 Jun 2019 12:16:53 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53405) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hct4w-0000RW-9k for qemu-devel@nongnu.org; Mon, 17 Jun 2019 10:57:51 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hct4u-0007Ne-Kk for qemu-devel@nongnu.org; Mon, 17 Jun 2019 10:57:50 -0400 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]:38841) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hct4u-0007Ld-B7 for qemu-devel@nongnu.org; Mon, 17 Jun 2019 10:57:48 -0400 Received: by mail-wm1-x329.google.com with SMTP id s15so9469161wmj.3 for ; Mon, 17 Jun 2019 07:57:48 -0700 (PDT) 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=aoRd/IN7MHr76s2KiDTvTo7JU64fLK5LtzUk1fqaZJY=; b=bYvfy6vweBD6NJMzpBC6zQIoZJT8BwDm7As6LeqCtnO6y7Pe4UDJLL+ZPy96rawztW 54y67AeYhoR0bJuENnVXk8IkUSARx8erUnaRD9gHV4uh8HvUP8+g44xLx/t5+0Id7jNb ux4UzwkuFSJmiFaHelCWPiPNFsZI8ATJIgCOdrb/X3Yss+YkGVQvICKB9y+ev4ZP5YRr 49aN7ghrvDMPZBDrdVMLgSsFFh1LVl/QWU3/uTiGRMu6PW/p5Ja1NwOiRnl5iKsSwChG efKOiuaddMM3xv1SDdgN0rpXjg3dUmiweNFUdoMeKPhRVWd90VMgE6OfWWS243iRax0o 3YXg== 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=aoRd/IN7MHr76s2KiDTvTo7JU64fLK5LtzUk1fqaZJY=; b=bCryXq39yf9ikFdvueEsUNZD/ghCrPq2SRkxLqLUdBvhuES6e6BfI5aIxuFW2mx7/b Z+kriJ2nPw9gss1+ox6WXUP6KltBimJNmeJLGfS78Td7rFVRt8f5cJNyqsiYNRuKWboy mv8MtxC6MNJ4YrmvczE2Y0vnFrQ2MnnVl7CyoAXqxmrHOFCBwrimDl3oDnZmfnslDKgx egCGDSH7D0ur4O0wnQmu/Yo7zFh1lQY0AvKtdd9dBP0v9gAXiXyXfSaudkMfuIgb3BCs Wo+VJRUi6IeKnUSHpy4LejAqAXbt8fRn5xD7uch0+KBdkVgSF5x6wFO9km0LUSKIkZBD 7AKA== X-Gm-Message-State: APjAAAWl9R6LfCfz80LQBT3TPQUGrvXGxsyYxqdGJ/lMEUizKxBaOxs9 G4NWAiPT5Ep5XBobf38soJGMDp4o+Cl0iw== X-Received: by 2002:a1c:1947:: with SMTP id 68mr18621532wmz.165.1560783466917; Mon, 17 Jun 2019 07:57:46 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id s10sm14690750wmf.8.2019.06.17.07.57.45 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 17 Jun 2019 07:57:46 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Mon, 17 Jun 2019 15:57:40 +0100 Message-Id: <20190617145740.9881-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190617145740.9881-1-peter.maydell@linaro.org> References: <20190617145740.9881-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::329 Subject: [Qemu-devel] [PULL 4/4] 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: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 Message-id: 20190610152444.20859-3-peter.maydell@linaro.org --- Makefile | 7 ++++++- docs/specs/conf.py | 16 ++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/specs/conf.py -- 2.20.1 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) 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 # Canned command to build a single manual build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b html -D version=$(VERSION) -D release="$(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) +$(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","$@") 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 tweaks. +import sys +import os + +qemu_docdir = os.path.abspath("..") +parent_config = 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'] = \ + u'System Emulation Guest Hardware Specifications'