diff mbox series

ref-manual: variables.rst: document KERNEL_DANGLING_FEATURES_WARN_ONLY

Message ID 20230418171026.1327353-1-michael.opdenacker@bootlin.com
State New
Headers show
Series ref-manual: variables.rst: document KERNEL_DANGLING_FEATURES_WARN_ONLY | expand

Commit Message

Michael Opdenacker April 18, 2023, 5:10 p.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Bruce Ashfield <bruce.ashfield@gmail.com>
---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Bruce Ashfield April 19, 2023, 4:37 p.m. UTC | #1
On Tue, Apr 18, 2023 at 1:10 PM <michael.opdenacker@bootlin.com> wrote:
>
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> CC: Bruce Ashfield <bruce.ashfield@gmail.com>
> ---
>  documentation/ref-manual/variables.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6a9dcfd5ba..2899bd78fc 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4420,6 +4420,20 @@ system and gives an overview of their function and contents.
>        You can register custom kernel image types with the
>        :ref:`ref-classes-kernel` class using this variable.
>
> +   :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY`
> +      When kernel configuration fragments are missing for some
> +      :term:`KERNEL_FEATURES` specified by layers or BSPs,
> +      building and configuring the kernel stops with an error.
> +
> +      You can turn these errors into warnings by setting the
> +      following in ``conf/local.conf``::
> +
> +         KERNEL_DANGLING_FEATURES_WARN_ONLY = "1"
> +
> +      You will still be warned that runtime issues may occur,
> +      but at least the kernel configuration and build process will
> +      be allowed to continue.
> +

Looks good to me.

Reviewed-by: Bruce Ashfield <bruce.ashfield@gmail.com>

>     :term:`KERNEL_DEBUG_TIMESTAMPS`
>        If set to "1", enables timestamping functionality during building
>        the kernel. The default is "0" to disable this for reproducibility
> --
> 2.34.1
>
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6a9dcfd5ba..2899bd78fc 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4420,6 +4420,20 @@  system and gives an overview of their function and contents.
       You can register custom kernel image types with the
       :ref:`ref-classes-kernel` class using this variable.
 
+   :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY`
+      When kernel configuration fragments are missing for some
+      :term:`KERNEL_FEATURES` specified by layers or BSPs,
+      building and configuring the kernel stops with an error.
+    
+      You can turn these errors into warnings by setting the
+      following in ``conf/local.conf``::
+
+         KERNEL_DANGLING_FEATURES_WARN_ONLY = "1"
+    
+      You will still be warned that runtime issues may occur,
+      but at least the kernel configuration and build process will
+      be allowed to continue.
+
    :term:`KERNEL_DEBUG_TIMESTAMPS`
       If set to "1", enables timestamping functionality during building
       the kernel. The default is "0" to disable this for reproducibility