about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorptitSeb <sebastien.chev@gmail.com>2025-09-08 11:27:37 +0200
committerptitSeb <sebastien.chev@gmail.com>2025-09-08 11:27:37 +0200
commite7d2cf55389b45afe37beb6c4996c99412da1605 (patch)
treee2ff1b206f65f5ef6edf90e9fc5968eab89f64c3
parent427f1b8c558b9ef7529aed7c69fe5619ea613b0f (diff)
downloadbox64-e7d2cf55389b45afe37beb6c4996c99412da1605.tar.gz
box64-e7d2cf55389b45afe37beb6c4996c99412da1605.zip
[DOCS] Some small fixing / precision in a few doc items
-rw-r--r--docs/USAGE.md12
-rw-r--r--docs/box64.pod12
-rw-r--r--docs/gen/usage.json12
3 files changed, 18 insertions, 18 deletions
diff --git a/docs/USAGE.md b/docs/USAGE.md
index 23e9ea0f..41dbb302 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -57,7 +57,7 @@ Enable/disable the Dynamic Recompiler (a.k.a DynaRec). This option defaults to 1
 Generate aligned atomics only (only available on Arm64 for now). Availble in WowBox64.
 
  * 0: Generate unaligned atomics handling code. [Default]
- * 1: Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on aligned data addresses. 
+ * 1: Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on unaligned data addresses. 
 
 ### BOX64_DYNAREC_BIGBLOCK
 
@@ -132,11 +132,11 @@ Enable x86 PAUSE emulation, may help the performance of spinlocks. Availble in W
 
 ### BOX64_DYNAREC_SAFEFLAGS
 
-Behaviour of flags emulation on CALL/RET opcodes. Availble in WowBox64.
+Behaviour of flags emulation on CALL/RET opcodes and other edge cases. Availble in WowBox64.
 
  * 0: Treat CALL/RET as if it never needs any flags. 
  * 1: Most of RETs will need flags, most of CALLs will not. [Default]
- * 2: All CALL/RET will need flags. 
+ * 2: All CALL/RET will need flags. All edge cases are also handled. 
 
 ### BOX64_DYNAREC_STRONGMEM
 
@@ -380,7 +380,7 @@ Detect MonoBleedingEdge and apply conservative settings.
 
 Enable or disable the generation of division-by-zero exception. Availble in WowBox64.
 
- * 0: Do not generate thr division-by-zero exception. [Default]
+ * 0: Do not generate the division-by-zero exception. [Default]
  * 1: Generate the division-by-zero exception. 
 
 ### BOX64_DYNAREC_TBB
@@ -490,10 +490,10 @@ Expose SHAEXT (a.k.a. SHA_NI) capabilities.
 
 ### BOX64_SSE_FLUSHTO0
 
-Behaviour of SSE Flush to 0 flags. Availble in WowBox64.
+Behaviour of SSE Flush to 0 flags. Also tracking SSE exception flags Availble in WowBox64.
 
  * 0: Just track the flag. [Default]
- * 1: Apply SSE Flush to 0 flag directly. 
+ * 1: Apply SSE Flush to 0 flag directly. Also reflect SSE exception flags in Dynarec (if available) 
 
 ### BOX64_SSE42
 
diff --git a/docs/box64.pod b/docs/box64.pod
index 0799422f..cad4a3f8 100644
--- a/docs/box64.pod
+++ b/docs/box64.pod
@@ -150,7 +150,7 @@ Enable/disable the Dynamic Recompiler (a.k.a DynaRec). This option defaults to 1
 Generate aligned atomics only (only available on Arm64 for now). Availble in WowBox64.
 
  * 0 : Generate unaligned atomics handling code. [Default]
- * 1 : Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on aligned data addresses. 
+ * 1 : Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on unaligned data addresses. 
 
 
 =item B<BOX64_DYNAREC_BIGBLOCK> =I<0|1|2|3>
@@ -201,7 +201,7 @@ Allow continue running a block that is unprotected and potentially dirty.
 
 Enable or disable the generation of division-by-zero exception. Availble in WowBox64.
 
- * 0 : Do not generate thr division-by-zero exception. [Default]
+ * 0 : Do not generate the division-by-zero exception. [Default]
  * 1 : Generate the division-by-zero exception. 
 
 
@@ -305,11 +305,11 @@ Generate map file for Linux perf tool.
 
 =item B<BOX64_DYNAREC_SAFEFLAGS> =I<0|1|2>
 
-Behaviour of flags emulation on CALL/RET opcodes. Availble in WowBox64.
+Behaviour of flags emulation on CALL/RET opcodes and other edge cases. Availble in WowBox64.
 
  * 0 : Treat CALL/RET as if it never needs any flags. 
  * 1 : Most of RETs will need flags, most of CALLs will not. [Default]
- * 2 : All CALL/RET will need flags. 
+ * 2 : All CALL/RET will need flags. All edge cases are also handled. 
 
 
 =item B<BOX64_DYNAREC_STRONGMEM> =I<0|1|2|3>
@@ -718,10 +718,10 @@ Always show SIGSEGV signal detailes.
 
 =item B<BOX64_SSE_FLUSHTO0> =I<0|1>
 
-Behaviour of SSE Flush to 0 flags. Availble in WowBox64.
+Behaviour of SSE Flush to 0 flags. Also tracking SSE exception flags Availble in WowBox64.
 
  * 0 : Just track the flag. [Default]
- * 1 : Apply SSE Flush to 0 flag directly. 
+ * 1 : Apply SSE Flush to 0 flag directly. Also reflect SSE exception flags in Dynarec (if available) 
 
 
 =item B<BOX64_SSE42> =I<0|1>
diff --git a/docs/gen/usage.json b/docs/gen/usage.json
index 03e4f041..6141d9b9 100644
--- a/docs/gen/usage.json
+++ b/docs/gen/usage.json
@@ -228,7 +228,7 @@
       },
       {
         "key": "1",
-        "description": "Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on aligned data addresses.",
+        "description": "Generate aligned atomics only, which is faster and smaller code size, but will cause SIGBUS for LOCK prefixed opcodes operating on unaligned data addresses.",
         "default": false
       }
     ]
@@ -351,7 +351,7 @@
     "options": [
       {
         "key": "0",
-        "description": "Do not generate thr division-by-zero exception.",
+        "description": "Do not generate the division-by-zero exception.",
         "default": true
       },
       {
@@ -611,7 +611,7 @@
   },
   {
     "name": "BOX64_DYNAREC_SAFEFLAGS",
-    "description": "Behaviour of flags emulation on CALL/RET opcodes.",
+    "description": "Behaviour of flags emulation on CALL/RET opcodes and other edge cases.",
     "category": "Performance",
     "wine": true,
     "options": [
@@ -627,7 +627,7 @@
       },
       {
         "key": "2",
-        "description": "All CALL/RET will need flags.",
+        "description": "All CALL/RET will need flags. All edge cases are also handled.",
         "default": false
       }
     ]
@@ -1554,7 +1554,7 @@
   },
   {
     "name": "BOX64_SSE_FLUSHTO0",
-    "description": "Behaviour of SSE Flush to 0 flags.",
+    "description": "Behaviour of SSE Flush to 0 flags. Also tracking SSE exception flags",
     "category": "Compatibility",
     "wine": true,
     "options": [
@@ -1565,7 +1565,7 @@
       },
       {
         "key": "1",
-        "description": "Apply SSE Flush to 0 flag directly.",
+        "description": "Apply SSE Flush to 0 flag directly. Also reflect SSE exception flags in Dynarec (if available)",
         "default": false
       }
     ]