Update panic message to be clearer about env-vars #56748
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @dtolnay (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
r? @estebank |
|
Thanks for the PR! Esteban will get back to you about whether this message is what they had in mind. |
|
@bors r+ |
|
📌 Commit f5ec9100b95e4801857641a35afde5b6e37ace45 has been approved by |
bors
added
S-waiting-on-bors
|
I think it would be valuable to use the wording "environment variable" because that is way more searchable than "in the environment" for people to whom it isn't clear how to set things in the environment. I would use the following variation which is only slightly wider than your current message. - Run with `RUST_BACKTRACE=1` in the environment to display a backtrace.
+ Run with `RUST_BACKTRACE=1` environment variable to display a backtrace. |
|
@bors r- |
bors
added
S-waiting-on-author
|
r=me after @dtolnay's change |
Esteban Kuber requested that the panic message make it clear that `RUST_BACKTRACE=1` is an environment variable. This change makes that clear. Wording provided in part by David Tolnay.
kinnison
force-pushed
the
kinnison/fix-56734
branch
from
f5ec910
to
6057147
Compare
|
I apologise for the delay. I agree with @dtolnay 's rewording and have amended the commit accordingly |
|
@bors r+ |
|
📌 Commit 6057147 has been approved by |
bors
added
S-waiting-on-bors
Update panic message to be clearer about env-vars Esteban Kuber requested that the panic message make it clear that `RUST_BACKTRACE=1` is an environment variable. This change makes that clear. I understand that this may simply be closed if the concept isn't accepted, and I'd be fine with that :-) Fixes rust-lang#56734
Rollup of 14 pull requests (first batch) Successful merges: - #56562 (Update libc version required by rustc) - #56609 (Unconditionally emit the target-cpu LLVM attribute.) - #56637 (rustdoc: Fix local reexports of proc macros) - #56658 (Add non-panicking `maybe_new_parser_from_file` variant) - #56695 (Fix irrefutable matches on integer ranges) - #56699 (Use a `newtype_index!` within `Symbol`.) - #56702 ([self-profiler] Add column for percent of total time) - #56708 (Remove some unnecessary feature gates) - #56709 (Remove unneeded extra chars to reduce search-index size) - #56744 (specialize: remove Boxes used by Children::insert) - #56748 (Update panic message to be clearer about env-vars) - #56749 (x86: Add the `adx` target feature to whitelist) - #56756 (Disable btree pretty-printers on older gdbs) - #56789 (rustc: Add an unstable `simd_select_bitmask` intrinsic) r? @ghost
Esteban Kuber requested that the panic message make it clear
that
RUST_BACKTRACE=1is an environment variable. This changemakes that clear.
I understand that this may simply be closed if the concept isn't accepted, and I'd be fine with that :-)
Fixes #56734