maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[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
This commit is contained in:
Jonas Devlieghere 2020-01-06 13:57:55 -08:00
parent 62f3403bfc
commit 317cbdad4d
1 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
lldb/docs/resources/build.rst
View File

@ -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
*****