diff mbox series

[yocto-docs,01/14] ref-manual/variables: document the KERNEL_CONSOLE variable

Message ID 20241217-release-note-5-2-updates-v1-1-b189493b1b09@bootlin.com
State New
Headers show
Series Updates from recent core changes | expand

Commit Message

Antonin Godard Dec. 17, 2024, 9:27 a.m. UTC
This variables holds the value of the `console` kernel command line
parameter.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Quentin Schulz Dec. 17, 2024, 10:05 a.m. UTC | #1
Hi Antonin,

On 12/17/24 10:27 AM, Antonin Godard via lists.yoctoproject.org wrote:
> This variables holds the value of the `console` kernel command line
> parameter.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 1eee617d59ccddc9af0ffb95ea3635a707718152..c6d3d1bba9961704fca25921b346d5282e118db4 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4579,6 +4579,12 @@ 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_CONSOLE`
> +     The :term:`KERNEL_CONSOLE` variable holds the value of the ``console``
> +     parameter of the kernel command line and can be used in places such as a
> +     ``wks`` description file for :ref:`Wic images <dev-manual/wic:creating
> +     partitioned images using wic>`.
> +

We could provide a link to the kernel command line documentation 
(https://www.kernel.org/doc/html/v6.12/admin-guide/kernel-parameters.html) 
and possibly specify the default value (it's in 
meta/conf/distro/include/default-distrovars.inc; essentially the first 
console device and its setting from SERIAL_CONSOLES if any set, 
otherwise ttyS0,115200).

In any case,

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 1eee617d59ccddc9af0ffb95ea3635a707718152..c6d3d1bba9961704fca25921b346d5282e118db4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4579,6 +4579,12 @@  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_CONSOLE`
+     The :term:`KERNEL_CONSOLE` variable holds the value of the ``console``
+     parameter of the kernel command line and can be used in places such as a
+     ``wks`` description file for :ref:`Wic images <dev-manual/wic:creating
+     partitioned images using wic>`.
+
    :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY`
       When kernel configuration fragments are missing for some
       :term:`KERNEL_FEATURES` specified by layers or BSPs,