From e8a782fb2c4084cd88778e263cef5e323505e145 Mon Sep 17 00:00:00 2001 From: Andreas Eliasson Date: Mon, 20 Jun 2022 11:48:13 +0200 Subject: Doc: Document QML_IMPORTS_PATH and QMLPATHS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes: QTBUG-101615 Pick-to: 6.4 6.3 6.2 5.15 Change-Id: I0c83f36db4e4731095610683c4a722438f9b804e Reviewed-by: Topi Reiniö --- qmake/doc/src/qmake-manual.qdoc | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'qmake/doc/src') diff --git a/qmake/doc/src/qmake-manual.qdoc b/qmake/doc/src/qmake-manual.qdoc index 6255e0e451..64a00b2df5 100644 --- a/qmake/doc/src/qmake-manual.qdoc +++ b/qmake/doc/src/qmake-manual.qdoc @@ -1827,9 +1827,33 @@ \target QML_IMPORT_PATH \section1 QML_IMPORT_PATH - This variable is only used by \l{Qt Creator Manual}{Qt Creator}. + This variable is only used by \l{Qt Creator Manual}{Qt Creator}. If you have + an extra module that is kept outside of your Qt installation, you can + specify its path here. + See \l{Qt Creator: Using QML Modules with Plugins} for details. + \target QMLPATHS + \section1 QMLPATHS + + Expects a list of import paths that point to root directories of trees of + QML modules. For example, if you have a custom location for your QML + modules, you can specify it here. + + \note The path entries for QMLPATHS point to root directories of trees of + QML modules. This is the concept of import paths the QML engine understands. + You can pass the same paths via the \c QML_IMPORT_PATH \e environment variable + to your QML application, but they are \e different from the expected contents + of the \l QML_IMPORT_PATH \e qmake variable. The latter expects paths to + \e individual modules to be processed by Qt Creator only. + + \note The contents of QMLPATHS are \e not automatically passed to your + application. Rather, they are only used at build time. In particular, + qmlimportscanner uses them to find any QML modules it may need to mark as + imported by your application. + + \sa QQmlEngine::addImportPath() + \target QMAKE_systemvariable \section1 QMAKE -- cgit v1.2.3