From: Wainer dos Santos Moschetta <wainersm@redhat.com>
To: John Snow <jsnow@redhat.com>, qemu-devel@nongnu.org
Cc: "Thomas Huth" <thuth@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>,
"Philippe Mathieu-Daudé" <f4bug@amsat.org>,
"Willian Rampazzo" <willianr@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>
Subject: Re: [PATCH 04/11] python: README.rst touchups
Date: Mon, 28 Jun 2021 17:35:04 -0300 [thread overview]
Message-ID: <cbdfde96-e55d-7bef-79e5-1813fbd46ae5@redhat.com> (raw)
In-Reply-To: <20210625154540.783306-5-jsnow@redhat.com>
On 6/25/21 12:45 PM, John Snow wrote:
> Clarifying a few points; removing the reference to 'setuptools' because
> it referenced anywhere else in this document and doesn't really provide
> any useful information to a Python newcomer.
>
> Adjusting the language elsewhere to be less ambiguous and have fewer
> run-on sentences.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> python/README.rst | 17 +++++++++--------
> 1 file changed, 9 insertions(+), 8 deletions(-)
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
>
> diff --git a/python/README.rst b/python/README.rst
> index dcf993819d..107786ffdc 100644
> --- a/python/README.rst
> +++ b/python/README.rst
> @@ -7,8 +7,7 @@ then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
>
> ``setup.py`` is used by ``pip`` to install this tooling to the current
> environment. ``setup.cfg`` provides the packaging configuration used by
> -``setup.py`` in a setuptools specific format. You will generally invoke
> -it by doing one of the following:
> +``setup.py``. You will generally invoke it by doing one of the following:
>
> 1. ``pip3 install .`` will install these packages to your current
> environment. If you are inside a virtual environment, they will
> @@ -17,12 +16,13 @@ it by doing one of the following:
>
> 2. ``pip3 install --user .`` will install these packages to your user's
> local python packages. If you are inside of a virtual environment,
> - this will fail; you likely want the first invocation above.
> + this will fail; you want the first invocation above.
>
> -If you append the ``-e`` argument, pip will install in "editable" mode;
> -which installs a version of the package that installs a forwarder
> -pointing to these files, such that the package always reflects the
> -latest version in your git tree.
> +If you append the ``--editable`` or ``-e`` argument to either invocation
> +above, pip will install in "editable" mode. This installs the package as
> +a forwarder ("qemu.egg-link") that points to the source tree. In so
> +doing, the installed package always reflects the latest version in your
> +source tree.
>
> Installing ".[devel]" instead of "." will additionally pull in required
> packages for testing this package. They are not runtime requirements,
> @@ -30,6 +30,7 @@ and are not needed to simply use these libraries.
>
> Running ``make develop`` will pull in all testing dependencies and
> install QEMU in editable mode to the current environment.
> +(It is a shortcut for ``pip3 install -e .[devel]``.)
>
> See `Installing packages using pip and virtual environments
> <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_
> @@ -39,7 +40,7 @@ for more information.
> Files in this directory
> -----------------------
>
> -- ``qemu/`` Python package source directory.
> +- ``qemu/`` Python 'qemu' namespace package source directory.
> - ``tests/`` Python package tests directory.
> - ``avocado.cfg`` Configuration for the Avocado test-runner.
> Used by ``make check`` et al.
next prev parent reply other threads:[~2021-06-28 20:37 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-25 15:45 [PATCH 00/11] Python: packaging cleanups John Snow
2021-06-25 15:45 ` [PATCH 01/11] python: expose typing information via PEP 561 John Snow
2021-06-25 18:16 ` Willian Rampazzo
2021-06-28 20:11 ` Wainer dos Santos Moschetta
2021-06-28 20:28 ` John Snow
2021-06-25 15:45 ` [PATCH 02/11] python: Remove global pylint suppressions John Snow
2021-06-25 18:18 ` Willian Rampazzo
2021-06-28 20:14 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 03/11] python: Re-lock pipenv at *oldest* supported versions John Snow
2021-06-25 18:28 ` Willian Rampazzo
2021-06-28 20:30 ` Wainer dos Santos Moschetta
2021-06-28 20:38 ` John Snow
2021-06-29 16:44 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 04/11] python: README.rst touchups John Snow
2021-06-25 18:23 ` Willian Rampazzo
2021-06-25 18:26 ` John Snow
2021-06-28 20:35 ` Wainer dos Santos Moschetta [this message]
2021-06-25 15:45 ` [PATCH 05/11] python: Add no-install usage instructions John Snow
2021-06-25 18:25 ` Willian Rampazzo
2021-06-28 20:56 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 06/11] python: rename 'venv-check' target to 'check-pipenv' John Snow
2021-06-25 18:27 ` Willian Rampazzo
2021-06-28 21:09 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 07/11] python: update help text for check-tox John Snow
2021-06-25 18:29 ` Willian Rampazzo
2021-06-28 21:16 ` Wainer dos Santos Moschetta
2021-06-29 15:40 ` John Snow
2021-06-29 16:45 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 08/11] python: add 'make check-venv' invocation John Snow
2021-06-25 18:36 ` Willian Rampazzo
2021-06-25 18:38 ` John Snow
2021-06-25 19:01 ` Willian Rampazzo
2021-06-25 19:12 ` John Snow
2021-06-28 21:40 ` Wainer dos Santos Moschetta
2021-06-29 15:45 ` John Snow
2021-06-25 15:45 ` [PATCH 09/11] python: Update help text on 'make check', 'make develop' John Snow
2021-06-25 18:37 ` Willian Rampazzo
2021-06-28 21:41 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 10/11] python: Update help text on 'make clean', 'make distclean' John Snow
2021-06-25 18:37 ` Willian Rampazzo
2021-06-28 21:44 ` Wainer dos Santos Moschetta
2021-06-25 15:45 ` [PATCH 11/11] python: remove auto-generated pyproject.toml file John Snow
2021-06-25 18:40 ` Willian Rampazzo
2021-06-28 21:48 ` Wainer dos Santos Moschetta
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=cbdfde96-e55d-7bef-79e5-1813fbd46ae5@redhat.com \
--to=wainersm@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=f4bug@amsat.org \
--cc=jsnow@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=thuth@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).