[Lldb-commits] [PATCH] D88906: [lldb/docs] Clarify python/swig version incompatibility

[Pavel Labath via Phabricator via lldb-commits]

labath created this revision.
labath added reviewers: JDevlieghere, tatyana-krasnukha, amccarth.
Herald added a project: LLDB.
labath requested review of this revision.

The problematic combo is a debug python>=3.7 && swig<4.0.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D88906

Files:
  lldb/docs/resources/build.rst


Index: lldb/docs/resources/build.rst
===================================================================
--- lldb/docs/resources/build.rst
+++ lldb/docs/resources/build.rst
@@ -76,6 +76,12 @@
   > pkgin install swig python27 cmake ninja-build
   > brew install swig cmake ninja
 
+Note that there's an `incompatibility
+<https://github.com/swig/swig/issues/1321>` between Python version 3.7 and later
+and swig versions older than 4.0.0 which makes builds of lldb using debug
+versions of python unusable. This primarily affects windows, as debug builds of
+lldb must use debug python as well.
+
 Windows
 *******
 
@@ -83,10 +89,9 @@
 * The latest Windows SDK.
 * The Active Template Library (ATL).
 * `GnuWin32 <http://gnuwin32.sourceforge.net/>`_ for CoreUtils and Make.
-* `Python 3.6 or 3.8 <https://www.python.org/downloads/windows/>`_. Python 3.7
-  is known to be incompatible. Make sure to (1) get the x64 variant if that's
-  what you're targetting and (2) install the debug library if you want to build
-  a debug lldb.
+* `Python 3 <https://www.python.org/downloads/windows/>`_.  Make sure to (1) get
+  the x64 variant if that's what you're targetting and (2) install the debug
+  library if you want to build a debug lldb.
 * `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


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D88906.296474.patch
Type: text/x-patch
Size: 1428 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20201006/0b506e4a/attachment-0001.bin>