summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/panic.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage/cmd/panic.rst')
-rw-r--r--doc/usage/cmd/panic.rst33
1 files changed, 33 insertions, 0 deletions
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.