supreetsingh10 / lyricist

A rust rock music typing terminal application.
MIT License
13 stars 0 forks source link

Enable Link-Time Optimization (LTO) #1

Closed zamazan4ik closed 1 week ago

zamazan4ik commented 1 week ago

Hi!

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.

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 in addition 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 CLI tool 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

I have made quick tests (Fedora 41, Rustc 1.82) by adding lto = true to the Release profile. The binary size reduction is the following:

Thank you.

supreetsingh10 commented 1 week ago

Hi @zamazan4ik

Thank you very much for bringing this to my knowledge. I did not know about this. I have merged this into my main branch.

And I am closing this issue.

In case someone missed the above link https://doc.rust-lang.org/cargo/reference/profiles.html

Thanks Supreet