diff options
| author | Paul Eggleton <bluelightning@bluelightning.org> | 2023-04-22 15:19:42 +1200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-04-22 10:59:12 +0100 |
| commit | 4f833991c25689070b6990b1f3cf08128d40e77d (patch) | |
| tree | 8d72b736ceb5cfe2e569212af3a828692aaa127f /documentation | |
| parent | e55e243f845b0b8c1e8c79c31891f7bdfc95f422 (diff) | |
| download | poky-4f833991c25689070b6990b1f3cf08128d40e77d.tar.gz | |
migration-guides: Add coverage of addpylib directive
To complement what I am adding to the BitBake reference manual, add a
section in the 4.2 migration guide, a reference in the structure section
of the reference manual (where we talk about meta/lib) and adjust the
release notes item to be a little more concise.
(From yocto-docs rev: 0903e82a9da263c6d64aead03407eb377eb5bbfe)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/migration-guides/migration-4.2.rst | 22 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-4.2.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 4 |
3 files changed, 27 insertions, 7 deletions
diff --git a/documentation/migration-guides/migration-4.2.rst b/documentation/migration-guides/migration-4.2.rst index ccc3e8905e..c2ec8af8a4 100644 --- a/documentation/migration-guides/migration-4.2.rst +++ b/documentation/migration-guides/migration-4.2.rst | |||
| @@ -85,6 +85,28 @@ On the other hand, some earlier distributions are no longer supported: | |||
| 85 | 85 | ||
| 86 | See :ref:`all supported distributions <system-requirements-supported-distros>`. | 86 | See :ref:`all supported distributions <system-requirements-supported-distros>`. |
| 87 | 87 | ||
| 88 | |||
| 89 | .. _migration-4.2-addpylib: | ||
| 90 | |||
| 91 | Python library code extensions | ||
| 92 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| 93 | |||
| 94 | BitBake in this release now supports a new ``addpylib`` directive to enable | ||
| 95 | Python libraries within layers. | ||
| 96 | |||
| 97 | This directive should be added to your layer configuration | ||
| 98 | as in the below example from ``meta/conf/layer.conf``:: | ||
| 99 | |||
| 100 | addpylib ${LAYERDIR}/lib oe | ||
| 101 | |||
| 102 | Layers currently adding a lib directory to extend Python library code should now | ||
| 103 | use this directive as :term:`BBPATH` is not going to be added automatically by | ||
| 104 | OE-Core in future. Note that the directives are immediate operations, so it does | ||
| 105 | make modules available for use sooner than the current BBPATH-based approach. | ||
| 106 | |||
| 107 | For more information, see :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. | ||
| 108 | |||
| 109 | |||
| 88 | .. _migration-4.2-misc-changes: | 110 | .. _migration-4.2-misc-changes: |
| 89 | 111 | ||
| 90 | Miscellaneous changes | 112 | Miscellaneous changes |
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst index 4cf1974d4f..a3e821cb4b 100644 --- a/documentation/migration-guides/release-notes-4.2.rst +++ b/documentation/migration-guides/release-notes-4.2.rst | |||
| @@ -11,12 +11,8 @@ New Features / Enhancements in 4.2 | |||
| 11 | :term:`buildtools` tarball. | 11 | :term:`buildtools` tarball. |
| 12 | 12 | ||
| 13 | - BitBake in this release now supports a new ``addpylib`` directive to enable | 13 | - BitBake in this release now supports a new ``addpylib`` directive to enable |
| 14 | Python libraries within layers. | 14 | Python libraries within layers. For more information, |
| 15 | 15 | see :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. | |
| 16 | This directive should be added to your layer configuration | ||
| 17 | as in the below example from ``meta/conf/layer.conf``:: | ||
| 18 | |||
| 19 | addpylib ${LAYERDIR}/lib oe | ||
| 20 | 16 | ||
| 21 | - BitBake has seen multiple internal changes that may impact | 17 | - BitBake has seen multiple internal changes that may impact |
| 22 | memory and disk usage as well as parsing time, in particular: | 18 | memory and disk usage as well as parsing time, in particular: |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index e895382eec..f1b11ad69b 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -750,7 +750,9 @@ and lists of files and directories with known permissions. | |||
| 750 | ------------- | 750 | ------------- |
| 751 | 751 | ||
| 752 | This directory contains OpenEmbedded Python library code used during the | 752 | This directory contains OpenEmbedded Python library code used during the |
| 753 | build process. | 753 | build process. It is enabled via the ``addpylib`` directive in |
| 754 | ``meta/conf/local.conf``. For more information, see | ||
| 755 | :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. | ||
| 754 | 756 | ||
| 755 | .. _structure-meta-recipes-bsp: | 757 | .. _structure-meta-recipes-bsp: |
| 756 | 758 | ||
