diff options
author | Patrick Williams <patrick@stwcx.xyz> | 2022-04-02 16:58:32 +0300 |
---|---|---|
committer | Patrick Williams <patrick@stwcx.xyz> | 2022-04-04 20:54:11 +0300 |
commit | 45852739b8823d99a818e714b72961886759fe2e (patch) | |
tree | 92fc4d26b025440bff29a7b0cbf204c7f5cca151 /poky/documentation/ref-manual | |
parent | e9c4c65544ebd9f2c5772936c9fe0552d5e6d5b0 (diff) | |
download | openbmc-45852739b8823d99a818e714b72961886759fe2e.tar.xz |
subtree updates
meta-openembedded: 9a52bfc4a6..af11f6ce73:
Andreas Müller (4):
nautilus: Add a packageconfig for libportal - disabled by default
gtk4: upgrade 4.4.0 -> 4.6.2
libadwaita: initial add 1.1.0
gtksourceview5: upgrade 5.2.0 -> 5.4.0
Carlos Rafael Giani (3):
libopenmpt: Remove unnecessary python code block
pipewire: Upgrade to version 0.3.49
wireplumber: Upgrade to version 0.4.9
Kai Kang (4):
wxwidgets: 3.1.4 -> 3.1.5
python3-wxgtk4: add recipe
wxwidgets: fix typo
mcelog: fix compile error
Khem Raj (1):
python3-wxgtk4: Use cross prefix with native wx-config
Matthias Klein (1):
paho-mqtt-c: upgrade 1.3.9 -> 1.3.10
Mingli Yu (1):
mariadb: increase MY_AES_CTX_SIZE
Potin Lai (4):
libimobiledevice-glue: add recipe
libimobiledevice-glue: fix undefined bswap error
libirecovery: add recipe
idevicerestore: add recipe
S. Lockwood-Childs (1):
python3-evdev: fix host header contamination
Yi Zhao (2):
strongswan: 5.9.4 -> 5.9.5
libnetfilter-conntrack: upgrade 1.0.8 -> 1.0.9
meta-raspberrypi: c06ae5eacf..31c33d155c:
Khem Raj (3):
linux-raspberrypi_5.15.bb: Upgrade to 5.15.32
raspberrypi-firmware: Update to match 5.15.32
armstubs: Upgrade to 20211101
poky: 5fe3689f4f..1976521190:
Chen Qi (1):
gobject-introspection: fix default search path for girdir
Daniel Ammann (2):
overview-manual: Fix reference
ref-manual: Add vfat in list of filesystems supported by kickstart
Jagadeesh Krishnanjanappa (1):
cmake: support to create per-toolchain cmake file in SDK
Khem Raj (2):
weston: Add a knob to control simple clients
meson: Robustify compiler detection logic
Marta Rybczynska (1):
doc: migration-3.5: extend the section on inclusive language
Michael Halstead (1):
releases: update to include 3.4.3
Michael Opdenacker (4):
overview-manual: add missing upper case
docs: add poky.yaml and sphinx-static/switchers.js to "make clean"
manuals: fix quoting of double dashes
migration-guides: preliminary description for 3.5
Oleksandr Kravchuk (1):
python3: update to 3.10.4
Peter Kjellerstedt (1):
ref-manual: Remove references to AVAILABLE_LICENSES
Rasmus Villemoes (1):
git: make expat and curl into PACKAGECONFIG items
Richard Purdie (11):
set_versions/switchers: Drop versions shown to the active releases
mirrors: Add missing gitsm entries for yocto/oe mirrors
base: Don't add duplicates to sys.path
base: Clean up module import compatibility code
modutils-initscripts: Change license PD -> MIT
keymaps: Clean up license handling
initscripts: Clean up license handling/identifiers
bitbake: cooker: Further fixes to inotify to fix memres bitbake issues
bitbake: cooker: Restore sys.path and sys.modules between parses
bitbake: cooker: Ensure any existing hashserv connection is closed
bitbake: cooker: Avoid error if siggen wasn't setup
Ross Burton (24):
ref-manual: update Python class documentation
buildtools-tarball: include nativesdk-python3-pyyaml
image_types: hddimg and iso only work on x86
oeqa/selftest/devtool: ensure Git username is set before upgrade tests
oeqa/selftest/wic: use os.rename instead of bb.utils.rename
oeqa/selftest/wic: remove redundant asserts
oeqa/selftest/wic: clean up only_for_arch decorator
oeqa/selftest/wic: don't hardcode kernel image type in test_wic_rm
oeqa/selftest/wic: add more arch-specific annotations
oeqa/selftest/buildoptions: set PACKAGE_CLASSES in test_arch_work_dir_and_export_source
oeqa/runtime/decorator/package.py: remove use of strToSet
oeqa/core/decorator: remove redundant code
testimage: inline updateTestData()
oeqa/core/utils/misc: remove redundant file
oeqa/selftest: remove unused imports
oeqa/core/decorators/data: improve has_* logic
oeqa/selftest: tag tests that use runqemu
oeqa: rationalise skipifqemu decorators
oeqa/selftest/oescripts: refactor skipping logic
oeqa/selftest/wic: cleanup WicTestCase.setUpLocal
oeqa/selftest/wic: rearrange tests
oeqa/selftest/wic: use os.path.join to join paths
oeqa/selftest/wic: use self.td instead of get_bb_var to save on bitbake calls
oeqa/selftest: generalise test_devtool_virtual_kernel_modify
Simon Kuhnle (1):
convert-variable-renames: Fix typo in description
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ic8359fe5772351a45a3154c6a7f5042a88ff934c
Diffstat (limited to 'poky/documentation/ref-manual')
-rw-r--r-- | poky/documentation/ref-manual/classes.rst | 71 | ||||
-rw-r--r-- | poky/documentation/ref-manual/kickstart.rst | 2 | ||||
-rw-r--r-- | poky/documentation/ref-manual/tasks.rst | 4 | ||||
-rw-r--r-- | poky/documentation/ref-manual/variables.rst | 37 |
4 files changed, 50 insertions, 64 deletions
diff --git a/poky/documentation/ref-manual/classes.rst b/poky/documentation/ref-manual/classes.rst index 4dd0901623..6ba792d3f9 100644 --- a/poky/documentation/ref-manual/classes.rst +++ b/poky/documentation/ref-manual/classes.rst @@ -602,22 +602,6 @@ variables are not met, the recipe will be skipped, and if the build system attempts to build the recipe then an error will be triggered. -.. _ref-classes-flit_core: - -``flit_core.bbclass`` -===================== - -The ``flit_core`` class enables building Python modules which declare -the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant -``flit_core.buildapi`` ``build-backend`` in the ``[build-system]`` -section of ``pyproject.toml`` (See `PEP-518 <https://www.python.org/dev/peps/pep-0518/>`__). - -Python modules built with ``flit_core.buildapi`` are pure Python (no -``C`` or ``Rust`` extensions). - -The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__) -is installed with the :ref:`python_pep517 <ref-classes-python_pep517>` class. - .. _ref-classes-fontcache: ``fontcache.bbclass`` @@ -1978,20 +1962,48 @@ When inherited by a recipe, the ``perlnative`` class supports using the native version of Perl built by the build system rather than using the version provided by the build host. +.. _ref-classes-python_flit_core: + +``python_flit_core.bbclass`` +============================ + +The ``python_flit_core`` class enables building Python modules which declare +the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant +``flit_core.buildapi`` ``build-backend`` in the ``[build-system]`` +section of ``pyproject.toml`` (See `PEP-518 <https://www.python.org/dev/peps/pep-0518/>`__). + +Python modules built with ``flit_core.buildapi`` are pure Python (no +``C`` or ``Rust`` extensions). + +Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. + .. _ref-classes-python_pep517: ``python_pep517.bbclass`` -============================= +========================= + +The ``python_pep517`` class builds and installs a Python ``wheel`` binary +archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__). -The ``python_pep517`` class installs a Python ``wheel`` binary archive (see -`PEP-517 <https://peps.python.org/pep-0517/>`__). +Recipes wouldn't inherit this directly, instead typically another class will +inherit this, add the relevant native dependencies, and set +:term:`PEP517_BUILD_API` to the Python class which implements the PEP-517 build +API. -The Python ``wheel`` can be built with several classes, including :ref:`flit_core <ref-classes-flit_core>`, -:ref:`setuptools_build_meta <ref-classes-setuptools_build_meta>`, and :ref:`setuptools3 <ref-classes-setuptools3>`. +Examples of classes which do this are :ref:`python_flit_core +<ref-classes-python_flit_core>`, :ref:`python_setuptools_build_meta +<ref-classes-python_setuptools_build_meta>`, and :ref:`python_poetry_core +<ref-classes-python_poetry_core>`. -The path to the wheel to be installed is defined by :term:`PEP517_WHEEL_PATH`. -This defaults to ``${D}/dist`` and should be respected by the builder class -(such as :ref:`flit_core <ref-classes-flit_core>`). +.. _ref-classes-python_poetry_core: + +``python_poetry_core.bbclass`` +============================== + +The ``python_poetry_core`` class enables building Python modules which use the +`Poetry Core <https://python-poetry.org>`__ build system. + +Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. .. _ref-classes-pixbufcache: @@ -2348,12 +2360,12 @@ additional configuration options you want to pass SCons command line. The ``sdl`` class supports recipes that need to build software that uses the Simple DirectMedia Layer (SDL) library. -.. _ref-classes-setuptools_build_meta: +.. _ref-classes-python_setuptools_build_meta: -``setuptools_build_meta.bbclass`` -================================= +``python_setuptools_build_meta.bbclass`` +======================================== -The ``setuptools_build_meta`` class enables building Python modules which +The ``python_setuptools_build_meta`` class enables building Python modules which declare the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant ``setuptools.build_meta`` ``build-backend`` in the ``[build-system]`` @@ -2362,8 +2374,7 @@ section of ``pyproject.toml`` (See `PEP-518 <https://www.python.org/dev/peps/pep Python modules built with ``setuptools.build_meta`` can be pure Python or include ``C`` or ``Rust`` extensions). -The resulting ``wheel`` (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__) -is installed with the :ref:`python_pep517 <ref-classes-python_pep517>` class. +Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. .. _ref-classes-setuptools3: diff --git a/poky/documentation/ref-manual/kickstart.rst b/poky/documentation/ref-manual/kickstart.rst index 885c721297..d82da0ee75 100644 --- a/poky/documentation/ref-manual/kickstart.rst +++ b/poky/documentation/ref-manual/kickstart.rst @@ -125,6 +125,8 @@ the ``part`` and ``partition`` commands: - ``swap`` + - ``vfat`` + - ``--fsoptions``: Specifies a free-form string of options to be used when mounting the filesystem. This string is copied into the ``/etc/fstab`` file of the installed system and should be enclosed in diff --git a/poky/documentation/ref-manual/tasks.rst b/poky/documentation/ref-manual/tasks.rst index b51462b79a..a2b8763e7c 100644 --- a/poky/documentation/ref-manual/tasks.rst +++ b/poky/documentation/ref-manual/tasks.rst @@ -187,9 +187,9 @@ that either directly or indirectly depend on the installed files (e.g. - The ``install`` utility. This utility is the preferred method. - - The ``cp`` command with the "--no-preserve=ownership" option. + - The ``cp`` command with the ``--no-preserve=ownership`` option. - - The ``tar`` command with the "--no-same-owner" option. See the + - The ``tar`` command with the ``--no-same-owner`` option. See the ``bin_package.bbclass`` file in the ``meta/classes`` directory of the :term:`Source Directory` for an example. diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index 634f19a673..f9fd551478 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -231,17 +231,6 @@ system and gives an overview of their function and contents. must set this variable in your recipe. The :ref:`syslinux <ref-classes-syslinux>` class checks this variable. - :term:`AVAILABLE_LICENSES` - List of licenses found in the directories specified by - :term:`COMMON_LICENSE_DIR` and - :term:`LICENSE_PATH`. - - .. note:: - - It is assumed that all changes to :term:`COMMON_LICENSE_DIR` and - :term:`LICENSE_PATH` have been done before :term:`AVAILABLE_LICENSES` - is defined (in :ref:`ref-classes-license`). - :term:`AVAILTUNES` The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build @@ -3508,21 +3497,6 @@ system and gives an overview of their function and contents. remove dependencies on or provide alternatives to components that are required to produce a functional system image. - .. note:: - - It is possible to define a list of licenses that are allowed to be - used instead of the licenses that are excluded. To do this, define - a variable ``COMPATIBLE_LICENSES`` with the names of the licenses - that are allowed. Then define :term:`INCOMPATIBLE_LICENSE` as:: - - INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" - - - This will result in :term:`INCOMPATIBLE_LICENSE` containing the names of - all licenses from :term:`AVAILABLE_LICENSES` except the ones specified - in ``COMPATIBLE_LICENSES``, thus only allowing the latter licenses to - be used. - :term:`INHERIT` Causes the named class or classes to be inherited globally. Anonymous functions in the class or classes are not executed for the base @@ -5632,6 +5606,11 @@ system and gives an overview of their function and contents. :term:`PE` is the default value of the :term:`PKGE` variable. + :term:`PEP517_BUILD_API` + When used by recipes that inherit the :ref:`python_pep517 + <ref-classes-python_pep517>` class, specifies the entry point to the + PEP-517 compliant build API (such as ``flit_core.buildapi``). + :term:`PEP517_WHEEL_PATH` When used by recipes that inherit the :ref:`python_pep517 <ref-classes-python_pep517>` class, @@ -5644,12 +5623,6 @@ 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:`python_pep517 <ref-classes-python_pep517>` class, - denotes the arguments passed to ``pip install`` to adjust the - behavior of how the ``wheel`` is installed. - :term:`PIXBUF_PACKAGES` When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` class, this variable identifies packages that contain the pixbuf |