summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-09-17 19:45:08 +0200
committerSteve Sakoman <steve@sakoman.com>2023-09-23 05:26:16 -1000
commit5ea10fc05bd044c8c521f56af0b0dfbae6a36331 (patch)
treebf2a2d3844fc7aa6a4616090e1c382e82b4f0796
parent598c3d25c6a5f3bffa9665d9bdb9862ad32d993e (diff)
downloadpoky-5ea10fc05bd044c8c521f56af0b0dfbae6a36331.tar.gz
ref-manual: add meson class and variables
Backported from the master branch (From yocto-docs rev: 266540ffdf84df14ebde374927e6e8ddd8ee688e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/ref-manual/classes.rst10
-rw-r--r--documentation/ref-manual/variables.rst25
2 files changed, 35 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6ee0d33451..04afd3acf7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1537,6 +1537,16 @@ messages for various BitBake severity levels (i.e. ``bbplain``,
1537This class is enabled by default since it is inherited by the ``base`` 1537This class is enabled by default since it is inherited by the ``base``
1538class. 1538class.
1539 1539
1540.. _ref-classes-meson:
1541
1542``meson.bbclass``
1543=================
1544
1545The :ref:`ref-classes-meson` class allows to create recipes that build software
1546using the `Meson <https://mesonbuild.com/>`__ build system. You can use
1547the :term:`MESON_BUILDTYPE` and :term:`EXTRA_OEMESON` variables to specify
1548additional configuration options to be passed using the ``meson`` command line.
1549
1540.. _ref-classes-metadata_scm: 1550.. _ref-classes-metadata_scm:
1541 1551
1542``metadata_scm.bbclass`` 1552``metadata_scm.bbclass``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 88b27492c7..1cc489a7ea 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2345,6 +2345,20 @@ system and gives an overview of their function and contents.
2345 variable specifies additional configuration options you want to pass 2345 variable specifies additional configuration options you want to pass
2346 to the ``scons`` command line. 2346 to the ``scons`` command line.
2347 2347
2348 :term:`EXTRA_OEMESON`
2349 Additional `Meson <https://mesonbuild.com/>`__ options. See the
2350 :ref:`ref-classes-meson` class for additional information.
2351
2352 In addition to standard Meson options, such options correspond to
2353 `Meson build options <https://mesonbuild.com/Build-options.html>`__
2354 defined in the ``meson_options.txt`` file in the sources to build.
2355 Here is an example::
2356
2357 EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled"
2358
2359 Note that any custom value for the Meson ``--buildtype`` option
2360 should be set through the :term:`MESON_BUILDTYPE` variable.
2361
2348 :term:`EXTRA_USERS_PARAMS` 2362 :term:`EXTRA_USERS_PARAMS`
2349 When inheriting the :ref:`extrausers <ref-classes-extrausers>` 2363 When inheriting the :ref:`extrausers <ref-classes-extrausers>`
2350 class, this variable provides image level user and group operations. 2364 class, this variable provides image level user and group operations.
@@ -4794,6 +4808,17 @@ system and gives an overview of their function and contents.
4794 :term:`MAINTAINER` 4808 :term:`MAINTAINER`
4795 The email address of the distribution maintainer. 4809 The email address of the distribution maintainer.
4796 4810
4811 :term:`MESON_BUILDTYPE`
4812 Value of the Meson ``--buildtype`` argument used by the
4813 :ref:`ref-classes-meson` class. It defaults to ``debug`` if
4814 :term:`DEBUG_BUILD` is set to "1", and ``plain`` otherwise.
4815
4816 See `Meson build options <https://mesonbuild.com/Builtin-options.html>`__
4817 for the values you could set in a recipe. Values such as ``plain``,
4818 ``debug``, ``debugoptimized``, ``release`` and ``minsize`` allow
4819 you to specify the inclusion of debugging symbols and the compiler
4820 optimizations (none, performance or size).
4821
4797 :term:`METADATA_BRANCH` 4822 :term:`METADATA_BRANCH`
4798 The branch currently checked out for the OpenEmbedded-Core layer (path 4823 The branch currently checked out for the OpenEmbedded-Core layer (path
4799 determined by :term:`COREBASE`). 4824 determined by :term:`COREBASE`).