Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Specify RUST_BACKTRACE is an env var on panic #56734

Closed
estebank opened this issue Dec 12, 2018 · 1 comment · Fixed by #56748
Closed

Specify RUST_BACKTRACE is an env var on panic #56734

estebank opened this issue Dec 12, 2018 · 1 comment · Fixed by #56748
Labels
A-diagnostics Area: Messages for errors, warnings, and lints

Comments

@estebank
Copy link
Contributor

The current panic message doesn't specify that RUST_BACKTRACE is an env variable, which can be difficult to understand for newcomers.

note: Run with `RUST_BACKTRACE=1` for a backtrace.
@estebank estebank added the A-diagnostics Area: Messages for errors, warnings, and lints label Dec 12, 2018
@estebank estebank mentioned this issue Dec 12, 2018
Closed
@kinnison
Copy link
Contributor

On the assumption that changing this message would not be considered a breaking change, I think this would be fairly easy and I'd like to give it a go to get my feet wet in the compiler codebase.

I would propose changing the message to:

note: Run with `RUST_BACKTRACE=1` in the environment to display a backtrace.

Would that be suitable?

@kinnison kinnison mentioned this issue Dec 12, 2018
Merged
kennytm added a commit to kennytm/rust that referenced this issue Dec 14, 2018
@kennytm
Rollup merge of rust-lang#56748 - kinnison:kinnison/fix-56734, r=dtolnay
123b72a 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-diagnostics Area: Messages for errors, warnings, and lints
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update panic message to be clearer about env-vars kinnison/rust
2 participants
@kinnison @estebank