diff options
author | Richard Weickelt <richard@weickelt.de> | 2019-05-05 16:35:43 +0200 |
---|---|---|
committer | Richard Weickelt <richard@weickelt.de> | 2019-05-13 13:00:52 +0000 |
commit | 966df461f6e90b6fb996f037b94e606ee9954522 (patch) | |
tree | 5ee77734ca1950cfdff6f11377a5b4f2591c2d71 | |
parent | 2fb4149f4646de4d9e7d3c9d0dbeb93c7615f856 (diff) | |
download | qttools-966df461f6e90b6fb996f037b94e606ee9954522.tar.gz |
Add build information for QDoc on Debian-based Linux distributions
For Debian-based Linux distributions, the installation instructions are
a bit misleading. It is generally not necessary to install a full-fledged
LLVM and the requirements for building and running are slightly different.
This patch makes it clear which packages need to be installed and how
LLVM_INSTALL_DIR needs to be configured in that case.
Task-number: QTBUG-68477
Change-Id: I06397d0d16fb29aba07a399b35b6ae3b32d5c80e
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
-rw-r--r-- | src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 7f355b2fe..fd6dc7a75 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -638,6 +638,10 @@ required pre-built binaries \l {http://releases.llvm.org/download.html}{here}. + To build QDoc on Debian-based Linux distributions, it is sufficient to + install the \c libclang-dev package and its dependencies. For running QDoc, + the \c libclang package is required. + \section1 Set Clang location automatically The Qt build system uses the tool \c llvm-config to discover the location @@ -665,13 +669,18 @@ If \c llvm-config is not in your \c PATH environment variable, or not installed on your system, you can still build QDoc, by manually setting the environment variable \c LLVM_INSTALL_DIR to point to the directory where - LLVM is installed. This directory should be the top level directory. For - example, on a Linux or macOS system with LLVM installed to \c /usr/llvm: + the Clang libraries are installed. This directory should be the top level + directory. For example, on a Linux or macOS system with LLVM installed to + \c /usr/llvm: \badcode $ export LLVM_INSTALL_DIR=/usr/llvm \endcode + Debian-based Linux distributions usually offer multiple versions of the + \c libclang packages, such as \c libclang-<VERSION>. In this case, + \c LLVM_INSTALL_DIR should contain \c /usr/lib/clang/<VERSION> . + On a Windows system with LLVM installed to \c {C:\Program Files\LLVM}: \badcode |