Skip to content

Clarify catch_unwind docs about panic hooks #105497

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 29, 2022
Merged

Clarify catch_unwind docs about panic hooks #105497

merged 1 commit into from
Dec 29, 2022

Conversation

albertlarsan68
Copy link
Member

Makes it clear from catch_unwind docs that the panic hook will be called before the panic is caught.

Fixes #105432

@rustbot
Copy link
Collaborator

rustbot commented Dec 9, 2022

r? @m-ou-se

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Dec 9, 2022
@rustbot
Copy link
Collaborator

rustbot commented Dec 9, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@albertlarsan68
Copy link
Member Author

@rustbot label +A-docs

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Dec 9, 2022
@albertlarsan68 albertlarsan68 mentioned this pull request Dec 9, 2022
Closed
@albertlarsan68
Copy link
Member Author

@m-ou-se Can this PR have a review, or if you can't please give it to somebody else pls?

m-ou-se
m-ou-se reviewed Dec 28, 2022
View reviewed changes
library/std/src/panic.rs Outdated
Comment on lines 117 to 118
/// If a custom panic hook has been set, note that it will be invoked before
/// the panic is caught.
Copy link
Member

Choose a reason for hiding this comment

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

Let's also mention that the hook is executed before unwinding starts:

Suggested change
/// If a custom panic hook has been set, note that it will be invoked before
/// the panic is caught.
/// Note that if a custom panic hook has been set, it will be invoked before
/// the panic is caught, before unwinding.

@m-ou-se m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 28, 2022
@albertlarsan68
Clarify catch_unwind docs about panic hooks
cb7c899 
Makes it clear from catch_unwind docs that the panic hook will be called
before the panic is caught.
@albertlarsan68 albertlarsan68 force-pushed the doc-panic-hook-and-catch-unwind branch from 261dc40 to cb7c899 Compare December 28, 2022 16:03
@albertlarsan68
Copy link
Member Author

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 28, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Dec 28, 2022

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 28, 2022

📌 Commit cb7c899 has been approved by m-ou-se

It is now in the queue for this repository.

@bors bors 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 Dec 28, 2022
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 28, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 28, 2022
@bors
Auto merge of rust-lang#106228 - matthiaskrgr:rollup-jsznhww, r=matth…
9709a43 
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#104402 (Move `ReentrantMutex` to `std::sync`)
 - rust-lang#104493 (available_parallelism: Gracefully handle zero value cfs_period_us)
 - rust-lang#105359 (Make sentinel value configurable in `library/std/src/sys_common/thread_local_key.rs`)
 - rust-lang#105497 (Clarify `catch_unwind` docs about panic hooks)
 - rust-lang#105570 (Properly calculate best failure in macro matching)
 - rust-lang#105702 (Format only modified files)
 - rust-lang#105998 (adjust message on non-unwinding panic)
 - rust-lang#106161 (Iterator::find: link to Iterator::position in docs for discoverability)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 0b7ed65 into rust-lang:master Dec 29, 2022
@rustbot rustbot added this to the 1.68.0 milestone Dec 29, 2022
@albertlarsan68 albertlarsan68 deleted the doc-panic-hook-and-catch-unwind branch December 29, 2022 08:35
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@m-ou-se m-ou-se m-ou-se left review comments

@saethlin saethlin saethlin approved these changes

Assignees

@m-ou-se m-ou-se

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.68.0
Development

Successfully merging this pull request may close these issues.

Panic handlers and order precedence?
5 participants
@albertlarsan68 @rustbot @m-ou-se @bors @saethlin