u-boot/doc/usage/cmd/panic.rst
Heinrich Schuchardt 60971e63e6 doc: create index entries for commands
Add the description of CLI commands to the generated index.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17 08:40:19 +01:00

36 lines
444 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
.. index::
single: panic (command)
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.