Hi Denis,
On 2026-05-29T03:48:33, None <[email protected]> wrote:
> docs: reset: document cold reset option
>
> Update the reset command documentation to cover reset -c and explain
> that the default reset type can be overridden through the relevant
> Kconfig choice.
>
> Signed-off-by: Denis Mukhin <[email protected]>
>
> doc/usage/cmd/reset.rst | 9 ++++++++-
> 1 file changed, 8 insertions(+), 1 deletion(-)
> diff --git a/doc/usage/cmd/reset.rst b/doc/usage/cmd/reset.rst
> @@ -19,6 +19,13 @@ Description
> Perform reset of the CPU. By default does COLD reset, which resets CPU,
> DDR and peripherals, on some boards also resets external PMIC.
>
> +The default behavior may be overridden via
> +CONFIG_SYSRESET_CMD_RESET_DEFAULT_{COLD,WARM,POWER,POWER_OFF}.
The two sentences contradict each other - the line above says the
default is always COLD, the new line says it can be anything. Please
rework as 'the default is COLD reset unless overridden by ...'.
> diff --git a/doc/usage/cmd/reset.rst b/doc/usage/cmd/reset.rst
> @@ -19,6 +19,13 @@ Description
> +-c
> + Do COLD reset: reset CPU and peripheral/DDR; on some boards also resets
> + external PMIC.
> +
> -w
> Do warm WARM, reset CPU but keep peripheral/DDR/PMIC active.
While here, please fix the pre-existing 'Do warm WARM,' typo on -w and
use a consistent form for both entries (e.g. 'Do WARM reset:' / 'Do
COLD reset:'). The new -c text also duplicates the Description
paragraph; a short 'Do COLD reset (same as the default when
CONFIG_SYSRESET_CMD_RESET_DEFAULT_COLD=y)' would avoid the repetition.
> diff --git a/doc/usage/cmd/reset.rst b/doc/usage/cmd/reset.rst
> @@ -11,7 +11,7 @@ Synopsis
>
> ::
>
> - reset [-w]
> + reset [-c|-w]
While here, -edl is documented further down but missing from the
synopsis. Please list it too so the synopsis matches the option list.
Regards,
Simon
