[PATCH] ref-manual: document meson class and EXTRA_OEMESON variable

[PATCH] ref-manual: document meson class and EXTRA_OEMESON variable

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/ref-manual/classes.rst   | 10 ++++++++++
 documentation/ref-manual/variables.rst | 11 +++++++++++
 2 files changed, 21 insertions(+)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b5443c0d0a..b34c966788 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1648,6 +1648,16 @@ messages for various BitBake severity levels (i.e. ``bbplain``,
 This class is enabled by default since it is inherited by the :ref:`ref-classes-base`
 class.
 
+.. _ref-classes-meson:
+
+``meson``
+=========
+
+The :ref:`ref-classes-meson` class allows to create recipes that build software
+using the `Meson <https://mesonbuild.com/>`__ build system. You can use
+the :term:`EXTRA_OEMESON` variable to specify additional configuration options
+to be passed using the ``meson`` command line.
+
 .. _ref-classes-metadata_scm:
 
 ``metadata_scm``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 62176f7ee8..877ea20b47 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2528,6 +2528,17 @@ 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 <https://mesonbuild.com/>`__ options. See the
+      :ref:`ref-classes-meson` class for additional information.
+
+      In addition to standard Meson options, such options correspond
+      `Meson build options <https://mesonbuild.com/Build-options.html>`__
+      defined in the ``meson_options.txt`` file in the sources to build.
+      Here is an example::
+
+         EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled"
+
    :term:`EXTRA_USERS_PARAMS`
       When inheriting the :ref:`ref-classes-extrausers`
       class, this variable provides image level user and group operations.
-- 
2.37.2

RE: [docs] [PATCH] ref-manual: document meson class and EXTRA_OEMESON variable

[Peter Kjellerstedt]

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf Of Michael Opdenacker via lists.yoctoproject.org
> Sent: den 16 februari 2023 15:08
> To: docs@lists.yoctoproject.org
> Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Subject: [docs] [PATCH] ref-manual: document meson class and EXTRA_OEMESON variable
> 
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  documentation/ref-manual/classes.rst   | 10 ++++++++++
>  documentation/ref-manual/variables.rst | 11 +++++++++++
>  2 files changed, 21 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index b5443c0d0a..b34c966788 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1648,6 +1648,16 @@ messages for various BitBake severity levels (i.e. ``bbplain``,
>  This class is enabled by default since it is inherited by the :ref:`ref-classes-base`
>  class.
> 
> +.. _ref-classes-meson:
> +
> +``meson``
> +=========
> +
> +The :ref:`ref-classes-meson` class allows to create recipes that build software
> +using the `Meson <https://mesonbuild.com/>`__ build system. You can use
> +the :term:`EXTRA_OEMESON` variable to specify additional configuration options
> +to be passed using the ``meson`` command line.
> +
>  .. _ref-classes-metadata_scm:
> 
>  ``metadata_scm``
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 62176f7ee8..877ea20b47 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2528,6 +2528,17 @@ 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 <https://mesonbuild.com/>`__ options. See the
> +      :ref:`ref-classes-meson` class for additional information.
> +
> +      In addition to standard Meson options, such options correspond

Change "correspond" to "correspond to".

> +      `Meson build options <https://mesonbuild.com/Build-options.html>`__
> +      defined in the ``meson_options.txt`` file in the sources to build.
> +      Here is an example::
> +
> +         EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled"
> +

You might also want to add a definition of the MESON_BUILDTYPE variable, 
which defaults to `debug` or `plain` depending on if DEBUG_BUILD is set 
or not, but can be set by the recipe. 

>     :term:`EXTRA_USERS_PARAMS`
>        When inheriting the :ref:`ref-classes-extrausers`
>        class, this variable provides image level user and group operations.
> --
> 2.37.2

//Peter

Re: [docs] [PATCH] ref-manual: document meson class and EXTRA_OEMESON variable

[Michael Opdenacker]

Hi Peter

Thanks for the review!

On 16.02.23 at 19:52, Peter Kjellerstedt wrote:
>> -----Original Message-----
>> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf Of Michael Opdenacker via lists.yoctoproject.org
>> Sent: den 16 februari 2023 15:08
>> To: docs@lists.yoctoproject.org
>> Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> Subject: [docs] [PATCH] ref-manual: document meson class and EXTRA_OEMESON variable
>>
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> ---
>>   documentation/ref-manual/classes.rst   | 10 ++++++++++
>>   documentation/ref-manual/variables.rst | 11 +++++++++++
>>   2 files changed, 21 insertions(+)
>>
>> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
>> index b5443c0d0a..b34c966788 100644
>> --- a/documentation/ref-manual/classes.rst
>> +++ b/documentation/ref-manual/classes.rst
>> @@ -1648,6 +1648,16 @@ messages for various BitBake severity levels (i.e. ``bbplain``,
>>   This class is enabled by default since it is inherited by the :ref:`ref-classes-base`
>>   class.
>>
>> +.. _ref-classes-meson:
>> +
>> +``meson``
>> +=========
>> +
>> +The :ref:`ref-classes-meson` class allows to create recipes that build software
>> +using the `Meson <https://mesonbuild.com/>`__ build system. You can use
>> +the :term:`EXTRA_OEMESON` variable to specify additional configuration options
>> +to be passed using the ``meson`` command line.
>> +
>>   .. _ref-classes-metadata_scm:
>>
>>   ``metadata_scm``
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index 62176f7ee8..877ea20b47 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -2528,6 +2528,17 @@ 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 <https://mesonbuild.com/>`__ options. See the
>> +      :ref:`ref-classes-meson` class for additional information.
>> +
>> +      In addition to standard Meson options, such options correspond
> Change "correspond" to "correspond to".


Oops, fixed.

>
>> +      `Meson build options <https://mesonbuild.com/Build-options.html>`__
>> +      defined in the ``meson_options.txt`` file in the sources to build.
>> +      Here is an example::
>> +
>> +         EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled"
>> +
> You might also want to add a definition of the MESON_BUILDTYPE variable,
> which defaults to `debug` or `plain` depending on if DEBUG_BUILD is set
> or not, but can be set by the recipe.

Oh yes, that's necessary. You don't want to use EXTRA_OEMESON to pass 
"--buildtype" options, otherwise two different "--buildtype" settings 
may be passed at the same time.

I'm preparing a V2.
Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com