Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Improve documentation for codegen options by Noratrieb · Pull Request #141554 · rust-lang/rust · GitHub
Skip to content

Improve documentation for codegen options - #141554

Merged
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better
Jun 3, 2025
Merged

Improve documentation for codegen options#141554
bors merged 1 commit into
rust-lang:masterfrom
Noratrieb:document-codegen-opts-better

Conversation

@Noratrieb

Copy link
Copy Markdown
Member

This adds more information to many different codegen options. It should not add any new guarantees, just document existing behavior.

r? bjorn3

@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2025
* `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`

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadsrc/doc/rustc/src/codegen-options/index.md Outdated
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 3290111 to d83495cCompareMay 25, 2025 16:49
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from d83495c to 2413eb4CompareMay 25, 2025 17:45
@rust-log-analyzer

This comment has been minimized.

@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 2413eb4 to 71b39e5CompareMay 25, 2025 18:43
Comment threadsrc/doc/rustc/src/codegen-options/index.md
@Noratrieb
Noratriebforce-pushed the document-codegen-opts-better branch from 71b39e5 to 8723cdeCompareJune 1, 2025 12:15
@rust-log-analyzer

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
Noratriebforce-pushed the document-codegen-opts-better branch from 8723cde to 198e89bCompareJune 1, 2025 20:21
@bjorn3

Copy link
Copy Markdown
Member

@bors r+ rollup=always

@bors

bors commented Jun 3, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit 198e89b has been approved by bjorn3

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 3, 2025
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
@bors
bors merged commit 807778a into rust-lang:masterJun 3, 2025
@rustbotrustbot added this to the 1.89.0 milestone Jun 3, 2025
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`
rust-timer added a commit that referenced this pull request Jun 5, 2025
Rollup merge of #142017 - Rageking8:fix-incorrect-use-of-recommend-over-recommended, r=lqd
Fix incorrect use of "recommend" over "recommended"
Spotted this typo in #141554, but it has since been merged.
r? `@Noratrieb`
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Jun 9, 2025
Rollup of 9 pull requests
Successful merges:
- rust-lang/rust#141554 (Improve documentation for codegen options)
- rust-lang/rust#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang/rust#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang/rust#141881 (Subtree update of `rust-analyzer`)
- rust-lang/rust#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang/rust#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang/rust#141930 (Enable triagebot `[concern]` functionality)
- rust-lang/rust#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang/rust#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
tautschnig pushed a commit to model-checking/verify-rust-std that referenced this pull request Jun 17, 2025
…iaskrgr
Rollup of 9 pull requests
Successful merges:
- rust-lang#141554 (Improve documentation for codegen options)
- rust-lang#141817 (rustc_llvm: add Windows system libs only when cross-compiling from Wi…)
- rust-lang#141843 (Add `visit_id` to ast `Visitor`)
- rust-lang#141881 (Subtree update of `rust-analyzer`)
- rust-lang#141898 ([rustdoc-json] Implement PartialOrd and Ord for rustdoc_types::Id)
- rust-lang#141921 (Disable f64 minimum/maximum tests for arm 32)
- rust-lang#141930 (Enable triagebot `[concern]` functionality)
- rust-lang#141936 (Decouple "reporting in deps" from `FutureIncompatibilityReason`)
- rust-lang#141949 (move `test-float-parse` tool into `src/tools` dir)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Noratrieb@rust-log-analyzer@bjorn3@bors@jieyouxu@rustbot