[Lldb-commits] [lldb] 0f8cb68 - [lldb][Docs] Update the build guide

[David Spickett via lldb-commits]

Author: David Spickett
Date: 2024-03-08T10:43:17Z
New Revision: 0f8cb6818d788c34d70d586f701469a5adabfce1

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

LOG: [lldb][Docs] Update the build guide

* gmake is needed on FreeBSD
* pkg can install libxml2 on FreeBSD
* Make the swig note into an RST note box.

Added: 
    

Modified: 
    lldb/docs/resources/build.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index 55fe73c52f61aa..fe8e293db642e2 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -33,6 +33,9 @@ scripting support.
 * `Python <http://www.python.org/>`_
 * `SWIG <http://swig.org/>`_ 4 or later.
 
+If you are on FreeBSD or NetBSD, you will need to install ``gmake`` for building
+the test programs. On other platforms ``make`` is used.
+
 .. _Optional Dependencies:
 
 Optional Dependencies
@@ -71,16 +74,16 @@ commands below.
 
   $ yum install libedit-devel libxml2-devel ncurses-devel python-devel swig
   $ sudo apt-get install build-essential swig python3-dev libedit-dev libncurses5-dev
-  $ pkg install swig python
+  $ pkg install swig python libxml2
   $ pkgin install swig python36 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.
-
+.. note::
+   There is 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
 *******