summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@qt.io>2020-04-15 06:33:10 +0200
committerJoerg Bornemann <joerg.bornemann@qt.io>2020-04-15 09:57:54 +0200
commit676b08f947098a3dd3d417a38631567157c4e757 (patch)
treef495e0d4c1d793ebe347e871420fb7e57bf31d1e
parentc35cd309f480d76e44e3bd806c40f96f0384e576 (diff)
Doc: Add note about the llvm installer on Windows
Note that one has to restart their build shell after installing llvm with the pre-built installer on Windows. Task-number: QTBUG-83429 Change-Id: Ife15ba8179bb53930315f597f05c09bd1a12cbeb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
index 201706b70..07082fa31 100644
--- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
+++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
@@ -637,6 +637,10 @@
install the \c libclang-dev package and its dependencies. For running QDoc,
the \c libclang package is required.
+ \note On Windows, after installing the pre-built LLVM you must restart your
+ build shell to ensure that LLVM's binary directory is added to the PATH
+ variable. This is needed to be able to run qdoc.
+
\section1 Set Clang location automatically
The Qt build system uses the tool \c llvm-config to discover the location