Improve documentation for codegen options #141554
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
the
S-waiting-on-review
Noratrieb
commented
May 25, 2025
| @@ -379,7 +396,7 @@ This flag controls the optimization level. | |||
| * `2`: some optimizations. | |||
| * `3`: all optimizations. | |||
| * `s`: optimize for binary size. | |||
| * `z`: optimize for binary size, but also turn off loop vectorization. | |||
| * `z`: optimize for binary size, but more aggressively. Often results in larger binaries than `s` | |||
There was a problem hiding this comment.
I took the description from https://llvm.org/doxygen/classllvm_1_1OptimizationLevel.html#a1e916712888d6a2d3952834c126460e7
The fact that it's often worse is based on experience
There was a problem hiding this comment.
I'd guess the old information was based on https://stackoverflow.com/questions/15548023/clang-optimization-levels
But that misses all the heuristics that are also affected by this flag, which are much more important (there's no way just not doing vectorization results in significantly bigger binaries)
jieyouxu
reviewed
May 25, 2025
Noratrieb
force-pushed
the
document-codegen-opts-better
branch
from
3290111 to
d83495c
Compare
This comment has been minimized.
This comment has been minimized.
Noratrieb
force-pushed
the
document-codegen-opts-better
branch
from
d83495c to
2413eb4
Compare
This comment has been minimized.
This comment has been minimized.
Noratrieb
force-pushed
the
document-codegen-opts-better
branch
from
2413eb4 to
71b39e5
Compare
bjorn3
reviewed
May 26, 2025
Noratrieb
force-pushed
the
document-codegen-opts-better
branch
from
71b39e5 to
8723cde
Compare
This comment has been minimized.
This comment has been minimized.
This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.
Noratrieb
force-pushed
the
document-codegen-opts-better
branch
from
8723cde to
198e89b
Compare
|
@bors r+ rollup=always |
bors
added
S-waiting-on-bors
bors
added a commit
that referenced
this pull request
Jun 3, 2025
Rollup of 9 pull requests Successful merges: - #141554 (Improve documentation for codegen options) - #141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…) - #141843 (Add `visit_id` to ast `Visitor`) - #141881 (Subtree update of `rust-analyzer`) - #141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id) - #141921 (Disable f64 minimum/maximum tests for arm 32) - #141930 (Enable triagebot `[concern]` functionality) - #141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`) - #141949 (move `test-float-parse` tool into `src/tools` dir) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
that referenced
this pull request
Jun 3, 2025
Rollup merge of #141554 - Noratrieb:document-codegen-opts-better, r=bjorn3 Improve documentation for codegen options This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior. r? bjorn3
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jun 4, 2025
…ommend-over-recommended, r=lqd Fix incorrect use of "recommend" over "recommended" Spotted this typo in rust-lang#141554, but it has since been merged. r? `@Noratrieb`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.
r? bjorn3