[Lldb-commits] [lldb] r367407 - [lldb][docs] Add CMake version notes for -B flag

[Stefan Granitz via lldb-commits]

Author: stefan.graenitz
Date: Wed Jul 31 03:31:57 2019
New Revision: 367407

URL: http://llvm.org/viewvc/llvm-project?rev=367407&view=rev
Log:
[lldb][docs] Add CMake version notes for -B flag

The original documentation update was reviewed with D65330

Modified:
    lldb/trunk/docs/_static/lldb.css
    lldb/trunk/docs/resources/build.rst

Modified: lldb/trunk/docs/_static/lldb.css
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/_static/lldb.css?rev=367407&r1=367406&r2=367407&view=diff
==============================================================================
--- lldb/trunk/docs/_static/lldb.css (original)
+++ lldb/trunk/docs/_static/lldb.css Wed Jul 31 03:31:57 2019
@@ -10,6 +10,14 @@ div.body {
   max-width: 90%;
 }
 
+div.note {
+  padding: 20px 20px 10px 20px;
+}
+
+div.note p.admonition-title {
+  font-size: 130%;
+}
+
 table.mapping {
   width: 100%;
 }

Modified: lldb/trunk/docs/resources/build.rst
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/resources/build.rst?rev=367407&r1=367406&r2=367407&view=diff
==============================================================================
--- lldb/trunk/docs/resources/build.rst (original)
+++ lldb/trunk/docs/resources/build.rst Wed Jul 31 03:31:57 2019
@@ -125,10 +125,10 @@ checked out above, but now we will have
 * 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 wi
   > 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
 --------------------------