Stop using legacy asm macro by default

ethteck · Jul 31, 2024 · 7727766 · 7727766
1 parent 5812a1e
commit 7727766
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # splat Release Notes
 
+### 0.25.0
+* Changed the default value of `use_legacy_include_asm` to false
+
 ### 0.24.7
 * splat no longer creates unnecessary directories for asm
 

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.24.7,<1.0.0
+splat64[mips]>=0.25.0,<1.0.0
 ```
 
 ### Optional dependencies

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -512,7 +512,7 @@ Same as `symbol_name_format` but for symbols with no rom address
 
 Determines whether to detect and hint to the user about likely file splits when disassembling.
 
-This setting can also be set on a per segment basis, if you'd like to enable or disable detection for specific segments. This could be useful when you are confident you identified all subsegments in a segment, yet `splat` still hints that subsegments could be split.  
+This setting can also be set on a per segment basis, if you'd like to enable or disable detection for specific segments. This could be useful when you are confident you identified all subsegments in a segment, yet `splat` still hints that subsegments could be split.
 
 ### pair_rodata_to_text
 
@@ -670,12 +670,14 @@ Append the type of an image to its file extension. For example, when enabled, a
 ## Compiler-specific options
 
 ### use_legacy_include_asm
-If `True`, generate c files using the longer `INCLUDE_ASM` macro. This is defaulted to `True` to by-default support projects using the longer macro.
+If `True`, generate c files using the longer old `INCLUDE_ASM` macro. The non-legacy `INCLUDE_ASM` macro is highly recommended, and the legacy version is only supported for compatibility reasons.
+
+For more information on these macros, see [macros](https://github.com/ethteck/splat/wiki/General-Workflow#macros).
 
 #### Usage
 ```yaml
-use_legacy_include_asm: False
+use_legacy_include_asm: True
 ```
 
 #### Default
-`True`
+`False`
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.24.7"
+version = "0.25.0"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}

diff --git a/src/splat/__init__.py b/src/splat/__init__.py
@@ -3,7 +3,7 @@
 __package_name__ = __name__
 
 # Should be synced with pyproject.toml
-__version__ = "0.24.7"
+__version__ = "0.25.0"
 __author__ = "ethteck"
 
 from . import util as util

diff --git a/src/splat/util/options.py b/src/splat/util/options.py
@@ -534,7 +534,7 @@ def parse_endianness() -> Literal["big", "little"]:
         ique_symbols=p.parse_opt("ique_symbols", bool, False),
         hardware_regs=p.parse_opt("hardware_regs", bool, False),
         image_type_in_extension=p.parse_opt("image_type_in_extension", bool, False),
-        use_legacy_include_asm=p.parse_opt("use_legacy_include_asm", bool, True),
+        use_legacy_include_asm=p.parse_opt("use_legacy_include_asm", bool, False),
         disasm_unknown=p.parse_opt("disasm_unknown", bool, False),
         detect_redundant_function_end=p.parse_opt(
             "detect_redundant_function_end", bool, True