From 09485ce6f3a961c741468998281f8f11cfc4e59e Mon Sep 17 00:00:00 2001 From: Charles Zablit Date: Tue, 21 Oct 2025 13:29:14 -0700 Subject: [PATCH 1/3] [docs][lldb] update the Windows tools instructions --- lldb/docs/resources/build.rst | 44 +++++++++++++++-------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst index 0db8c92ad49d6..86b15e0b88287 100644 --- a/lldb/docs/resources/build.rst +++ b/lldb/docs/resources/build.rst @@ -95,36 +95,30 @@ commands below. Windows ******* -* Visual Studio 2019. -* The latest Windows SDK. -* The Active Template Library (ATL). -* `GnuWin32 `_ for CoreUtils and Make. -* `Python 3 `_. Make sure to (1) get - the x64 variant if that's what you're targeting and (2) install the debug - library if you want to build a debug lldb. The standalone installer is the - easiest way to get the debug library. -* `Python Tools for Visual Studio - `_. 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). + * `SWIG for Windows `_ -The steps outlined here describes how to set up your system and install the +The steps outlined here describe 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 with the "Desktop Development with C++" workload and - the "Python Development" workload. -#. Install GnuWin32, making sure ``\bin`` is added to - your PATH environment variable. Verify that utilities like ``dirname`` and - ``make`` are available from your terminal. -#. Install SWIG for Windows, making sure ```` is added to - your PATH environment variable. Verify that ``swig`` is available from your - terminal. -#. Install Python 3 from the standalone installer and include the debug libraries - in the install, making sure the Python install path is added to your PATH - environment variable. +#. Install `Visual Studio ` with the + "Desktop Development with C++" workload. Make sure that the latest Windows + SDK and the Active Template Library (ATL) are installed. +#. If you plan to debug test failures or even write new tests at all, + `Python Tools for Visual Studio `_ is an + indispensable debugging extension to Visual Studio which enables full + editing and debugging support for Python (including mixed native/managed + debugging). +#. Install `Git Bash `_ and add + ``\usr\bin`` to your ``PATH``. Verify that utilities like + ``dirname`` and ``make`` are available from your terminal. +#. Install `Python 3 `_ from the + standalone installer and include the debug libraries in the install. Make + sure ``python`` is added to your ``PATH``. +#. Install `SWIG for Windows `_. Make sure + ``swig`` is added to your ``PATH`` and that ``swig -swiglib`` points to the + correct directory. #. Register the Debug Interface Access DLLs with the Registry from a privileged terminal. From e2d46a79e59d490dd8634f7c9d2e695e6661e7c0 Mon Sep 17 00:00:00 2001 From: Charles Zablit Date: Tue, 21 Oct 2025 15:41:34 -0700 Subject: [PATCH 2/3] fixup! [docs][lldb] update the Windows tools instructions --- lldb/docs/resources/build.rst | 44 +++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst index 86b15e0b88287..a1e1bca08bb3d 100644 --- a/lldb/docs/resources/build.rst +++ b/lldb/docs/resources/build.rst @@ -95,31 +95,29 @@ commands below. Windows ******* - -* `SWIG for Windows `_ - The steps outlined here describe 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. +required dependencies for building and testing LLDB on Windows. They only need +to be performed once. + +Build Requirements +^^^^^^^^^^^^^^^^^^ -#. Install `Visual Studio ` with the +1. Install `Visual Studio ` with the "Desktop Development with C++" workload. Make sure that the latest Windows SDK and the Active Template Library (ATL) are installed. -#. If you plan to debug test failures or even write new tests at all, - `Python Tools for Visual Studio `_ is an - indispensable debugging extension to Visual Studio which enables full - editing and debugging support for Python (including mixed native/managed - debugging). -#. Install `Git Bash `_ and add +2. Install `Git Bash `_ and add ``\usr\bin`` to your ``PATH``. Verify that utilities like - ``dirname`` and ``make`` are available from your terminal. -#. Install `Python 3 `_ from the - standalone installer and include the debug libraries in the install. Make - sure ``python`` is added to your ``PATH``. -#. Install `SWIG for Windows `_. Make sure + ``dirname`` are available from your terminal. +3. Install `make `_ and + verify that it's in your ``PATH``. +4. Install `Python 3 `_ from the + GUI installer. If you will be building LLDB in Debug mode, **include the + debug libraries** during the install. Make sure ``python`` is added to your + ``PATH``. +5. Install `SWIG for Windows `_. Make sure ``swig`` is added to your ``PATH`` and that ``swig -swiglib`` points to the correct directory. -#. Register the Debug Interface Access DLLs with the Registry from a privileged +6. Register the Debug Interface Access DLLs with the Registry from a privileged terminal. :: @@ -133,6 +131,16 @@ Prompt for VS `_, + an indispensable debugging extension to Visual Studio which enables full + editing and debugging support for Python (including mixed native/managed + debugging). + macOS ***** From e085cf742bc516c03e9bc90d8d1ea9abf9503a32 Mon Sep 17 00:00:00 2001 From: Charles Zablit Date: Thu, 23 Oct 2025 11:02:19 -0700 Subject: [PATCH 3/3] fixup! [docs][lldb] update the Windows tools instructions --- lldb/docs/resources/build.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst index a1e1bca08bb3d..2eb167709dbda 100644 --- a/lldb/docs/resources/build.rst +++ b/lldb/docs/resources/build.rst @@ -102,6 +102,8 @@ to be performed once. Build Requirements ^^^^^^^^^^^^^^^^^^ +Please follow the steps below if you only want to **build** lldb. + 1. Install `Visual Studio ` with the "Desktop Development with C++" workload. Make sure that the latest Windows SDK and the Active Template Library (ATL) are installed. @@ -134,7 +136,7 @@ corresponding to the version you wish to use or run ``vcvarsall.bat`` or Test Requirements ^^^^^^^^^^^^^^^^^ -If you plan to debug test failures or write new tests: +Please follow the steps above and below if you want to **test** `lldb`. * Install `Python Tools for Visual Studio `_, an indispensable debugging extension to Visual Studio which enables full