Skip to content

Commit 691b855

Browse files
committed
Update documentation about use of NATVIS
The docs were still talking about Visual Studio 2013, which we've not supported in a while. I made the documentation a bit more vague because NATVIS is sometimes automatically picked up when building and sometimes requires manually installing the files. (For me, LLVM NATVIS is automatically picked up while Clang NATVIS needs manual installation; this happens because the way the monorepo is organized causes confusion when used with Visual Studio's built-in CMake functionality. Building from a .sln file generated by CMake may have better behavior in this case.)
1 parent 17ecb55 commit 691b855

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

clang/www/hacking.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ -->
44
<html>
55
<head>
6-
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6+
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
77
<title>Hacking on clang</title>
88
<link type="text/css" rel="stylesheet" href="menu.css">
99
<link type="text/css" rel="stylesheet" href="content.css">
@@ -104,11 +104,12 @@ <h3 id="debuggingVisualStudio">Debugging using Visual Studio</h3>
104104
<a href="https://github.com/llvm/llvm-project/blob/main/clang/utils/ClangVisualizers/clang.natvis">
105105
<tt>clang/utils/ClangVisualizers/clang.natvis</tt></a> provide debugger visualizers
106106
that make debugging of more complex data types much easier.</p>
107-
<p>For Visual Studio 2013 only, put the files into
108-
<tt>%USERPROFILE%\Documents\Visual Studio 2013\Visualizers</tt> or
109-
create a symbolic link so they update automatically.</p>
110-
<p>For later versions of Visual Studio, no installation is required.
111-
Note also that later versions of Visual Studio also display better visualizations.</p>
107+
<p>Depending on how you configure the project, Visual Studio may automatically
108+
use these visualizers when debugging or you may be required to put the files
109+
into <tt>%USERPROFILE%\Documents\Visual Studio &lt;version&gt;\Visualizers</tt>
110+
or create a symbolic link so they update automatically. See
111+
<a href="https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects">
112+
Microsoft's documentation</a> for more details on use of NATVIS.</p>
112113

113114
<!--=====================================================================-->
114115
<h2 id="testing">Testing</h2>

0 commit comments

Comments
 (0)