diff options
| author | Ulf Hermann <ulf.hermann@qt.io> | 2021-10-26 18:02:00 +0200 |
|---|---|---|
| committer | Ulf Hermann <ulf.hermann@qt.io> | 2021-10-28 12:58:41 +0000 |
| commit | 2fb875e8e83366eddc5d156be10f409fd19ae922 (patch) | |
| tree | f584e0e2e964f6cca694d173feeb76a6e1628986 /src/qml/doc/src | |
| parent | e4308747d3a27a5b942c5b79fcbb77f7b327ae67 (diff) | |
qt_add_qml_module: Be more explicit about directory structure
We need to communicate that repository folder names are case-sensitive.
Pick-to: 6.2
Change-Id: Ie7b2a431ceb0b8531edb6cef6b174ad91e02a15a
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/qml/doc/src')
| -rw-r--r-- | src/qml/doc/src/cmake/qt_add_qml_module.qdoc | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc index 4b42d7faac..d02c5eb1b3 100644 --- a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc +++ b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc @@ -371,12 +371,18 @@ target. For executables, the value will be the target path appended to \c{${CMAKE_CURRENT_BINARY_DIR}}, whereas for other targets it will be just \c{${CMAKE_CURRENT_BINARY_DIR}}. When the structure of the source tree matches the structure of QML module target paths (which is highly recommended), -\l QT_QML_OUTPUT_DIRECTORY often isn't needed. The need for specifying the -\c OUTPUT_DIRECTORY keyword should be rare, but if it is used, it is likely -that the caller will also need to add to the \l IMPORT_PATH to ensure that -\l{qmllint-auto}{linting}, \l{qmlcachegen-auto}{cached compilation} of qml -sources and \l{qt6_import_qml_plugins}{automatic importing} of plugins in -static builds all work correctly. +\l QT_QML_OUTPUT_DIRECTORY often isn't needed. In order to match the structure +of the target paths, you have to call your directories \e exactly like the +segments of your module URI. For example, if your module URI is +\c{MyUpperCaseThing.mylowercasething}, you need to put this in a directory +called \c{MyUpperCaseThing/mylowercasething/}. + +The need for specifying the \c OUTPUT_DIRECTORY keyword should be rare, but if +it is used, it is likely that the caller will also need to add to the +\l IMPORT_PATH to ensure that \l{qmllint-auto}{linting}, +\l{qmlcachegen-auto}{cached compilation} of qml sources and +\l{qt6_import_qml_plugins}{automatic importing} of plugins in static builds all +work correctly. \target NO_GENERATE_PLUGIN_SOURCE By default, \c{qt_add_qml_module()} will auto-generate a \c{.cpp} file that |