[CI/CD] Build with lto enabled (#106)

* [CI/CD] Build with lto enabled * doc update * doc update * doc update * minor rewording
X16Community · May 17, 2023 · bc68572 · bc68572
1 parent ec44e01
commit bc68572
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -65,7 +65,7 @@ jobs:
         run: |
           git reset --hard
           git diff
-          TRACE=1 CROSS_COMPILE_WINDOWS=1 SDL2CONFIG=sdl2-config make V=1 -j2
+          TRACE=1 LTO=1 CROSS_COMPILE_WINDOWS=1 SDL2CONFIG=sdl2-config make V=1 -j2
           mkdir emu_binaries
           cp $(which SDL2.dll) emu_binaries/.
           cp $(which zlib1.dll) emu_binaries/.
@@ -131,7 +131,7 @@ jobs:
         run: |
           git reset --hard
           git diff
-          TRACE=1 WIN_SDL2=/mingw32 TARGET_CPU=x86 CROSS_COMPILE_WINDOWS=1 make V=1 -j2
+          TRACE=1 LTO=1 WIN_SDL2=/mingw32 TARGET_CPU=x86 CROSS_COMPILE_WINDOWS=1 make V=1 -j2
           mkdir emu_binaries
           cp $(which SDL2.dll) emu_binaries/.
           cp $(which zlib1.dll) emu_binaries/.
@@ -184,7 +184,7 @@ jobs:
           cp latest_rom/*.h src/.
       - name: Build Emulator
         run: |
-          TRACE=1 make V=1 -j3
+          TRACE=1 LTO=1 make V=1 -j3
           mkdir emu_binaries
           cp sdcard.img.zip emu_binaries/.
           cp x16emu emu_binaries/.
@@ -243,7 +243,7 @@ jobs:
           commands: |
             apt-get update
             apt-get install -y build-essential make libsdl2-dev file git
-            TRACE=1 make V=1 -j3
+            TRACE=1 LTO=1 make V=1 -j3
             mkdir emu_binaries
             cp sdcard.img.zip emu_binaries/.
             cp x16emu emu_binaries/.
@@ -303,7 +303,7 @@ jobs:
           commands: |
             apt-get update
             apt-get install -y build-essential make libsdl2-dev file git
-            TRACE=1 make V=1 -j3
+            TRACE=1 LTO=1 make V=1 -j3
             mkdir emu_binaries
             cp sdcard.img.zip emu_binaries/.
             cp x16emu emu_binaries/.
@@ -355,7 +355,7 @@ jobs:
           cp latest_rom/*.h src/.
       - name: Build Emulator
         run: |
-          TRACE=1 MAC_STATIC=1 LIBSDL_FILE=/usr/local/Cellar/sdl2/*/lib/libSDL2.a make V=1 -j3
+          TRACE=1 LTO=1 MAC_STATIC=1 LIBSDL_FILE=/usr/local/Cellar/sdl2/*/lib/libSDL2.a make V=1 -j3
           mkdir emu_binaries
           cp sdcard.img.zip emu_binaries/.
           cp x16emu emu_binaries/.
@@ -407,7 +407,7 @@ jobs:
           cp latest_rom/rom.bin .
       - name: Build Emulator
         run: |
-          make V=1 -j3 wasm
+          LTO=1 make V=1 -j3 wasm
           mkdir emu_binaries
           cp x16emu.data x16emu.html x16emu.js x16emu.wasm emu_binaries/
           mkdir emu_binaries/webassembly

diff --git a/RELEASES.md b/RELEASES.md
@@ -9,6 +9,11 @@
 
 This is the second release of x16-emulator by the X16Community team
 
+* **BREAKING CHANGE**
+	* The keyboard protocol between the emulated SMC and the KERNAL has changed, thus x16-emulator version R43 requires x16-rom version R43.
+	* This change also affects how the custom keyboard handler vector works (keyhdl). For details, see [Chapter 2 of the Programmer's Reference Guide](https://github.com/X16Community/x16-docs/blob/master/X16%20Reference%20-%2002%20-%20Editor.md#custom-keyboard-keynum-code-handler)
+	* **Your Keyboard will not work unless** you are running
+		* R43 of both x16-rom and x16-emulator
 * Features
 	* Updates to support translation from SDL scancodes to new keynum encoding supported by KERNAL [stefan-b-jakobsson]
 	* More granular support for RAM amount as argument to `-ram`
@@ -27,6 +32,7 @@ This is the second release of x16-emulator by the X16Community team
 	* New comamnd line option `-midline-effects` that supports mid-line changes to the palette or tile/sprite data. R42 always had this behavior, which results in performance degradation for programs write to VERA heavily if the host CPU is not fast enough. This behavior is now disabled by default. `-midline-effects` restores this optional behavior.
 	* New features implemented in the [ROM](https://github.com/X16Community/x16-rom/tree/r43#release-43-stockholm)
 * Other
+	* Release builds have link-time optimization enabled which seems to help performance.
 	* Add git hash of build to `-version` string.
 	* WebAssembly enhancements in the supporting html/js [Cyber-EX]
 	* Fixed potential off-by one row with non-zero DC_VSTART.