github-mirrors/cve2
1
0
Fork 0
mirror of https://github.com/openhwgroup/cve2.git synced 2025-04-23 13:37:20 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix documentation markup for tracer

Browse source 
The unordered list wasn't rendered properly due to a missing empty line
before it. Purely editorial change.
This commit is contained in:
Philipp Wagner 2020-06-16 13:19:39 +01:00 • committed by Philipp Wagner
parent 4eece98875
commit b302b6da92
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/tracer.rst
View file

@ -26,11 +26,14 @@ The trace output is in tab-separated columns.
3. **PC**: The program counter
4. **Instr**: The executed instruction (base 16).
32 bit wide instructions (8 hex digits) are uncompressed instructions, 16 bit wide instructions (4 hex digits) are compressed instructions.
5. **Decoded instruction**: The decoded (disassembled) instruction in a format equal to what objdump produces when calling it like ``objdump -Mnumeric -Mno-aliases -D``.
5. **Decoded instruction**:
The decoded (disassembled) instruction in a format equal to what objdump produces when calling it like ``objdump -Mnumeric -Mno-aliases -D``.
- Unsigned numbers are given in hex (prefixed with ``0x``), signed numbers are given as decimal numbers.
- Numeric register names are used (e.g. ``x1``).
- Symbolic CSR names are used.
- Jump/branch targets are given as absolute address if possible (PC + immediate).
6. **Register and memory contents**: For all accessed registers, the value before and after the instruction execution is given. Writes to registers are indicated as ``registername=value``, reads as ``registername:value``. For memory accesses, the address and the loaded and stored data are given.
.. code-block:: text