diff mbox series

[2/3] docs: add pip install variables

Message ID 20220228035547.1134436-2-tim.orling@konsulko.com
State New
Headers show
Series [1/3] docs: add new python packaging classes | expand

Commit Message

Tim Orling Feb. 28, 2022, 3:55 a.m. UTC 
Add the new variables used to install Python `wheel` binary archives:
* PIP_INSTALL_ARGS
* PIP_INSTALL_DIST_PATH
* PIP_INSTALL_PACKAGE
* PYPA_WHEEL

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/ref-manual/variables.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

Comments

Michael Opdenacker March 2, 2022, 11:10 a.m. UTC | #1 
On 2/28/22 04:55, Tim Orling wrote:
> Add the new variables used to install Python `wheel` binary archives:
> * PIP_INSTALL_ARGS
> * PIP_INSTALL_DIST_PATH
> * PIP_INSTALL_PACKAGE
> * PYPA_WHEEL
>
> Signed-off-by: Tim Orling <tim.orling@konsulko.com>


For both patches:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

I add to remove a trailing whitespace, but no harm, everything else was
fine.
I merged your two changes into "master-next".

Thanks again
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ecb2b60c7..1f6433084 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5594,6 +5594,25 @@  system and gives an overview of their function and contents.
       ``bash-4.2-r1/``). This variable is comprised of the following:
       ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
 
+   :term:`PIP_INSTALL_ARGS`
+      When used by recipes that inherit the
+      :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
+      denotes the arguments passed to ``pip install`` to adjust the
+      behavior of how the ``wheel`` is installed.
+
+   :term:`PIP_INSTALL_DIST_PATH`
+      When used by recipes that inherit the
+      :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
+      denotes the path to ``dist/`` (short for distribution) where the
+      binary archive ``wheel`` is built. This is used in part to create
+      the :term:`PYPA_WHEEL` variable.
+
+   :term:`PIP_INSTALL_PACKAGE`
+      When used by recipes that inherit the
+      :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
+      denotes the name of the package portion of the ``wheel`` filename.
+      This is used in part to create the :term:`PYPA_WHEEL` variable.
+
    :term:`PIXBUF_PACKAGES`
       When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
       class, this variable identifies packages that contain the pixbuf
@@ -6021,6 +6040,13 @@  system and gives an overview of their function and contents.
 
       :term:`PV` is the default value of the :term:`PKGV` variable.
 
+   :term:`PYPA_WHEEL`
+      When used by recipes that inherit the
+      :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class, denotes
+      the absolute path to the built ``wheel`` to be installed. Normally the
+      defaults which use :term:`PIP_INSTALL_PACKAGE` and :term:`PIP_INSTALL_DIST_PATH`
+      to build the path to the ``wheel`` should be sufficient.
+
    :term:`PYTHON_ABI`
       When used by recipes that inherit the
       :ref:`distutils3 <ref-classes-distutils3>`,