[Lldb-commits] [PATCH] D82507: [lldb/Docs] Add more details to the issues with custom Python installs on macOS

[Jonas Devlieghere via Phabricator via lldb-commits]

JDevlieghere created this revision.
JDevlieghere added a reviewer: friss.

Repository:
  rLLDB LLDB

https://reviews.llvm.org/D82507

Files:
  lldb/docs/resources/caveats.rst


Index: lldb/docs/resources/caveats.rst
===================================================================
--- lldb/docs/resources/caveats.rst
+++ lldb/docs/resources/caveats.rst
@@ -31,7 +31,30 @@
     the one used to build and link LLDB.
 
 The previous considerations are especially important during development, but
-apply to binary distributions of LLDB as well. For example, the LLDB that comes
-with Xcode links against the Python 3 that's part of Xcode. Therefore you
-should always use the Python in Xcode (through ``xcrun python3`` or
-``/usr/bin/python3``) to import the lldb module or install packages.
+apply to binary distributions of LLDB as well.
+
+LLDB in Xcode on macOS
+``````````````````````
+
+Users of lldb in Xcode on macOS commonly run into these issues when they
+install Python, often unknowingly as a dependency pulled in by Homebrew or
+another package manager. The problem is the symlinks this installs in
+``/usr/local/bin`` which comes before ``/usr/bin`` in your path. You can use
+``which python3`` to check to what it resolves.
+
+To be sure you use the Python that matches with the lldb in Xcode use ``xcrun``
+or use the absolute path to the shims in ``/usr/bin``.
+
+::
+
+   $ xcrun python3
+   $ /usr/bin/python3
+
+Similarly, to install packages and be able to use them from within lldb, you'll
+need to install them with the matching ``pip3``.
+
+::
+
+   $ xcrun pip3
+   $ /usr/bin/pip3
+


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D82507.273179.patch
Type: text/x-patch
Size: 1433 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20200624/f2f87336/attachment.bin>