diff options
| author | Sami Shalayel <sami.shalayel@qt.io> | 2024-02-20 11:33:42 +0100 |
|---|---|---|
| committer | Sami Shalayel <sami.shalayel@qt.io> | 2024-02-23 09:25:15 +0100 |
| commit | 53f8d787052dd37cb71ed463445b4640cf394643 (patch) | |
| tree | a10082dfa718c6528073031f01fe5737b3af6439 /src/qml/doc | |
| parent | 4de69daf82a278bea54dd62fd073449b0d8937f9 (diff) | |
doc: emphasize that .qmlls.ini should be ignored by version control
Change the note to a warning so it is harder to miss, and explicitly
mention that globbing is required because .qmlls.ini files are generated
for each subfolder that defines a QML module.
Fixes: QTBUG-122421
Change-Id: I4c2b1d14a163b5c5256d27d62a7e74ab12e97f3f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/cmake/cmake-variables.qdoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/src/qml/doc/src/cmake/cmake-variables.qdoc b/src/qml/doc/src/cmake/cmake-variables.qdoc index 79621542ca..4a7d1ff2f6 100644 --- a/src/qml/doc/src/cmake/cmake-variables.qdoc +++ b/src/qml/doc/src/cmake/cmake-variables.qdoc @@ -58,16 +58,18 @@ and is needed by \l{QML Language Server} to find user defined modules. See also \l{QML Language Server} about the other ways of passing build folder to QML Language Server. -As This variable is used for IDE integration, it should normally not be set in a project itself, but +As this variable is used for IDE integration, it should normally not be set in a project itself, but passed to CMake via an IDE or manually by passing \badcode -DQT_QML_GENERATE_QMLLS_INI=ON \endcode to the cmake executable. -\note The files generated by \c QT_QML_GENERATE_QMLLS_INI are only valid for the current -configuration and should be ignored by your version control system. For git, this can be -done by adding \c{.qmlls.ini} to your \c{.gitignore}, for example. +\warning The files generated by \c QT_QML_GENERATE_QMLLS_INI are only valid for the current +configuration and should be ignored by your version control system. For Git, add \tt{**\/.qmlls.ini} +to your top-level project \c{.gitignore}, for example. +The globbing is required because .qmlls.ini files are generated in \e{all source +subdirectories} that define QML Modules. */ |