summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorTim Orling <ticotimo@gmail.com>2022-02-27 19:55:46 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-04 09:39:37 +0000
commit61ee42131cdbfb1a7eb3405008317f9bb8d25ca1 (patch)
treed1dbfa8d23e3d6994c5759abc7c6f7b0bae39ef8 /documentation
parent6f2365a29208c79c547576a4aa3ac65d2303802d (diff)
downloadpoky-61ee42131cdbfb1a7eb3405008317f9bb8d25ca1.tar.gz
docs: add pip install variables
Add the new variables used to install Python `wheel` binary archives: * PIP_INSTALL_ARGS * PIP_INSTALL_DIST_PATH * PIP_INSTALL_PACKAGE * PYPA_WHEEL (From yocto-docs rev: cb213b5682e37873ac0ec457d6f5a52639c4b24a) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/variables.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 492a0d4ef5..c9d7cfbe92 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5575,6 +5575,25 @@ system and gives an overview of their function and contents.
5575 ``bash-4.2-r1/``). This variable is comprised of the following: 5575 ``bash-4.2-r1/``). This variable is comprised of the following:
5576 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} 5576 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
5577 5577
5578 :term:`PIP_INSTALL_ARGS`
5579 When used by recipes that inherit the
5580 :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
5581 denotes the arguments passed to ``pip install`` to adjust the
5582 behavior of how the ``wheel`` is installed.
5583
5584 :term:`PIP_INSTALL_DIST_PATH`
5585 When used by recipes that inherit the
5586 :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
5587 denotes the path to ``dist/`` (short for distribution) where the
5588 binary archive ``wheel`` is built. This is used in part to create
5589 the :term:`PYPA_WHEEL` variable.
5590
5591 :term:`PIP_INSTALL_PACKAGE`
5592 When used by recipes that inherit the
5593 :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class,
5594 denotes the name of the package portion of the ``wheel`` filename.
5595 This is used in part to create the :term:`PYPA_WHEEL` variable.
5596
5578 :term:`PIXBUF_PACKAGES` 5597 :term:`PIXBUF_PACKAGES`
5579 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` 5598 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
5580 class, this variable identifies packages that contain the pixbuf 5599 class, this variable identifies packages that contain the pixbuf
@@ -6002,6 +6021,13 @@ system and gives an overview of their function and contents.
6002 6021
6003 :term:`PV` is the default value of the :term:`PKGV` variable. 6022 :term:`PV` is the default value of the :term:`PKGV` variable.
6004 6023
6024 :term:`PYPA_WHEEL`
6025 When used by recipes that inherit the
6026 :ref:`pip_install_wheel <ref-classes-pip_install_wheel>` class, denotes
6027 the absolute path to the built ``wheel`` to be installed. Normally the
6028 defaults which use :term:`PIP_INSTALL_PACKAGE` and :term:`PIP_INSTALL_DIST_PATH`
6029 to build the path to the ``wheel`` should be sufficient.
6030
6005 :term:`PYTHON_ABI` 6031 :term:`PYTHON_ABI`
6006 When used by recipes that inherit the 6032 When used by recipes that inherit the
6007 :ref:`setuptools3 <ref-classes-setuptools3>` class, denotes the 6033 :ref:`setuptools3 <ref-classes-setuptools3>` class, denotes the