All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Thomas Huth" <thuth@redhat.com>,
	"Eduardo Habkost" <ehabkost@redhat.com>,
	"John Snow" <jsnow@redhat.com>,
	"Philippe Mathieu-Daudé" <f4bug@amsat.org>,
	"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
	"Willian Rampazzo" <willianr@redhat.com>,
	"Cleber Rosa" <crosa@redhat.com>,
	"Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH v2 04/12] python: README.rst touchups
Date: Tue, 29 Jun 2021 12:42:45 -0400	[thread overview]
Message-ID: <20210629164253.1272763-5-jsnow@redhat.com> (raw)
In-Reply-To: <20210629164253.1272763-1-jsnow@redhat.com>

Clarifying a few points; removing the reference to 'setuptools' because
it isn't 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>
Reviewed-by: Willian Rampazzo <willianr@redhat.com>
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
---
 python/README.rst | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

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.
-- 
2.31.1



  parent reply	other threads:[~2021-06-29 16:48 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-29 16:42 [PATCH v2 00/12] Python: packaging cleanups John Snow
2021-06-29 16:42 ` [PATCH v2 01/12] python: expose typing information via PEP 561 John Snow
2021-06-29 16:42 ` [PATCH v2 02/12] python: Remove global pylint suppressions John Snow
2021-06-29 16:42 ` [PATCH v2 03/12] python: Re-lock pipenv at *oldest* supported versions John Snow
2021-06-29 16:42 ` John Snow [this message]
2021-06-29 16:42 ` [PATCH v2 05/12] python: Add no-install usage instructions John Snow
2021-06-29 16:42 ` [PATCH v2 06/12] python: rename 'venv-check' target to 'check-pipenv' John Snow
2021-06-29 16:42 ` [PATCH v2 07/12] python: update help text for check-tox John Snow
2021-06-29 16:51   ` Wainer dos Santos Moschetta
2021-06-29 20:23   ` Wainer dos Santos Moschetta
2021-06-29 21:27     ` John Snow
2021-06-30 18:55       ` Wainer dos Santos Moschetta
2021-06-29 16:42 ` [PATCH v2 08/12] python: Fix .PHONY Make specifiers John Snow
2021-06-29 16:53   ` Wainer dos Santos Moschetta
2021-06-29 18:06   ` Willian Rampazzo
2021-06-29 16:42 ` [PATCH v2 09/12] python: add 'make check-dev' invocation John Snow
2021-06-29 17:34   ` Wainer dos Santos Moschetta
2021-06-29 17:43     ` John Snow
2021-06-29 16:42 ` [PATCH v2 10/12] python: Update help text on 'make check', 'make develop' John Snow
2021-06-29 16:42 ` [PATCH v2 11/12] python: Update help text on 'make clean', 'make distclean' John Snow
2021-06-29 16:42 ` [PATCH v2 12/12] python: remove auto-generated pyproject.toml file 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=20210629164253.1272763-5-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=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.