Skip to content

Commit c2aa22f

Browse files
[docs][lldb] update the Windows tools instructions (llvm#164491)
This patch updates the instructions explaining how to install the required tools for building `lldb` on Windows, mostly removing the duplication and removing references to `GnuWin32` which still has executables built in 2009 and is no longer functional per their website.
1 parent 52377fb commit c2aa22f

File tree

1 file changed

+35
-31
lines changed

1 file changed

+35
-31
lines changed

lldb/docs/resources/build.rst

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -95,37 +95,31 @@ commands below.
9595
Windows
9696
*******
9797

98-
* Visual Studio 2019.
99-
* The latest Windows SDK.
100-
* The Active Template Library (ATL).
101-
* `GnuWin32 <http://gnuwin32.sourceforge.net/>`_ for CoreUtils and Make.
102-
* `Python 3 <https://www.python.org/downloads/windows/>`_. Make sure to (1) get
103-
the x64 variant if that's what you're targeting and (2) install the debug
104-
library if you want to build a debug lldb. The standalone installer is the
105-
easiest way to get the debug library.
106-
* `Python Tools for Visual Studio
107-
<https://github.com/Microsoft/PTVS/>`_. If you plan to debug test failures
108-
or even write new tests at all, PTVS is an indispensable debugging
109-
extension to VS that enables full editing and debugging support for Python
110-
(including mixed native/managed debugging).
111-
* `SWIG for Windows <http://www.swig.org/download.html>`_
112-
113-
The steps outlined here describes how to set up your system and install the
114-
required dependencies such that they can be found when needed during the build
115-
process. They only need to be performed once.
116-
117-
#. Install Visual Studio with the "Desktop Development with C++" workload and
118-
the "Python Development" workload.
119-
#. Install GnuWin32, making sure ``<GnuWin32 install dir>\bin`` is added to
120-
your PATH environment variable. Verify that utilities like ``dirname`` and
121-
``make`` are available from your terminal.
122-
#. Install SWIG for Windows, making sure ``<SWIG install dir>`` is added to
123-
your PATH environment variable. Verify that ``swig`` is available from your
124-
terminal.
125-
#. Install Python 3 from the standalone installer and include the debug libraries
126-
in the install, making sure the Python install path is added to your PATH
127-
environment variable.
128-
#. Register the Debug Interface Access DLLs with the Registry from a privileged
98+
The steps outlined here describe how to set up your system and install the
99+
required dependencies for building and testing LLDB on Windows. They only need
100+
to be performed once.
101+
102+
Build Requirements
103+
^^^^^^^^^^^^^^^^^^
104+
105+
Please follow the steps below if you only want to **build** lldb.
106+
107+
1. Install `Visual Studio <https://visualstudio.microsoft.com>` with the
108+
"Desktop Development with C++" workload. Make sure that the latest Windows
109+
SDK and the Active Template Library (ATL) are installed.
110+
2. Install `Git Bash <https://git-scm.com/install/windows>`_ and add
111+
``<Git install dir>\usr\bin`` to your ``PATH``. Verify that utilities like
112+
``dirname`` are available from your terminal.
113+
3. Install `make <https://sourceforge.net/projects/ezwinports/files/>`_ and
114+
verify that it's in your ``PATH``.
115+
4. Install `Python 3 <https://www.python.org/downloads/windows/>`_ from the
116+
GUI installer. If you will be building LLDB in Debug mode, **include the
117+
debug libraries** during the install. Make sure ``python`` is added to your
118+
``PATH``.
119+
5. Install `SWIG for Windows <http://www.swig.org/download.html>`_. Make sure
120+
``swig`` is added to your ``PATH`` and that ``swig -swiglib`` points to the
121+
correct directory.
122+
6. Register the Debug Interface Access DLLs with the Registry from a privileged
129123
terminal.
130124

131125
::
@@ -139,6 +133,16 @@ Prompt for VS <https://docs.microsoft.com/en-us/visualstudio/ide/reference/comma
139133
corresponding to the version you wish to use or run ``vcvarsall.bat`` or
140134
``VsDevCmd.bat``.
141135

136+
Test Requirements
137+
^^^^^^^^^^^^^^^^^
138+
139+
Please follow the steps above and below if you want to **test** `lldb`.
140+
141+
* Install `Python Tools for Visual Studio <https://github.com/Microsoft/PTVS/>`_,
142+
an indispensable debugging extension to Visual Studio which enables full
143+
editing and debugging support for Python (including mixed native/managed
144+
debugging).
145+
142146
macOS
143147
*****
144148

0 commit comments

Comments
 (0)