[clang] 691b855 - Update documentation about use of NATVIS

Mon Jul 31 09:27:01 PDT 2023

Author: Aaron Ballman
Date: 2023-07-31T12:26:51-04:00
New Revision: 691b855b0eb4077700c6043cbdb6a0b1ce4b790d

URL: https://github.com/llvm/llvm-project/commit/691b855b0eb4077700c6043cbdb6a0b1ce4b790d
DIFF: https://github.com/llvm/llvm-project/commit/691b855b0eb4077700c6043cbdb6a0b1ce4b790d.diff

LOG: 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.)

Added: 
    

Modified: 
    clang/www/hacking.html

Removed: 
    


################################################################################
diff  --git a/clang/www/hacking.html b/clang/www/hacking.html
index 55c4f0f9f5cf6b..2f46792d01d853 100755

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


        
