diff mbox series

ref-manual: variables: document PYPI_PACKAGE_EXT, PYPI_SRC_URI

Message ID 20240521182644.1895419-1-tgamblin@baylibre.com
State New
Headers show
Series ref-manual: variables: document PYPI_PACKAGE_EXT, PYPI_SRC_URI | expand

Commit Message

Trevor Gamblin May 21, 2024, 6:26 p.m. UTC
These are variables that some Python recipes are starting to use, but
there is no documentation for them currently in the reference manual.

Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
---
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Michael Opdenacker May 23, 2024, 8:16 a.m. UTC | #1
Hi Trevor,

On 5/21/24 at 23:56, Trevor Gamblin wrote:
> These are variables that some Python recipes are starting to use, but
> there is no documentation for them currently in the reference manual.
>
> Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
> ---
>   documentation/ref-manual/variables.rst | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 3f37f42f2..09199b5c9 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -6829,6 +6829,19 @@ system and gives an overview of their function and contents.
>         explicitly if that will not match the package name (e.g. where the
>         package name has a prefix, underscores, uppercase letters etc.)
>   
> +   :term:`PYPI_PACKAGE_EXT`
> +      When inheriting the :ref:`ref-classes-pypi` class, specifies the
> +      file extension to use when fetching a package from `PyPI
> +      <https://pypi.org/>`__. Default is tar.gz.
> +
> +   :term:`PYPI_SRC_URI`
> +      When inheriting the :ref:`ref-classes-pypi` class, specifies the
> +      full `pythonhosted <https://files.pythonhosted.org/>`__ URI for
> +      fetching the package to be built. The default value is constructed
> +      based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and
> +      :term:`PV`. Most recipes will not need to set this variable unless
> +      they are building an unstable (i.e. development) version.
> +
>      :term:`PYTHON_ABI`
>         When used by recipes that inherit the :ref:`ref-classes-setuptools3`
>         class, denotes the Application Binary Interface (ABI) currently in use


Many thanks for the update!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 3f37f42f2..09199b5c9 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6829,6 +6829,19 @@  system and gives an overview of their function and contents.
       explicitly if that will not match the package name (e.g. where the
       package name has a prefix, underscores, uppercase letters etc.)
 
+   :term:`PYPI_PACKAGE_EXT`
+      When inheriting the :ref:`ref-classes-pypi` class, specifies the
+      file extension to use when fetching a package from `PyPI
+      <https://pypi.org/>`__. Default is tar.gz.
+
+   :term:`PYPI_SRC_URI`
+      When inheriting the :ref:`ref-classes-pypi` class, specifies the
+      full `pythonhosted <https://files.pythonhosted.org/>`__ URI for
+      fetching the package to be built. The default value is constructed
+      based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and
+      :term:`PV`. Most recipes will not need to set this variable unless
+      they are building an unstable (i.e. development) version.
+
    :term:`PYTHON_ABI`
       When used by recipes that inherit the :ref:`ref-classes-setuptools3`
       class, denotes the Application Binary Interface (ABI) currently in use