Skip to content

Debugging support chapter is somewhat outdated #1391

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

Closed
ehuss opened this issue Jul 14, 2022 · 4 comments · Fixed by #1393
Closed

Debugging support chapter is somewhat outdated #1391

ehuss opened this issue Jul 14, 2022 · 4 comments · Fixed by #1393

Comments

@ehuss
Copy link
Contributor

ehuss commented Jul 14, 2022

The chapter at https://rustc-dev-guide.rust-lang.org/debugging-support-in-rustc.html has several things that I noticed were out-of-date. Some observations:

  • The GDB fork hasn't been a thing for about 4 years now. I think that link and the mention that there is a fork could be removed.
  • The LLDB fork also hasn't been a thing for about as long. It is not built in CI, so all the notes about macOS and such should be removed. I believe none of it was upstreamed, so I think all of this information about LLDB is old enough to not be valuable, and I would suggest removing it.
  • I would remove the sections about shipping GDB and LLDB. I do not believe there are any plans to do this for the foreseeable future.
tshepang added a commit to tshepang/rustc-dev-guide that referenced this issue Jul 15, 2022
Closes rust-lang#1391

Also, do some small fixes/improvements while at it.
@tshepang
Copy link
Member

@ehuss should "Code signing for LLDB debug server on macOS" also be removed

@ehuss
Copy link
Contributor Author

ehuss commented Jul 15, 2022

I'm not sure how much to remove. I would consider just putting a prominent notice on the LLDB section that this is outdated/historical information, and then it can be reworked once things move forward again.

The debugging working group has been very recently talking about what approach they will take with lldb integration. So things are very much in flux in that regard.

Curiously, what are other (CLI) debuggers people use for Rust code.

I think gdb, lldb, windbg, and cdb are all used.

One peculiarity of this chapter is that it does not discuss the wrappers at all. The prebuilt Rust packages (and rustup) includes wrappers (rust-gdb, rust-gdbgui, rust-lldb). These are shell-script wrappers that launch the corresponding debugger with Python-based visualizers for common Rust types.

@tshepang
Copy link
Member

I'm not sure how much to remove. I would consider just putting a prominent notice on the LLDB section that this is outdated/historical information, and then it can be reworked once things move forward again.

Will leave that in in #1393 then... the rest is gone.

@tshepang
Copy link
Member

One peculiarity of this chapter is that it does not discuss the wrappers at all. The prebuilt Rust packages (and rustup) includes wrappers (rust-gdb, rust-gdbgui, rust-lldb). These are shell-script wrappers that launch the corresponding debugger with Python-based visualizers for common Rust types.

It's based on a single talk, so did not even attempt to be any comprehensive.

tshepang added a commit that referenced this issue Jul 15, 2022
Closes #1391

Also, do some small fixes/improvements while at it.
Kobzol pushed a commit to Kobzol/rustc-dev-guide that referenced this issue Jan 3, 2025
Closes rust-lang#1391

Also, do some small fixes/improvements while at it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants