diff options
| author | Eric Christopher <echristo@gmail.com> | 2016-01-04 23:22:43 +0000 |
|---|---|---|
| committer | Eric Christopher <echristo@gmail.com> | 2016-01-04 23:22:43 +0000 |
| commit | 2aa83ff8071be375ee175c8b36004126fc8a29f9 (patch) | |
| tree | 962dddbc2dcba62d79f52450003e86672aed61f6 /llvm | |
| parent | 32a1ea1b7ec61b0b23a319053e2435cd11255aa1 (diff) | |
| download | bcm5719-llvm-2aa83ff8071be375ee175c8b36004126fc8a29f9.tar.gz bcm5719-llvm-2aa83ff8071be375ee175c8b36004126fc8a29f9.zip | |
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!
llvm-svn: 256791
Diffstat (limited to 'llvm')
| -rw-r--r-- | llvm/docs/CMake.rst | 5 | ||||
| -rw-r--r-- | llvm/docs/GettingStarted.rst | 2 |
2 files changed, 6 insertions, 1 deletions
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst index 38199e5cc58..9ec6b0a2416 100644 --- a/llvm/docs/CMake.rst +++ b/llvm/docs/CMake.rst @@ -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. diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index 2585ce135ba..6aba5003679 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/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 <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`` |

