rust-lang / rust

Empowering everyone to build reliable and efficient software.
https://www.rust-lang.org
Other
97.33k stars 12.58k forks source link

Write down where all the unwind/backtrace code is #130257

Open workingjubilee opened 3 weeks ago

workingjubilee commented 3 weeks ago

Location

It's in at least three different locations, depending on how you count! That's the problem!

Summary

Internal-facing documentation, mostly?

The problem is this, essentially: we have our internal unwinding/backtrace-related code in

And the interrelationships are not so clean and obvious that you can simply follow imports, because sometimes the bridge is performed by raw compiler magic! Because, in fact, you do generally need compiler support to get a decent backtrace or to unwind correctly! So arguably I could also mention files like:

Understanding all of these should not be the exclusive province of a few wizened sages of the dark arts. They should all backref to an index that tracks them. And if any can be eliminated and merged into others without causing horrid problems, they should be.

ChrisDenton commented 3 weeks ago

At this point, do we need a spaghetti diagram?