diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-02-16 15:07:02 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-02-24 15:43:25 +0000 |
commit | dc257d94fc41a80d7b5e613b2d2a547db83d081d (patch) | |
tree | acdf5eb08182cba56b3788a351a097cb939c5305 /documentation | |
parent | 2b621b21bc9d11f38e65a79994ba8c3d36325e90 (diff) | |
download | poky-dc257d94fc41a80d7b5e613b2d2a547db83d081d.tar.gz |
ref-manual: document meson class and variables
(From yocto-docs rev: aacd49e5c72ac1506fc09790902c6047ccf26a02)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/classes.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 25 |
2 files changed, 35 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index b9b49981e1..7ff0fcb335 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1651,6 +1651,16 @@ messages for various BitBake severity levels (i.e. ``bbplain``, | |||
1651 | This class is enabled by default since it is inherited by the :ref:`ref-classes-base` | 1651 | This class is enabled by default since it is inherited by the :ref:`ref-classes-base` |
1652 | class. | 1652 | class. |
1653 | 1653 | ||
1654 | .. _ref-classes-meson: | ||
1655 | |||
1656 | ``meson`` | ||
1657 | ========= | ||
1658 | |||
1659 | The :ref:`ref-classes-meson` class allows to create recipes that build software | ||
1660 | using the `Meson <https://mesonbuild.com/>`__ build system. You can use | ||
1661 | the :term:`MESON_BUILDTYPE` and :term:`EXTRA_OEMESON` variables to specify | ||
1662 | additional configuration options to be passed using the ``meson`` command line. | ||
1663 | |||
1654 | .. _ref-classes-metadata_scm: | 1664 | .. _ref-classes-metadata_scm: |
1655 | 1665 | ||
1656 | ``metadata_scm`` | 1666 | ``metadata_scm`` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c204f49aac..760c608bde 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2528,6 +2528,20 @@ system and gives an overview of their function and contents. | |||
2528 | variable specifies additional configuration options you want to pass | 2528 | variable specifies additional configuration options you want to pass |
2529 | to the ``scons`` command line. | 2529 | to the ``scons`` command line. |
2530 | 2530 | ||
2531 | :term:`EXTRA_OEMESON` | ||
2532 | Additional `Meson <https://mesonbuild.com/>`__ options. See the | ||
2533 | :ref:`ref-classes-meson` class for additional information. | ||
2534 | |||
2535 | In addition to standard Meson options, such options correspond to | ||
2536 | `Meson build options <https://mesonbuild.com/Build-options.html>`__ | ||
2537 | defined in the ``meson_options.txt`` file in the sources to build. | ||
2538 | Here is an example:: | ||
2539 | |||
2540 | EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled" | ||
2541 | |||
2542 | Note that any custom value for the Meson ``--buildtype`` option | ||
2543 | should be set through the :term:`MESON_BUILDTYPE` variable. | ||
2544 | |||
2531 | :term:`EXTRA_USERS_PARAMS` | 2545 | :term:`EXTRA_USERS_PARAMS` |
2532 | When inheriting the :ref:`ref-classes-extrausers` | 2546 | When inheriting the :ref:`ref-classes-extrausers` |
2533 | class, this variable provides image level user and group operations. | 2547 | class, this variable provides image level user and group operations. |
@@ -5138,6 +5152,17 @@ system and gives an overview of their function and contents. | |||
5138 | :term:`MAINTAINER` | 5152 | :term:`MAINTAINER` |
5139 | The email address of the distribution maintainer. | 5153 | The email address of the distribution maintainer. |
5140 | 5154 | ||
5155 | :term:`MESON_BUILDTYPE` | ||
5156 | Value of the Meson ``--buildtype`` argument used by the | ||
5157 | :ref:`ref-classes-meson` class. It defaults to ``debug`` if | ||
5158 | :term:`DEBUG_BUILD` is set to "1", and ``plain`` otherwise. | ||
5159 | |||
5160 | See `Meson build options <https://mesonbuild.com/Builtin-options.html>`__ | ||
5161 | for the values you could set in a recipe. Values such as ``plain``, | ||
5162 | ``debug``, ``debugoptimized``, ``release`` and ``minsize`` allow | ||
5163 | you to specify the inclusion of debugging symbols and the compiler | ||
5164 | optimizations (none, performance or size). | ||
5165 | |||
5141 | :term:`METADATA_BRANCH` | 5166 | :term:`METADATA_BRANCH` |
5142 | The branch currently checked out for the OpenEmbedded-Core layer (path | 5167 | The branch currently checked out for the OpenEmbedded-Core layer (path |
5143 | determined by :term:`COREBASE`). | 5168 | determined by :term:`COREBASE`). |