about summary refs log tree commit diff stats
path: root/docs
diff options
context:
space:
mode:
authorYang Liu <liuyang22@iscas.ac.cn>2024-12-18 15:11:09 +0800
committerGitHub <noreply@github.com>2024-12-18 08:11:09 +0100
commit47f5fe7caf92ed5b96b8d6b3e34a098bc6c2643a (patch)
treea0e24c61b2996c11a37ae17abeca1bcfe0cb9166 /docs
parent6e0f32f4ca4b35bda036caa6ad3abcae4ae64cdc (diff)
downloadbox64-47f5fe7caf92ed5b96b8d6b3e34a098bc6c2643a.tar.gz
box64-47f5fe7caf92ed5b96b8d6b3e34a098bc6c2643a.zip
[GDBJIT] Show x64pc in gdb, also added documentation (#2163)
* [GDBJIT] Show x64pc in gdb

* Add env. variable and documentation

* typo

* oops
Diffstat (limited to 'docs')
-rw-r--r--docs/USAGE.md5
-rw-r--r--docs/box64.pod7
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/USAGE.md b/docs/USAGE.md
index c41bbd39..cc41714a 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -239,6 +239,11 @@ Behavior with FillBlock is not available (FillBlock build Dynarec blocks and is
 * 0 : Dynarec will not wait for FillBlock to ready and use Interpreter instead (might speedup a bit massive multithread or JIT programs)

 * 1 : Dynarec will wait for FillBlock to be ready (Default)

 

+#### BOX64_DYNAREC_GDBJIT *

+The GDBJIT debugging support, only available with the compilation option GDBJIT=ON, enable it with gdb command: jit-reader-load /usr/local/lib/libbox64gdbjitreader.so.

+* 0 : Dynarec will not generate GDBJIT debuginfo. (Default)

+* 1 : Dynarec will generate GDBJIT debuginfo.

+

 #### BOX64_DYNAREC_MISSING *

 Dynarec print the missing opcodes

 * 0 : not print the missing opcode (Default, unless DYNAREC_LOG>=1 or DYNAREC_DUMP>=1 is used)

diff --git a/docs/box64.pod b/docs/box64.pod
index e450a4bd..f57fdfac 100644
--- a/docs/box64.pod
+++ b/docs/box64.pod
@@ -367,6 +367,13 @@ Behavior with FillBlock is not available (FillBlock build Dynarec blocks and is
     * 0 : Dynarec will not wait for FillBlock to ready and use Interpreter instead (might speedup a bit massive multithread or JIT programs)
     * 1 : Dynarec will wait for FillBlock to be ready (Default)
 
+=item B<BOX64_DYNAREC_GDBJIT>=I<0|1>
+
+The GDBJIT debugging support, only available with the compilation option GDBJIT=ON, enable it with gdb command: jit-reader-load /usr/local/lib/libbox64gdbjitreader.so.
+
+    * 0 : Dynarec will not generate GDBJIT debuginfo. (Default)
+    * 1 : Dynarec will generate GDBJIT debuginfo.
+
 =item B<BOX64_SSE_FLUSHTO0>=I<0|1>
 
 Handling of SSE Flush to 0 flags