Add documentation for debugger_visualizer attribute #1335
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ehuss
added
the
S-waiting-on-stabilization
dpaoliello
reviewed
Mar 4, 2023
src/attributes/debugger.md
Outdated
| @@ -0,0 +1,158 @@ | |||
| # Debugger attributes | |||
|
|
|||
| he following [attributes] are used for enhancing the debugging experience when using third-party debuggers like GDB or LLDB. | |||
src/attributes/debugger.md
Outdated
|
|
||
| ### Using `debugger_visualizer` with Natvis | ||
|
|
||
| Natvis is an XML-based framework for Microsoft debuggers (such as Visual Studio and WinDbg that uses declarative rules to customize the display of types. |
src/attributes/debugger.md
Outdated
| 1. Launch GDB with extra arguments to explicitly add a directory or binary to the auto-load safe path: `gdb -iex "set auto-load safe-path path/to/binary" path/to/binary` (For more information, see GDB's [auto-loading documentation]) | ||
| 1. Create a file named `gdbinit` under `$HOME/.config/gdb` (you may need to create the directory if it doesn't already exist). Add the following line to that file: `add-auto-load-safe-path path/to/binary`. | ||
|
|
||
| Consider a crate called `foobar` with this directory structure: |
5 tasks
madsmtm
reviewed
Mar 6, 2023
|
I applied some updates to the text. A rough overview of the changes:
|
ehuss
approved these changes
May 22, 2023
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
May 23, 2023
Update books ## rust-embedded/book 1 commits in d9eb4c3f75435b008881062ffa77bf0d1527b37d..f2aed2fe8e9f55508c86ba3aa4b6789b18a08a22 2023-05-12 12:26:37 UTC to 2023-05-12 12:26:37 UTC - Add link to Comprehensive Rust 🦀 (rust-embedded/book#354) ## rust-lang/nomicon 2 commits in b5f7500fc40775096c2bbd204eae096612cf9047..b5f018fb5930cb733b0a8aaf2eed975d4771e74d 2023-05-19 18:10:25 UTC to 2023-05-14 20:22:16 UTC - Expand unbounded lifetime example code and improve wording (rust-lang/nomicon#408) - Update to 2021 edition (rust-lang/nomicon#410) ## rust-lang/reference 5 commits in 28dc0f3576b55f5e57c5d6e65cd68ba3161e9fd5..553d99b02a53b4133a40d5bd2e19958c67487c00 2023-05-22 10:50:07 UTC to 2023-05-10 01:54:07 UTC - Update raw-dylib documentation for stabilization (rust-lang/reference#1345) - fix a typo (rust-lang/reference#1359) - fixed minor error in a comment that annotated output of a proc macro (rust-lang/reference#1358) - Fix example code in `impl` docs (rust-lang/reference#1360) - Add documentation for debugger_visualizer attribute (rust-lang/reference#1335) ## rust-lang/rustc-dev-guide 4 commits in 28dbeaf5c44bc7f5111ad412e99f2d7c5cec6c90..f1e637883fafeb83bdd5906ee7f467e4d35b7337 2023-05-18 02:44:05 UTC to 2023-05-11 09:59:23 UTC - Add note about shell completion scripts (rust-lang/rustc-dev-guide#1686) - filter out S-blocked issues in the "Getting Started" search (rust-lang/rustc-dev-guide#1687) - Rename InstCombine to InstSimplify (rust-lang/rustc-dev-guide#1684) - Use unpretty for debugging Hir (rust-lang/rustc-dev-guide#1685)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for the
debugger_visualizerattribute (Tracking issue for debugger_visualizer rust#95939). These docs describe use of the attribute with NatVis (Add a new Rust attribute to support embedding debugger visualizers rust#91779) and pretty printers (Add support for embedding pretty printers via #[debugger_visualizer] attribute rust#97028).