Skip to content

Commit 692ebe5

Browse files
committed
[docs] Add DIA register instructions to Getting Started with Visual Studio page
Since Visual Studio 2017 the DIA libs are not registered by default, see: https://docs.microsoft.com/en-us/visualstudio/extensibility/breaking-changes-2017?view=vs-2019#change-reduce-registry-impact LLDB building instruction already specify registering these DLLs, required both the LLVM PDB tests and LLDB build. Differential Revision: https://reviews.llvm.org/D108811
1 parent 6ad47e1 commit 692ebe5

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

llvm/docs/GettingStartedVS.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
8282
if you want to develop `lldb <https://lldb.llvm.org/>`_, selecting
8383
**Download debug binaries** is useful.
8484
7. Complete the Python installation.
85-
8. Run a "Developer Command Prompt for VS 2019" as administrator. This command
85+
8. Run a "Developer Command Prompt for VS 2019" **as administrator**. This command
8686
prompt provides correct path and environment variables to Visual Studio and
8787
the installed tools.
8888
9. In the terminal window, type the commands:
@@ -96,7 +96,17 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
9696
install into a path containing spaces (e.g. ``c:\Documents and Settings\...``)
9797
as it will fail.
9898

99-
10. Install psutil and obtain LLVM source code:
99+
10. Register the Microsoft Debug Interface Access (DIA) DLLs
100+
101+
.. code-block:: bat
102+
103+
regsvr32 "%VSINSTALLDIR%\DIA SDK\bin\msdia140.dll"
104+
regsvr32 "%VSINSTALLDIR%\DIA SDK\bin\amd64\msdia140.dll"
105+
106+
The DIA library is required for LLVM PDB tests and
107+
`LLDB development <https://lldb.llvm.org/resources/build.html>`_.
108+
109+
11. Install psutil and obtain LLVM source code:
100110

101111
.. code-block:: bat
102112
@@ -108,7 +118,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
108118
Select the last link: ``Source code (zip)`` and unpack the downloaded file using
109119
Windows Explorer built-in zip support or any other unzip tool.
110120

111-
11. Finally, configure LLVM using CMake:
121+
12. Finally, configure LLVM using CMake:
112122

113123
.. code-block:: bat
114124
@@ -143,7 +153,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
143153
want to use the 64-bit toolset, pass the ``-Thost=x64`` flag when
144154
generating the Visual Studio solution. This requires CMake 3.8.0 or later.
145155

146-
12. Start Visual Studio and select configuration:
156+
13. Start Visual Studio and select configuration:
147157

148158
In the directory you created the project files will have an ``llvm.sln``
149159
file, just double-click on that to open Visual Studio. The default Visual
@@ -155,7 +165,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
155165
compiler flags, disabling optimization and enabling debug information, only
156166
for specific librares or source files you actually need to debug.
157167

158-
13. Test LLVM in Visual Studio:
168+
14. Test LLVM in Visual Studio:
159169

160170
You can run LLVM tests by merely building the project "check-all". The test
161171
results will be shown in the VS output window. Once the build succeeds, you

0 commit comments

Comments
 (0)