[PATCH 1/1] doc: man-page for panic command

[PATCH 1/1] doc: man-page for panic command

[Heinrich Schuchardt]

Provide a man-page for the panic command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 doc/usage/cmd/panic.rst | 33 +++++++++++++++++++++++++++++++++
 doc/usage/index.rst     |  1 +
 2 files changed, 34 insertions(+)
 create mode 100644 doc/usage/cmd/panic.rst

diff --git a/doc/usage/cmd/panic.rst b/doc/usage/cmd/panic.rst
new file mode 100644
index 0000000000..115eba5bde
--- /dev/null
+++ b/doc/usage/cmd/panic.rst
@@ -0,0 +1,33 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+panic command
+=============
+
+Synopis
+-------
+
+::
+
+    panic [message]
+
+Description
+-----------
+
+Display a message and reset the board.
+
+message
+    text to be displayed
+
+Examples
+--------
+
+::
+
+    => panic 'Unrecoverable error'
+    Unrecoverable error
+    resetting ...
+
+Configuration
+-------------
+
+If CONFIG_PANIC_HANG=y, the user has to reset the board manually.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index cde7dcb14a..aecb6cb762 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -64,6 +64,7 @@ Shell commands
    cmd/md
    cmd/mmc
    cmd/mtest
+   cmd/panic
    cmd/part
    cmd/pause
    cmd/pinmux
-- 
2.39.2

Re: [PATCH 1/1] doc: man-page for panic command

[Simon Glass]

On Fri, 3 Mar 2023 at 14:51, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Provide a man-page for the panic command.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  doc/usage/cmd/panic.rst | 33 +++++++++++++++++++++++++++++++++
>  doc/usage/index.rst     |  1 +
>  2 files changed, 34 insertions(+)
>  create mode 100644 doc/usage/cmd/panic.rst

Reviewed-by: Simon Glass <sjg@chromium.org>