diff options
| author | Ulf Hermann <ulf.hermann@qt.io> | 2022-08-01 15:26:27 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-29 15:28:20 +0000 |
| commit | 56e868bc5e3ee54d147680785fe058321812b7ca (patch) | |
| tree | e1d7e17ea6dfadd968fdcb6a8c463f3c638f7f05 | |
| parent | 9353a4e189515f63c673771775e81d7c763b0070 (diff) | |
Doc: Document behavior of remote implicit imports
They are remote directory imports for all practical purposes. Therefore,
you need to add qmldir files to make them work.
Fixes: QTBUG-92068
Change-Id: I7b11e55e53b2c96d95619ac2346cd45561e73b9a
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
(cherry picked from commit a22bd4164e10fd2e208d0fa6e3373c8e27996952)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/qml/doc/src/qmllanguageref/documents/definetypes.qdoc | 8 | ||||
| -rw-r--r-- | src/qml/doc/src/qmllanguageref/syntax/directoryimports.qdoc | 5 |
2 files changed, 11 insertions, 2 deletions
diff --git a/src/qml/doc/src/qmllanguageref/documents/definetypes.qdoc b/src/qml/doc/src/qmllanguageref/documents/definetypes.qdoc index 32c2e751a5..b5dd313348 100644 --- a/src/qml/doc/src/qmllanguageref/documents/definetypes.qdoc +++ b/src/qml/doc/src/qmllanguageref/documents/definetypes.qdoc @@ -53,8 +53,12 @@ The type name has the following requirements: This document is then automatically recognized by the engine as a definition of a QML type. Additionally, a type defined in this manner is automatically made -available to other QML files within the same directory as the engine searches -within the immediate directory when resolving QML type names. +available to other QML files within the same local directory as the engine +searches within the immediate directory when resolving QML type names. + +\note The QML engine does not automatically search remote directories this way. +You have to add a qmldir file if your documents are loaded over the network. See +\l{Importing QML Document Directories}. \section2 Custom QML Type Definition diff --git a/src/qml/doc/src/qmllanguageref/syntax/directoryimports.qdoc b/src/qml/doc/src/qmllanguageref/syntax/directoryimports.qdoc index 7ec8a4ff34..0623dd9934 100644 --- a/src/qml/doc/src/qmllanguageref/syntax/directoryimports.qdoc +++ b/src/qml/doc/src/qmllanguageref/syntax/directoryimports.qdoc @@ -109,6 +109,11 @@ a file system path. A directory of QML files can also be imported from a remote location if the directory contains a directory listing \c qmldir file. +\note This also holds for the implicit import of the directory a QML document +resides in. If your QML documents are loaded from a remote location, you need +to add qmldir files even if they don't contain any explicit directory import +statements. Otherwise your QML documents won't see each other. + For example, if the \c myapp directory in the previous example was hosted at "http://www.my-example-server.com", and the \c mycomponents directory contained a \c qmldir file defined as follows: |