From 61ee42131cdbfb1a7eb3405008317f9bb8d25ca1 Mon Sep 17 00:00:00 2001 From: Tim Orling Date: Sun, 27 Feb 2022 19:55:46 -0800 Subject: 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 Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'documentation') 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. ``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 ` 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 ` 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 ` 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 ` class, this variable identifies packages that contain the pixbuf @@ -6002,6 +6021,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 ` 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:`setuptools3 ` class, denotes the -- cgit v1.2.3-54-g00ecf