louis-e / arnis

Arnis - Generate cities from real life in Minecraft
GNU General Public License v3.0
432 stars 23 forks source link

[FEATURE] Enable Link-Time Optimization (LTO) #67

Closed zamazan4ik closed 1 month ago

zamazan4ik commented 2 months ago

Is your feature request related to a problem? Please describe. Not a problem - just an idea of how the project binary size and performance can be improved

Describe the solution you'd like I noticed that in the Cargo.toml file Link-Time Optimization (LTO) for the project is not enabled. I suggest switching it on since it will reduce the binary size (always a good thing to have) and will likely improve the application's performance a bit (not the case for the application but anyway - we are blazingly fast here).

I suggest enabling LTO only for the Release builds so as not to sacrifice the developers' experience while working on the project since LTO consumes an additional amount of time to finish the compilation routine. If you think that a regular Release build should not be affected by such a change as well, then I suggest adding an additional dist or release-lto profile where additionally to regular release optimizations LTO will also be added. Such a change simplifies life for maintainers and others interested in the project persons who want to build the most performant version of the application. Using ThinLTO should also help to reduce the build-time overhead with LTO. If we enable it on the Cargo profile level, users, who install the application with cargo install, will get the LTO-optimized version "automatically". E.g., check cargo-outdated Release profile.

Basically, it can be enabled with the following lines:

[profile.release]
lto = true

Additional context N/A

louis-e commented 1 month ago

Thanks a lot for that hint! :)