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>
2023-03-03 22:48:27 +01:00
parent ac2ac69080
commit 5ee8d90f54
2 changed files with 34 additions and 0 deletions
--- a/doc/usage/cmd/panic.rst
+++ 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.