diff mbox series

[v2,1/1] doc: exception command

Message ID 20210126164857.5081-1-xypron.glpk@gmx.de
State Accepted, archived
Commit 25be4d336fa994a17070f5a810f4dd6219b2c993
Delegated to: Heinrich Schuchardt
Headers show
Series [v2,1/1] doc: exception command | expand

Commit Message

Heinrich Schuchardt Jan. 26, 2021, 4:48 p.m. UTC 
Create man-page for exception command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@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

--
2.29.2
diff mbox series

Patch

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