From nobody Sat Oct 4 18:50:44 2025 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 155136658560475.03185530213818; Thu, 28 Feb 2019 07:09:45 -0800 (PST) Received: from localhost ([127.0.0.1]:39833 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gzNJd-0005eo-FP for importer@patchew.org; Thu, 28 Feb 2019 10:09:41 -0500 Received: from eggs.gnu.org ([209.51.188.92]:52287) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gzN7Z-00050s-03 for qemu-devel@nongnu.org; Thu, 28 Feb 2019 09:57:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gzN7X-0008Db-U0 for qemu-devel@nongnu.org; Thu, 28 Feb 2019 09:57:12 -0500 Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]:55884) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1gzN7X-000827-MD for qemu-devel@nongnu.org; Thu, 28 Feb 2019 09:57:11 -0500 Received: by mail-wm1-x336.google.com with SMTP id q187so9567143wme.5 for ; Thu, 28 Feb 2019 06:57:03 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id c17sm14047539wrs.17.2019.02.28.06.56.56 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 28 Feb 2019 06:57:00 -0800 (PST) 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=98Cdi6PAb8X+oP7Qn0lzznrDFrkDUmrC40KmQnveD2E=; b=Q9Kk/qoES+/S3qRBUWtujXpZ7KW9JW6bqVFYkH9tY6GgGGhc7r0xgsk1NgUDXTMmAx VLQdK8riSG44gLnbM3bzXNDgpr66W9ql+QHc4+iR4j/GJgaELmBk2VfFyPj/z7u4Bj80 LE3fieST7H7P/SYajt3R3HTA6BKPsi+3rxSrjfwEq3GZL0zlnoOGvWO48gey1A2mmwcJ Yse90Em+jGHiyPpEEUdjXNR+vniwKEZasNkFt6ZJL9Rh10YLZJAloCJLBHp80/FNL1E3 5MFoHnP6fUYXth3fuMvh4z1CYBiWNyyEQ5zMh4qvZrf48qdqnsV6QH8qX9dPnPHzoLnz OKzw== 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=98Cdi6PAb8X+oP7Qn0lzznrDFrkDUmrC40KmQnveD2E=; b=HIP+jaza9Rjwf8nPyl135fxjL2Htcn1iwuGa5yKxKU+5QVcFiJwK9vJ83MZT9pwtGC 09l+0n6F/qR8h4j+EFo0LyilNDwvzJTDONFyI9tPhhhqMc3ZqFhgp6LcVnaQaJYReabm Oxd+fe99275SOszaC1ztWZy1Es8O0iYZAMZBWhKV/VBJ8Zs9Bb07IBIQOHrIMDLkNeG9 KsjWTs4CCEuOW4Tm/7j40vmYiwX539OhV3F0Km3Be3j0EiaEQ4VwBNvAzKPDCXv9ZWi5 TTDkAs3Mvo59+/5Z9GhfRHTzNiWZBb6GABNwUzoHf6nLSmx3uPgm6s8n0mznLx8pmtP6 LxTA== X-Gm-Message-State: APjAAAUuyKsflbZwWws9phoGKbwf+PtwErMwUgEX2H4WoEkdxoBFPmDi rmtjEPY4jY9dovWpPnqkzQMFne9Ajfg= X-Google-Smtp-Source: APXvYqxXP7+rQp4W+nNwzH37nr2inxhjqdOoeECsQ7YhYCg82pualsQ/7egOok/mB5qOOWLWBSmqAQ== X-Received: by 2002:a1c:9693:: with SMTP id y141mr62688wmd.33.1551365821581; Thu, 28 Feb 2019 06:57:01 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Thu, 28 Feb 2019 14:56:24 +0000 Message-Id: <20190228145624.24885-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190228145624.24885-1-peter.maydell@linaro.org> References: <20190228145624.24885-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::336 Subject: [Qemu-devel] [PATCH v2 11/11] 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: , Cc: patches@linaro.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Stefan Hajnoczi , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Paolo Bonzini , =?UTF-8?q?Alex=20Benn=C3=A9e?= 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 --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 46cb8e62571..526bac7f516 100644 --- a/Makefile +++ b/Makefile @@ -865,7 +865,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 6a334f545ec..0842d44e930 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,11 +75,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