Update docs to recommend CMake >= v3.2.
authorEric Christopher <echristo@gmail.com>
Mon, 4 Jan 2016 23:22:43 +0000 (23:22 +0000)
committerEric Christopher <echristo@gmail.com>
Mon, 4 Jan 2016 23:22:43 +0000 (23:22 +0000)
CMake v3.2 or newer is necessary to get interactive output when running
Lit via Ninja. Otherwise Ninja will buffer Lit's output, which makes
for a crummy experience -- you can't tell if your tests are hung!

Patch by Justin Lebar!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@256791 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CMake.rst
docs/GettingStarted.rst

index 38199e5cc5879dd89410e600f94d5822954c2c97..9ec6b0a2416ee0f1b6672a903032376eb70af925 100644 (file)
@@ -26,7 +26,10 @@ Quick start
 We use here the command-line, non-interactive CMake interface.
 
 #. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
-   CMake. Version 2.8.8 is the minimum required.
+   CMake. Version 2.8.8 is the minimum required, but if you're using the Ninja
+   backend, CMake v3.2 or newer is required to `get interactive output
+   <http://lists.llvm.org/pipermail/llvm-commits/Week-of-Mon-20141117/244797.html>`_
+   when running :doc:`Lit <CommandGuide/lit>`.
 
 #. Open a shell. Your development tools must be reachable from this shell
    through the PATH environment variable.
index 2585ce135ba652123a92415e850b46c13a1c1c88..6aba500367939e24953ec8eff08ef26574d50f37 100644 (file)
@@ -78,6 +78,8 @@ Here's the short story for getting up and running quickly with LLVM:
 
    The usual build uses `CMake <CMake.html>`_. If you would rather use
    autotools, see `Building LLVM with autotools <BuildingLLVMWithAutotools.html>`_.
+   Although the build is known to work with CMake >= 2.8.8, we recommend CMake
+   >= v3.2, especially if you're generating Ninja build files.
 
    * ``cd where you want to build llvm``
    * ``mkdir build``