All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Kevin Wolf" <kwolf@redhat.com>, "Thomas Huth" <thuth@redhat.com>,
	"Eduardo Habkost" <ehabkost@redhat.com>,
	qemu-block@nongnu.org, "Alex Bennée" <alex.bennee@linaro.org>,
	"Philippe Mathieu-Daudé" <philmd@redhat.com>,
	"Philippe Mathieu-Daudé" <f4bug@amsat.org>,
	"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
	"Max Reitz" <mreitz@redhat.com>,
	"Willian Rampazzo" <willianr@redhat.com>,
	"Cleber Rosa" <crosa@redhat.com>, "John Snow" <jsnow@redhat.com>
Subject: [PATCH v8 11/31] python: add VERSION file
Date: Thu, 27 May 2021 17:16:55 -0400	[thread overview]
Message-ID: <20210527211715.394144-12-jsnow@redhat.com> (raw)
In-Reply-To: <20210527211715.394144-1-jsnow@redhat.com>

Python infrastructure as it exists today is not capable reliably of
single-sourcing a package version from a parent directory. The authors
of pip are working to correct this, but as of today this is not possible.

The problem is that when using pip to build and install a python
package, it copies files over to a temporary directory and performs its
build there. This loses access to any information in the parent
directory, including git itself.

Further, Python versions have a standard (PEP 440) that may or may not
follow QEMU's versioning. In general, it does; but naturally QEMU does
not follow PEP 440. To avoid any automatically-generated conflict, a
manual version file is preferred.


I am proposing:

- Python tooling follows the QEMU version, indirectly, but with a major
  version of 0 to indicate that the API is not expected to be
  stable. This would mean version 0.5.2.0, 0.5.1.1, 0.5.3.0, etc.

- In the event that a Python package needs to be updated independently
  of the QEMU version, a pre-release alpha version should be preferred,
  but *only* after inclusion to the qemu development or stable branches.

  e.g. 0.5.2.0a1, 0.5.2.0a2, and so on should be preferred prior to
  5.2.0's release.

- The Python core tooling makes absolutely no version compatibility
  checks or constraints. It *may* work with releases of QEMU from the
  past or future, but it is not required to.

  i.e., "qemu.machine" will, for now, remain in lock-step with QEMU.

- We reserve the right to split the qemu package into independently
  versioned subpackages at a later date. This might allow for us to
  begin versioning QMP independently from QEMU at a later date, if
  we so choose.


Implement this versioning scheme by adding a VERSION file and setting it
to 0.6.0.0a1.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
---
 python/VERSION   | 1 +
 python/setup.cfg | 1 +
 2 files changed, 2 insertions(+)
 create mode 100644 python/VERSION

diff --git a/python/VERSION b/python/VERSION
new file mode 100644
index 00000000000..c19f3b832b7
--- /dev/null
+++ b/python/VERSION
@@ -0,0 +1 @@
+0.6.1.0a1
diff --git a/python/setup.cfg b/python/setup.cfg
index 3fa92a2e73f..b0010e0188f 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -1,5 +1,6 @@
 [metadata]
 name = qemu
+version = file:VERSION
 maintainer = QEMU Developer Team
 maintainer_email = qemu-devel@nongnu.org
 url = https://www.qemu.org/
-- 
2.31.1



  parent reply	other threads:[~2021-05-27 21:23 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-27 21:16 [PATCH v8 00/31] python: create installable package John Snow
2021-05-27 21:16 ` [PATCH v8 01/31] python/console_socket: avoid one-letter variable John Snow
2021-05-27 21:16 ` [PATCH v8 02/31] python/machine: use subprocess.DEVNULL instead of open(os.path.devnull) John Snow
2021-05-27 21:16 ` [PATCH v8 03/31] python/machine: use subprocess.run instead of subprocess.Popen John Snow
2021-05-27 21:16 ` [PATCH v8 04/31] python/console_socket: Add a pylint ignore John Snow
2021-05-27 21:16 ` [PATCH v8 05/31] python/machine: Disable pylint warning for open() in _pre_launch John Snow
2021-05-27 21:16 ` [PATCH v8 06/31] python/machine: disable warning for Popen in _launch() John Snow
2021-05-27 21:16 ` [PATCH v8 07/31] python/machine: Trim line length to below 80 chars John Snow
2021-05-27 21:16 ` [PATCH v8 08/31] iotests/297: add --namespace-packages to mypy arguments John Snow
2021-05-27 21:16 ` [PATCH v8 09/31] python: create qemu packages John Snow
2021-05-27 21:16 ` [PATCH v8 10/31] python: add qemu package installer John Snow
2021-05-27 21:16 ` John Snow [this message]
2021-05-27 21:16 ` [PATCH v8 12/31] python: add directory structure README.rst files John Snow
2021-05-27 21:16 ` [PATCH v8 13/31] python: add MANIFEST.in John Snow
2021-05-27 21:16 ` [PATCH v8 14/31] python: Add pipenv support John Snow
2021-05-27 21:16 ` [PATCH v8 15/31] python: add pylint import exceptions John Snow
2021-05-27 21:17 ` [PATCH v8 16/31] python: move pylintrc into setup.cfg John Snow
2021-05-27 21:17 ` [PATCH v8 17/31] python: add pylint to pipenv John Snow
2021-05-27 21:17 ` [PATCH v8 18/31] python: move flake8 config to setup.cfg John Snow
2021-05-27 21:17 ` [PATCH v8 19/31] python: add excluded dirs to flake8 config John Snow
2021-05-27 21:17 ` [PATCH v8 20/31] python: Add flake8 to pipenv John Snow
2021-05-27 21:17 ` [PATCH v8 21/31] python: move mypy.ini into setup.cfg John Snow
2021-05-27 21:17 ` [PATCH v8 22/31] python: add mypy to pipenv John Snow
2021-05-27 21:17 ` [PATCH v8 23/31] python: move .isort.cfg into setup.cfg John Snow
2021-05-27 21:17 ` [PATCH v8 24/31] python/qemu: add isort to pipenv John Snow
2021-05-27 21:17 ` [PATCH v8 25/31] python/qemu: add qemu package itself " John Snow
2021-05-27 21:17 ` [PATCH v8 26/31] python: add devel package requirements to setuptools John Snow
2021-05-27 21:17 ` [PATCH v8 27/31] python: add avocado-framework and tests John Snow
2021-05-27 21:17 ` [PATCH v8 28/31] python: add Makefile for some common tasks John Snow
2021-05-27 21:17 ` [PATCH v8 29/31] python: add .gitignore John Snow
2021-05-27 21:17 ` [PATCH v8 30/31] python: add tox support John Snow
2021-05-27 21:17 ` [PATCH v8 31/31] gitlab: add python linters to CI John Snow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210527211715.394144-12-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=alex.bennee@linaro.org \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=f4bug@amsat.org \
    --cc=kwolf@redhat.com \
    --cc=mreitz@redhat.com \
    --cc=philmd@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=thuth@redhat.com \
    --cc=wainersm@redhat.com \
    --cc=willianr@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.