From a60966daa2ba4840c94e482e26b97d7a5cd10a6c Mon Sep 17 00:00:00 2001 From: Stefan Granitz Date: Wed, 31 Jul 2019 10:31:57 +0000 Subject: [PATCH] [lldb][docs] Add CMake version notes for -B flag The original documentation update was reviewed with D65330 llvm-svn: 367407 --- lldb/docs/_static/lldb.css | 8 ++++++++ lldb/docs/resources/build.rst | 19 +++++++++++++++---- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/lldb/docs/_static/lldb.css b/lldb/docs/_static/lldb.css index aef51a17260..53b72594083 100644 --- a/lldb/docs/_static/lldb.css +++ b/lldb/docs/_static/lldb.css @@ -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%; } 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!): [] /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 + `_ .. _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 + `_ + Building The Documentation --------------------------