[Lldb-commits] [lldb] ae73891 - [lldb/Docs] Update the Windows documentation

[Jonas Devlieghere via lldb-commits]

Author: Jonas Devlieghere
Date: 2020-02-18T19:53:36-08:00
New Revision: ae738911641660a63a102923c2beb070d6cebf39

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

LOG: [lldb/Docs] Update the Windows documentation

Update the build instructions for Windows with my recent experience.

Added: 
    

Modified: 
    lldb/docs/resources/build.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index 285ea0144d90..277303616f30 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -34,7 +34,7 @@ If you want to run the test suite, you'll need to build LLDB with Python
 scripting support.
 
 * `Python <http://www.python.org/>`_
-* `SWIG <http://swig.org/>`_
+* `SWIG <http://swig.org/>`_ 2 or later.
 
 Optional Dependencies
 *********************
@@ -79,29 +79,38 @@ commands below.
 Windows
 *******
 
-* Visual Studio 2015 or greater
-* Windows SDK 8.0 or higher. In general it is best to use the latest available
-  version.
-* `GnuWin32 <http://gnuwin32.sourceforge.net/>`_
-* `Python 3.5 or higher <https://www.python.org/downloads/windows/>`_ or
-  higher. Earlier versions of Python can be made to work by compiling your own
-  distribution from source, but this workflow is unsupported and you are own
-  your own.
+* Visual Studio 2017.
+* The latest Windows SDK.
+* The Active Template Library (ATL).
+* `GnuWin32 <http://gnuwin32.sourceforge.net/>`_ for CoreUtils and Make.
+* `Python 3.6 <https://www.python.org/downloads/windows/>`_. Python 3.7 is
+  known to be incompatible. More recent versions might work but are untested.
+  Make sure to get the x64 variant if that's what you're targetting and install
+  the debug library if you want to build in debug.
 * `Python Tools for Visual Studio
   <https://github.com/Microsoft/PTVS/releases>`_. If you plan to debug test
   failures or even write new tests at all, PTVS is an indispensable debugging
   extension to VS that enables full editing and debugging support for Python
-  (including mixed native/managed debugging)
+  (including mixed native/managed debugging).
 
 The steps outlined here describes how to set up your system and install the
 required dependencies such that they can be found when needed during the build
 process. They only need to be performed once.
 
-#. Install Visual Studio and the Windows SDK.
+#. Install Visual Studio with the Windows SDK and ATL components.
 #. Install GnuWin32, making sure ``<GnuWin32 install dir>\bin`` is added to
-   your PATH environment variable.
+   your PATH environment variable. Verify that utilities like ``dirname`` and
+   ``make`` are available from your terminal.
 #. Install SWIG for Windows, making sure ``<SWIG install dir>`` is added to
-   your PATH environment variable.
+   your PATH environment variable. Verify that ``swig`` is available from your
+   terminal.
+#. Register the Debug Interface Access DLLs with the Registry from a privileged
+   terminal.
+
+::
+
+> regsvr32 "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\DIA SDK\bin\msdia140.dll"
+> regsvr32 "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\DIA SDK\bin\amd64\msdia140.dll"
 
 Any command prompt from which you build LLDB should have a valid Visual Studio
 environment setup. This means you should run ``vcvarsall.bat`` or open an