Rework --print options documentation
#138864
Merged
Conversation
This file contains 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
This comment has been minimized.
This comment has been minimized.
Urgau
force-pushed
the
rework-print-options-doc
branch
from
2f60774 to
7210df1
Compare
jieyouxu
approved these changes
Mar 24, 2025
Comment on lines
+5
to
+6
| Those options prints out various information about the compiler. Multiple options can be | ||
| specified, and the information is printed in the order the options are specified. |
There was a problem hiding this comment.
Discussion: should we explicitly point out something like, unless the output format is explicitly documented as a stability guarantee, then the output format may be intended for human consumptions only and may change between compiler versions?
(Meta: this is of course in comparison to something that would be first-class designed to be machine-consumable, like a --print-json=... e.g. #t-compiler/major changes > Add `--print=supported-crate-types` compiler-team#836 @ 💬)
There was a problem hiding this comment.
|
The discussion bit is mostly a .oO and does not block this PR at all. I think that may warrant a separate discussion, so I'll file a zulip thread. @bors r+ rollup |
bors
added
S-waiting-on-bors
jieyouxu
added
T-compiler
TaKO8Ki
added a commit
to TaKO8Ki/rust
that referenced
this pull request
Mar 24, 2025
…jieyouxu Rework `--print` options documentation This PR reworks the `--print` options documentation, by making it more like codegen options with a dedicated page. I also added some examples and split some paragraph into multiple paragraph since we now have more place. r? `@jieyouxu`
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Mar 24, 2025
…jieyouxu Rework `--print` options documentation This PR reworks the `--print` options documentation, by making it more like codegen options with a dedicated page. I also added some examples and split some paragraph into multiple paragraph since we now have more place. r? ``@jieyouxu``
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 24, 2025
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#138601 (add FCW to warn about wasm ABI transition) - rust-lang#138662 (Implement some basics in UEFI fs) - rust-lang#138800 (remove remnants of const_box feature) - rust-lang#138821 (match lowering cleanup: remove unused unsizing logic from `non_scalar_compare`) - rust-lang#138864 (Rework `--print` options documentation) - rust-lang#138868 (Add do_not_recommend typo help) - rust-lang#138882 (`with_scope` is only ever used for ast modules) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 24, 2025
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#138662 (Implement some basics in UEFI fs) - rust-lang#138800 (remove remnants of const_box feature) - rust-lang#138821 (match lowering cleanup: remove unused unsizing logic from `non_scalar_compare`) - rust-lang#138864 (Rework `--print` options documentation) - rust-lang#138868 (Add do_not_recommend typo help) - rust-lang#138882 (`with_scope` is only ever used for ast modules) - rust-lang#138894 (Update books) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 24, 2025
Rollup merge of rust-lang#138864 - Urgau:rework-print-options-doc, r=jieyouxu Rework `--print` options documentation This PR reworks the `--print` options documentation, by making it more like codegen options with a dedicated page. I also added some examples and split some paragraph into multiple paragraph since we now have more place. r? ```@jieyouxu```
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 PR reworks the
--printoptions documentation, by making it more like codegen options with a dedicated page.I also added some examples and split some paragraph into multiple paragraph since we now have more place.
r? @jieyouxu