summaryrefslogtreecommitdiffstats
path: root/lldb/docs/resources
diff options
context:
space:
mode:
authorStefan Granitz <stefan.graenitz@gmail.com>2019-07-31 10:31:57 +0000
committerStefan Granitz <stefan.graenitz@gmail.com>2019-07-31 10:31:57 +0000
commita60966daa2ba4840c94e482e26b97d7a5cd10a6c (patch)
tree7d9d10e431d0bad64021b4a6d85560e18e459795 /lldb/docs/resources
parent8eb5ba583cb97c10208c82da0ad8073009fb7a71 (diff)
downloadbcm5719-llvm-a60966daa2ba4840c94e482e26b97d7a5cd10a6c.tar.gz
bcm5719-llvm-a60966daa2ba4840c94e482e26b97d7a5cd10a6c.zip
[lldb][docs] Add CMake version notes for -B flag
The original documentation update was reviewed with D65330 llvm-svn: 367407
Diffstat (limited to 'lldb/docs/resources')
-rw-r--r--lldb/docs/resources/build.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index b8bac7adb3c..1e7f2d7f90f 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -125,10 +125,10 @@ checked out above, but now we will have two build-trees:
* the main build-tree for LLDB in ``/path/to/lldb-build``
* a provided build-tree for LLVM and Clang in ``/path/to/llvm-build``
-Run CMake with ``-B`` pointing to a new directory for the provided build-tree
-and the positional argument pointing to the ``llvm`` directory in the
-source-tree. Note that we leave out LLDB here and only include Clang.
-Then we build the ``ALL`` target with ninja:
+Run CMake with ``-B`` pointing to a new directory for the provided
+build-tree\ :sup:`1` and the positional argument pointing to the ``llvm``
+directory in the source-tree. Note that we leave out LLDB here and only include
+Clang. Then we build the ``ALL`` target with ninja:
::
@@ -151,6 +151,11 @@ case-sensitive!):
[<more cmake options>] /path/to/llvm-project/lldb
> ninja lldb
+.. note::
+
+ #. The ``-B`` argument was undocumented for a while and is only officially
+ supported since `CMake version 3.14
+ <https://cmake.org/cmake/help/v3.14/release/3.14.html#command-line>`_
.. _CommonCMakeOptions:
@@ -321,6 +326,12 @@ Build LLDB standalone for development with Xcode:
> open lldb.xcodeproj
> cmake --build /path/to/lldb-build --target check-lldb
+.. note::
+
+ The ``-B`` argument was undocumented for a while and is only officially
+ supported since `CMake version 3.14
+ <https://cmake.org/cmake/help/v3.14/release/3.14.html#command-line>`_
+
Building The Documentation
--------------------------
OpenPOWER on IntegriCloud