From 5ea10fc05bd044c8c521f56af0b0dfbae6a36331 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Sun, 17 Sep 2023 19:45:08 +0200 Subject: ref-manual: add meson class and variables Backported from the master branch (From yocto-docs rev: 266540ffdf84df14ebde374927e6e8ddd8ee688e) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman --- documentation/ref-manual/classes.rst | 10 ++++++++++ documentation/ref-manual/variables.rst | 25 +++++++++++++++++++++++++ 2 files changed, 35 insertions(+) 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``, This class is enabled by default since it is inherited by the ``base`` class. +.. _ref-classes-meson: + +``meson.bbclass`` +================= + +The :ref:`ref-classes-meson` class allows to create recipes that build software +using the `Meson `__ build system. You can use +the :term:`MESON_BUILDTYPE` and :term:`EXTRA_OEMESON` variables to specify +additional configuration options to be passed using the ``meson`` command line. + .. _ref-classes-metadata_scm: ``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. variable specifies additional configuration options you want to pass to the ``scons`` command line. + :term:`EXTRA_OEMESON` + Additional `Meson `__ options. See the + :ref:`ref-classes-meson` class for additional information. + + In addition to standard Meson options, such options correspond to + `Meson build options `__ + defined in the ``meson_options.txt`` file in the sources to build. + Here is an example:: + + EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled" + + Note that any custom value for the Meson ``--buildtype`` option + should be set through the :term:`MESON_BUILDTYPE` variable. + :term:`EXTRA_USERS_PARAMS` When inheriting the :ref:`extrausers ` class, this variable provides image level user and group operations. @@ -4794,6 +4808,17 @@ system and gives an overview of their function and contents. :term:`MAINTAINER` The email address of the distribution maintainer. + :term:`MESON_BUILDTYPE` + Value of the Meson ``--buildtype`` argument used by the + :ref:`ref-classes-meson` class. It defaults to ``debug`` if + :term:`DEBUG_BUILD` is set to "1", and ``plain`` otherwise. + + See `Meson build options `__ + for the values you could set in a recipe. Values such as ``plain``, + ``debug``, ``debugoptimized``, ``release`` and ``minsize`` allow + you to specify the inclusion of debugging symbols and the compiler + optimizations (none, performance or size). + :term:`METADATA_BRANCH` The branch currently checked out for the OpenEmbedded-Core layer (path determined by :term:`COREBASE`). -- cgit v1.2.3-54-g00ecf