diff options
author | Paul Eggleton <paul.eggleton@microsoft.com> | 2022-10-07 10:54:20 +1300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-19 17:32:57 +0100 |
commit | af3beeecfbce858669065f2e9b67db597e922c15 (patch) | |
tree | 9476a309919bc731953e30feb9f6850b852dd552 /documentation/ref-manual/classes.rst | |
parent | 9dd5d8d1adfaf2d8e4b9f0221ff95a88d5279396 (diff) | |
download | poky-af3beeecfbce858669065f2e9b67db597e922c15.tar.gz |
ref-manual: add pypi class
Add missing documentation for the pypi class.
(From yocto-docs rev: d387ca891ad3a7d00ec3cb5f994dc5832c885d54)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r-- | documentation/ref-manual/classes.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index d94db03616..f6f341e104 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -2005,6 +2005,21 @@ When inherited by a recipe, the ``perlnative`` class supports using the | |||
2005 | native version of Perl built by the build system rather than using the | 2005 | native version of Perl built by the build system rather than using the |
2006 | version provided by the build host. | 2006 | version provided by the build host. |
2007 | 2007 | ||
2008 | .. _ref-classes-pypi: | ||
2009 | |||
2010 | ``pypi.bbclass`` | ||
2011 | ================ | ||
2012 | |||
2013 | The ``pypi`` class sets variables appropriately for recipes that build | ||
2014 | Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index. | ||
2015 | By default it determines the PyPI package name based upon :term:`BPN` | ||
2016 | (stripping the "python-" or "python3-" prefix off if present), however in | ||
2017 | some cases you may need to set it manually in the recipe by setting | ||
2018 | :term:`PYPI_PACKAGE`. | ||
2019 | |||
2020 | Variables set by the ``pypi`` class include :term:`SRC_URI`, :term:`SECTION`, | ||
2021 | :term:`HOMEPAGE`, :term:`UPSTREAM_CHECK_URI`, and :term:`UPSTREAM_CHECK_REGEX`. | ||
2022 | |||
2008 | .. _ref-classes-python_flit_core: | 2023 | .. _ref-classes-python_flit_core: |
2009 | 2024 | ||
2010 | ``python_flit_core.bbclass`` | 2025 | ``python_flit_core.bbclass`` |