From nobody Thu Nov 14 07:00:59 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 Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1551974584075233.10316144853186; Thu, 7 Mar 2019 08:03:04 -0800 (PST) Received: from localhost ([127.0.0.1]:54470 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1vU1-0001Hw-Tw for importer@patchew.org; Thu, 07 Mar 2019 11:02:57 -0500 Received: from eggs.gnu.org ([209.51.188.92]:34050) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1utQ-0002kO-14 for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:09 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1utN-0004vl-Rc for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:07 -0500 Received: from mail-wr1-x430.google.com ([2a00:1450:4864:20::430]:46284) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1utN-0004v8-Kg for qemu-devel@nongnu.org; Thu, 07 Mar 2019 10:25:05 -0500 Received: by mail-wr1-x430.google.com with SMTP id i16so17881169wrs.13 for ; Thu, 07 Mar 2019 07:25:05 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id d1sm5338345wrs.13.2019.03.07.07.25.03 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 07 Mar 2019 07:25:03 -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=1YApA52i18Nn/0msmBFdz83XJVVSHcLDg1SnWzTelNI=; b=qeohnpHoyp/ro6rK1GLHBce1p5A3LmWCjBm3pAqO5ZT8cBxmu4CHXKSJkTgN5c6nel UIzHcf2GYQ/MEVXV5XsSgwFzrFo4XqtfMfMUlJKjj0tpdM2DprhpO1mTQivuKmNXF5lg cXku/jLYWOn7M+e2BHqj1BtCTN2VlS0KsDrPhInMW5X8CnauMFn2RYodORbcnK1AecCM oBJ1kEP80B/WP3PPWwmR7SG7zFxG53o4/gjPqFDjYEHFNfhKMjmFXQe5jOnmXljXRHT2 jPXUsL/0iQ0sfdc+lC4vBjbtAbfXJrFeLTiAk3vdCqfNhY1GihXHKN7JQ0rcHnJDdzsD gtWw== 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=1YApA52i18Nn/0msmBFdz83XJVVSHcLDg1SnWzTelNI=; b=XnpjffQrSklG09ZPxIUFNphvHJA/cMXKuftDrbtdYAC4XcWa97m8ECaCvD7DMKgeJp tjmBD2P4sJk4jN0J0vmiomUqsNj1tZwikhZR1YXf4dT6DIOdZzQcd7FVBJhuu4NxrbJC W5at7I/atJjmroEOdR3kE95fjkLou1tgVmPL/Tyo/wVmUkmwllDSikbISOZxHi8QqHVW Pm86hnGfPCwPSr7Pq3z5eqyqPdSm2TppbIslnos9xtRvUfC4CVMCEiz0fZoO+U9kO3t/ pFiBk72jEP/OkeK6JbO6piIUprRQjbBC3VK9CSbOibs4SUaObbaywrT/MrN/uw7KCjhC vN4w== X-Gm-Message-State: APjAAAWPNdf0FSDQE27PYa2+dHkFBx48w2GFkCOXDiD89ZV8KhA5Ds4a 18Y0ciALYK35fFwo+jYDYq7zegIajbs= X-Google-Smtp-Source: APXvYqxRxqdCG9FNfTEr/1sMrqnyNVd8zCXBhJ8/6UC5OJOaMQ9IJtom+DuaxH86FO0TocjPtQbSnA== X-Received: by 2002:adf:e5cc:: with SMTP id a12mr7839692wrn.130.1551972304409; Thu, 07 Mar 2019 07:25:04 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 7 Mar 2019 15:24:49 +0000 Message-Id: <20190307152450.20340-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190307152450.20340-1-peter.maydell@linaro.org> References: <20190307152450.20340-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" 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::430 Subject: [Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 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: fail (Header signature does not verify) Don't hard-code the QEMU version number into conf.py. Instead we either pass it to sphinx-build on the command line, or (if doing a standalone Sphinx run in a readthedocs.org setup) extract it from the VERSION file. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Philippe Mathieu-Daud=C3=A9 Tested-by: Philippe Mathieu-Daud=C3=A9 Acked-by: Aleksandar Markovic Reviewed-by: Richard Henderson Message-id: 20190305172139.32662-12-peter.maydell@linaro.org Message-id: 20190228145624.24885-12-peter.maydell@linaro.org --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index b746d112a7f..cad585b4d6b 100644 --- a/Makefile +++ b/Makefile @@ -869,7 +869,7 @@ docs/version.texi: $(SRC_PATH)/VERSION sphinxdocs: docs/devel/index.html docs/interop/index.html =20 # Canned command to build a single manual -build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b html = -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") +build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b html = -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctrees/$1 $(SR= C_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/= conf.py $(SRC_PATH)/docs/conf.py =20 diff --git a/docs/conf.py b/docs/conf.py index f452e424cfe..befbcc6c3e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,11 +76,22 @@ author =3D u'The QEMU Project Developers' # The version info for the project you're documenting, acts as replacement= for # |version| and |release|, also used in various other places throughout the # built documents. -# -# The short X.Y version. -version =3D u'4.0' -# The full version, including alpha/beta/rc tags. -release =3D u'4.0' + +# Extract this information from the VERSION file, for the benefit of +# standalone Sphinx runs as used by readthedocs.org. Builds run from +# the Makefile will pass version and release on the sphinx-build +# command line, which override this. +try: + extracted_version =3D None + with open(os.path.join(qemu_docdir, '../VERSION')) as f: + extracted_version =3D f.readline().strip() +except: + pass +finally: + if extracted_version: + version =3D release =3D extracted_version + else: + version =3D release =3D "unknown version" =20 # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. --=20 2.20.1