[PATCH v3] variables: Add documentation for KERNEL_DTC_FLAGS

[PATCH v3] variables: Add documentation for KERNEL_DTC_FLAGS

[Ovidiu Panait]

Add documentation for the newly introduced KERNEL_DTC_FLAGS variable.

Signed-off-by: Ovidiu Panait <ovidiu.panait@windriver.com>
---
v3 updates:
- highlight ``DTC_FLAGS`` and ``dtc``

 documentation/ref-manual/variables.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c8e28fd32..4ce264813 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3884,6 +3884,15 @@ system and gives an overview of their function and contents.
 
          KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
 
+   :term:`KERNEL_DTC_FLAGS`
+      Specifies the ``dtc`` flags that are passed to the Linux kernel build
+      system when generating the device trees (via ``DTC_FLAGS`` environment
+      variable).
+
+      In order to use this variable, the
+      :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
+      be inherited.
+
    :term:`KERNEL_EXTRA_ARGS`
       Specifies additional ``make`` command-line arguments the OpenEmbedded
       build system passes on when compiling the kernel.
-- 
2.17.1

Re: [docs] [PATCH v3] variables: Add documentation for KERNEL_DTC_FLAGS

[Quentin Schulz]

On Mon, Jan 04, 2021 at 04:28:51PM +0200, Ovidiu Panait wrote:
> Add documentation for the newly introduced KERNEL_DTC_FLAGS variable.
> 
> Signed-off-by: Ovidiu Panait <ovidiu.panait@windriver.com>
> ---
> v3 updates:
> - highlight ``DTC_FLAGS`` and ``dtc``
> 
>  documentation/ref-manual/variables.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index c8e28fd32..4ce264813 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -3884,6 +3884,15 @@ system and gives an overview of their function and contents.
>  
>           KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
>  
> +   :term:`KERNEL_DTC_FLAGS`
> +      Specifies the ``dtc`` flags that are passed to the Linux kernel build
> +      system when generating the device trees (via ``DTC_FLAGS`` environment
> +      variable).
> +
> +      In order to use this variable, the
> +      :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
> +      be inherited.
> +
>     :term:`KERNEL_EXTRA_ARGS`
>        Specifies additional ``make`` command-line arguments the OpenEmbedded
>        build system passes on when compiling the kernel.

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks!
Quentin