diff mbox series

[v2,03/12] ref-manual/variables.rst: document the WATCHDOG_RUNTIME_SEC variable

Message ID 20250325-release-note-5-2-updates-v2-3-19f050d61da3@bootlin.com
State Under Review
Headers show
Series Updates for upcoming 5.2 release | expand

Commit Message

Antonin Godard March 25, 2025, 9:20 a.m. UTC
This variable controls the RuntimeWatchdogSec option in
/etc/systemd/system.conf.

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

Comments

Quentin Schulz March 28, 2025, 2:05 p.m. UTC | #1
Hi Antonin,

On 3/25/25 10:20 AM, Antonin Godard via lists.yoctoproject.org wrote:
> This variable controls the RuntimeWatchdogSec option in
> /etc/systemd/system.conf.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index ee7244dc5..70ed7db4d 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -10613,6 +10613,11 @@ system and gives an overview of their function and contents.
>         can control with this variable, see the
>         ":ref:`ref-classes-insane`" section.
>   
> +   :term:`WATCHDOG_RUNTIME_SEC`
> +      For the ``systemd`` recipe, this controls the value of the
> +      ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. The default

How about adding a path to the documentation of that option?

e.g. 
https://www.freedesktop.org/software/systemd/man/latest/systemd-system.conf.html#RuntimeWatchdogSec= 
?

> +      value is an empty string.
> +

meaning it is disabled.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ee7244dc5..70ed7db4d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -10613,6 +10613,11 @@  system and gives an overview of their function and contents.
       can control with this variable, see the
       ":ref:`ref-classes-insane`" section.
 
+   :term:`WATCHDOG_RUNTIME_SEC`
+      For the ``systemd`` recipe, this controls the value of the
+      ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. The default
+      value is an empty string.
+
    :term:`WATCHDOG_TIMEOUT`
       Specifies the timeout in seconds used by the ``watchdog-config`` recipe
       and also by ``systemd`` during reboot. The default is 60 seconds.