diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2018-08-02 13:58:41 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2018-08-02 14:46:15 +0000 |
| commit | 6db52757d81870fe547d62e677fa0757fd663fcb (patch) | |
| tree | 5d314cdc003e45b39fd1227571aa7057b4d0c861 | |
| parent | 262c25edb6ed3854166fd2bcee9299f32d33afd0 (diff) | |
| download | qttools-6db52757d81870fe547d62e677fa0757fd663fcb.tar.gz | |
Doc: Update Installing clang for QDoc page
* Remove temporal phrases (e.g. 'at this time', 'at the time of
writing')
* Remove references to Qt Creator's libclang and questions about static/
dynamic linking in the text.
* Describe LLVM and LLVM_INSTALL_DIR environment variable as
procedural prerequisites for building QDoc from source.
Task-number: QTBUG-69707
Change-Id: I688714b37721ed1180d500674ca4b271ed257799
Reviewed-by: Martin Smith <martin.smith@qt.io>
| -rw-r--r-- | src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 09c49b9cb..3ebd0c8de 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -632,16 +632,19 @@ \previouspage Getting Started with QDoc \nextpage Creating QDoc Configuration Files - As of this writing, the decision of whether to use static or dynamic - linking of libclang has not been made. The most likely outcome will be - to include libclang in the binary packages with QDoc and have the installer - put libclang in the same directory used for Creator's libclang. It is - hoped that both Creator and QDoc will eventually use the same version of - libclang, but as of this writing, QDoc might require a later version of - libclang than is required for Creator. - - As of this writing, users wishing to build and/or run QDoc must install - \l{http://clang.llvm.org}{LLVM 3.9} or greater and set the variable - LLVM_INSTALL_DIR accordingly. The pre-built binaries needed can be - found \l {http://releases.llvm.org/download.html}{here}. + If you are going to build QDoc from source, the following prerequisites + apply: + + \list 1 + \li Install \l{http://clang.llvm.org}{LLVM 3.9} or greater. + The pre-built binaries needed can be found + \l {http://releases.llvm.org/download.html}{here}. + \li Set the environment variable \c LLVM_INSTALL_DIR to point to the + directory where LLVM is installed. This should be the top level + directory. For example, on a Linux system with LLVM installed to + \c /usr/llvm: + \badcode + $ export LLVM_INSTALL_DIR=/usr/llvm + \endcode + \endlist */ |