From: Eric Christopher Date: Mon, 4 Jan 2016 23:22:43 +0000 (+0000) Subject: Update docs to recommend CMake >= v3.2. X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=7fdf13ed48a8dfbd6e8561e5ac573cc395ffbf1b;p=oota-llvm.git Update docs to recommend CMake >= v3.2. 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 --- diff --git a/docs/CMake.rst b/docs/CMake.rst index 38199e5cc58..9ec6b0a2416 100644 --- a/docs/CMake.rst +++ b/docs/CMake.rst @@ -26,7 +26,10 @@ Quick start We use here the command-line, non-interactive CMake interface. #. `Download `_ 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 + `_ + when running :doc:`Lit `. #. Open a shell. Your development tools must be reachable from this shell through the PATH environment variable. diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index 2585ce135ba..6aba5003679 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -78,6 +78,8 @@ Here's the short story for getting up and running quickly with LLVM: The usual build uses `CMake `_. If you would rather use autotools, see `Building LLVM with autotools `_. + 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``