From 6b99b1c7cba3f522e3df619eef060e3c96bfb32e Mon Sep 17 00:00:00 2001 From: Nikolai Kosjar Date: Wed, 5 Aug 2015 16:10:42 +0200 Subject: [PATCH] Doc: update information about Clang Code Model Plugin II * Update the instructions on building clang. * State the minimum version of clang that is necessary (3.6.2). * Rearrange the "acquire clang entries", the least time-consuming method for acquiring clang comes first now. Change-Id: Ie0a80fa507be20fd7c3f09930de03a88634cccce Reviewed-by: Leena Miettinen Reviewed-by: Marco Bubke --- doc/src/editors/creator-clang-codemodel.qdoc | 58 ++++++-------------- 1 file changed, 17 insertions(+), 41 deletions(-) diff --git a/doc/src/editors/creator-clang-codemodel.qdoc b/doc/src/editors/creator-clang-codemodel.qdoc index 5effcc64583..fedc2998041 100644 --- a/doc/src/editors/creator-clang-codemodel.qdoc +++ b/doc/src/editors/creator-clang-codemodel.qdoc @@ -96,35 +96,30 @@ \list 1 - \li To build the Clang code model plugin, you must acquire Clang and - LLVM in one of the following ways: + \li Acquire Clang 3.6.0 or higher in one of the following ways: \list - \li Build optimized versions of LLVM and Clang, as instructed in - \l{http://clang.llvm.org/get_started.html} - {Getting Started: Building and Running Clang}. - - The instructions describe how to build debug versions. To - build optimized versions, enter the following command - instead of just \c make: - - \c{make ENABLE_OPTIMIZED=1} - - For information about Git mirrors, see - \l{http://llvm.org/docs/GettingStarted.html#git-mirror} - {Git Mirror}. - - Install the built versions by entering the following - command: - - \c{make install} + \li Use the package manager of your system. \li Download and install LLVM from the \l{http://llvm.org/releases/}{LLVM Download Page} or \l{http://llvm.org/builds/}{LLVM Snapshot Builds}. - \li Use the package manager of your system. + \li Build Clang by following + \l{http://clang.llvm.org/get_started.html} + {Getting Started: Building and Running Clang}. + + Add the following options to the \c cmake call in order to + build an optimized version and to specify the installation + directory: + + \c -DCMAKE_BUILD_TYPE=Release + \c -DCMAKE_INSTALL_PREFIX=/your/install/dir + + After building, install with + + \c {make install} \endlist @@ -132,26 +127,7 @@ of LLVM either as part of the build environment or pass it directly to qmake when you build \QC. - The following are examples of the LLVM_INSTALL_DIR values to use - depending on the installation method: - - \list - - \li Installed via package manager on Linux: - - \c {LLVM_INSTALL_DIR=/usr/lib/llvm-3.6} - - \li Manually built on Unix in release mode: - - \c {LLVM_INSTALL_DIR=$HOME/llvm-build/Release+Asserts} - - \li Installed from a snapshot on Windows: - - \c {LLVM_INSTALL_DIR=C:\llvm} - - \endlist - - \li Rebuild \QC. + \li Rerun \c qmake and build \QC. \endlist