From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Fri, 3 Mar 2023 21:48:27 +0000 (+0100)
Subject: doc: man-page for panic command
X-Git-Url: http://git.dujemihanovic.xyz/img/static/gitweb.css?a=commitdiff_plain;h=5ee8d90f5469572f3b07d42857012d110476cd2f;p=u-boot.git

doc: man-page for panic command

Provide a man-page for the panic command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
---

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 840c20c934..ebf5eea9f8 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -65,6 +65,7 @@ Shell commands
    cmd/md
    cmd/mmc
    cmd/mtest
+   cmd/panic
    cmd/part
    cmd/pause
    cmd/pinmux