-
Notifications
You must be signed in to change notification settings - Fork 13.7k
Rework --print options documentation
#138864
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This comment has been minimized.
This comment has been minimized.
2f60774 to
7210df1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, having some example output and more space to encourage proper docs is a great change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
...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`
...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``
...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
...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
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```
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