summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonas Devlieghere <jonas@devlieghere.com>2020-01-06 13:57:55 -0800
committerJonas Devlieghere <jonas@devlieghere.com>2020-01-06 13:59:24 -0800
commit317cbdad4d1b9ea7ec703072aba34eeb62c9d3af (patch)
treea322a459a681b5e9d254a3a57ce8fc8a9a177447
parent62f3403bfc17906aba555d6100e0136363f6a649 (diff)
downloadbcm5719-llvm-317cbdad4d1b9ea7ec703072aba34eeb62c9d3af.tar.gz
bcm5719-llvm-317cbdad4d1b9ea7ec703072aba34eeb62c9d3af.zip
[lldb/Docs] Describe optional dependencies on build page.
List the different CMake flags controlling the optional dependencies as per the discussion on the mailing list: http://lists.llvm.org/pipermail/lldb-dev/2020-January/015867.html
-rw-r--r--lldb/docs/resources/build.rst36
1 files changed, 31 insertions, 5 deletions
diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index f97b39564e9..ef290892b4f 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -29,9 +29,40 @@ The following requirements are shared on all platforms.
* `CMake <https://cmake.org>`_
* `Ninja <https://ninja-build.org>`_ (strongly recommended)
+
+If you want to run the test suite, you'll need to build LLDB with Python
+scripting support.
+
* `Python <http://www.python.org/>`_
* `SWIG <http://swig.org/>`_
+Optional Dependencies
+*********************
+
+Although the following dependencies are optional, they have a big impact on
+LLDB's functionality. It is strongly encouraged to build LLDB with these
+dependencies enabled.
+
+By default they are auto-detected: if CMake can find the dependency it will be
+used. It is possible to override this behavior by setting the corresponding
+CMake flag to ``On`` or ``Off`` to force the dependency to be enabled or
+disabled. When a dependency is set to ``On`` and can't be found it will cause a
+CMake configuration error.
+
++-------------------+------------------------------------------------------+--------------------------+
+| Feature | Description | CMake Flag |
++===================+======================================================+==========================+
+| Editline | Generic line editing, history, Emacs and Vi bindings | ``LLDB_ENABLE_LIBEDIT`` |
++-------------------+------------------------------------------------------+--------------------------+
+| Curses | Text user interface | ``LLDB_ENABLE_CURSES`` |
++-------------------+------------------------------------------------------+--------------------------+
+| LZMA | Lossless data compression | ``LLDB_ENABLE_LZMA`` |
++-------------------+------------------------------------------------------+--------------------------+
+| Python | Python scripting | ``LLDB_ENABLE_PYTHON`` |
++-------------------+------------------------------------------------------+--------------------------+
+| Lua | Lua scripting | ``LLDB_ENABLE_LUA`` |
++-------------------+------------------------------------------------------+--------------------------+
+
Depending on your platform and package manager, one might run any of the
commands below.
@@ -75,11 +106,6 @@ environment setup. This means you should run ``vcvarsall.bat`` or open an
appropriate Visual Studio Command Prompt corresponding to the version you wish
to use.
-Linux
-*****
-
-* `libedit <http://www.thrysoee.dk/editline>`_
-
macOS
*****
OpenPOWER on IntegriCloud