diff options
| author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-03-03 22:48:27 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-03-13 13:56:14 +0100 |
| commit | 5ee8d90f5469572f3b07d42857012d110476cd2f (patch) | |
| tree | 2655c5d6396a9405dfe4196623c73a2fbddc383a /doc | |
| parent | ac2ac6908095a22bb48ae3ca5f7a2596f7fc13a3 (diff) | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/cmd/panic.rst | 33 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 34 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. 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 |