[PATCH v2 1/1] doc: exception command
Heinrich Schuchardt
xypron.glpk at gmx.de
Tue Jan 26 17:48:57 CET 2021
Create man-page for exception command.
Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
---
v2:
add missing exception.rst
---
doc/usage/exception.rst | 68 +++++++++++++++++++++++++++++++++++++++++
doc/usage/index.rst | 1 +
2 files changed, 69 insertions(+)
create mode 100644 doc/usage/exception.rst
diff --git a/doc/usage/exception.rst b/doc/usage/exception.rst
new file mode 100644
index 0000000000..412a03ba0f
--- /dev/null
+++ b/doc/usage/exception.rst
@@ -0,0 +1,68 @@
+exception command
+=================
+
+Synopsis
+--------
+
+::
+
+ exception <type>
+
+Description
+-----------
+
+The exception command is used to test the handling of exceptions like undefined
+instructions, segmentation faults or alignment faults.
+
+type
+ type of exception to be generated. The available types are architecture
+ dependent. Use 'help exception' to determine which are available.
+
+ **ARM:**
+
+ breakpoint
+ prefetch abort
+
+ unaligned
+ data abort
+
+ undefined
+ undefined instruction
+
+ **RISC-V:**
+
+ unaligned
+ load address misaligned
+
+ undefined
+ undefined instruction
+
+ **Sandbox:**
+
+ sigsegv
+ illegal memory access
+
+ undefined
+ undefined instruction
+
+ **x86:**
+
+ undefined
+ undefined instruction
+
+Examples
+--------
+
+::
+
+ => exception undefined
+
+ Illegal instruction
+ pc = 0x56076dd1a0f9, pc_reloc = 0x540f9
+
+ resetting ...
+
+Return value
+------------
+
+The return value $? is always set to 0 (true).
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index f75bd08237..83cfbafd90 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -19,6 +19,7 @@ Shell commands
button
conitrace
echo
+ exception
exit
false
for
--
2.29.2
More information about the U-Boot
mailing list