summaryrefslogtreecommitdiffstats
path: root/src/doc/unstable-book/src/language-features/debugger-visualizer.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/unstable-book/src/language-features/debugger-visualizer.md')
-rw-r--r--src/doc/unstable-book/src/language-features/debugger-visualizer.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/language-features/debugger-visualizer.md b/src/doc/unstable-book/src/language-features/debugger-visualizer.md
new file mode 100644
index 000000000..c7a0414b6
--- /dev/null
+++ b/src/doc/unstable-book/src/language-features/debugger-visualizer.md
@@ -0,0 +1,27 @@
+# `debugger_visualizer`
+
+The tracking issue for this feature is: [#95939]
+
+[#95939]: https://github.com/rust-lang/rust/issues/95939
+
+------------------------
+
+The `debugger_visualizer` attribute can be used to instruct the compiler
+to embed a debugger visualizer file into the PDB/ELF generated by `rustc`.
+
+## Examples
+
+``` rust,ignore (partial-example)
+#![feature(debugger_visualizer)]
+#![debugger_visualizer(natvis_file = "foo.natvis")]
+#![debugger_visualizer(gdb_script_file = "foo.py")]
+struct Foo {
+
+}
+```
+
+## Limitations
+
+Currently, this feature only supports embedding Natvis files on `-windows-msvc`
+targets via the `natvis_file` meta item. `-windows-gnu` targets are not currently
+supported.