[PATCH v3 4/4] doc: usage: add usage details for reset cmd

[Heinrich Schuchardt]

On 3/31/21 10:16 PM, Igor Opaniuk wrote:
> From: Igor Opaniuk <igor.opaniuk at foundries.io>
>
> Add usage details for reset command.
>
> Signed-off-by: Igor Opaniuk <igor.opaniuk at foundries.io>
>
> ---
>
>   doc/usage/index.rst |  1 +
>   doc/usage/reset.rst | 26 ++++++++++++++++++++++++++
>   2 files changed, 27 insertions(+)
>   create mode 100644 doc/usage/reset.rst
>
> diff --git a/doc/usage/index.rst b/doc/usage/index.rst
> index 6c59bbadab..b1181011ae 100644
> --- a/doc/usage/index.rst
> +++ b/doc/usage/index.rst
> @@ -34,3 +34,4 @@ Shell commands
>      qfw
>      sbi
>      true
> +   reset

Dear Igor,

please, keep the alphabetic order.

> diff --git a/doc/usage/reset.rst b/doc/usage/reset.rst
> new file mode 100644
> index 0000000000..f8cf3579c8
> --- /dev/null
> +++ b/doc/usage/reset.rst
> @@ -0,0 +1,26 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +reset command
> +============

reset.rst:4:Title underline too short.

This leads to a build error for 'make htmldocs'.

> +
> +Synopsis
> +--------
> +
> +::
> +
> +    reset [-w]
> +
> +Description
> +-----------
> +
> +Perform reset of the CPU. By default does COLD reset, which resets CPU,
> +DDR and peripherals, on some boards also resets external PMIC.
> +
> +-w
> +    Do warm WARM, reset CPU but keep peripheral/DDR/PMIC active.
> +
> +
> +Return value
> +------------
> +
> +The return value $? is always set to 0 (true).

Please, mention that reset only returns in case of a failure.

Best regards

Heinrich

>