aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/cmake/policy/qtp0001.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/qml/doc/src/cmake/policy/qtp0001.qdoc')
-rw-r--r--src/qml/doc/src/cmake/policy/qtp0001.qdoc39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/qml/doc/src/cmake/policy/qtp0001.qdoc b/src/qml/doc/src/cmake/policy/qtp0001.qdoc
new file mode 100644
index 0000000000..a4e54ed1ae
--- /dev/null
+++ b/src/qml/doc/src/cmake/policy/qtp0001.qdoc
@@ -0,0 +1,39 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+\page qt-cmake-policy-qtp0001.html
+\ingroup qt-cmake-policies
+
+\title QTP0001
+\keyword qt_cmake_policy_qtp0001
+
+\summary {':/qt/qml/' is the default resource prefix for QML modules.}
+
+This policy was introduced in Qt 6.5. It changes where
+\l{qt_add_qml_module}{qt_add_qml_module()} stores QML resources in
+the resource system.
+
+Enabling this policy ensures that your QML module is placed under
+a default \l {QML Import Path}{import path}, and its types can be
+found without manual calls to \l QQmlEngine::addImportPath.
+
+The \c OLD behavior of this policy is that, the \c RESOURCE_PREFIX argument for
+\c{qt_add_qml_module()} defaults to \c{":/"}.
+
+The \c NEW behavior of this policy is that the \c RESOURCE_PREFIX argument
+for \c{qt_add_qml_module()} defaults to \c{":/qt/qml/"}. The new behavior
+ensures that modules are put into the \l{QML Import Path} and can be
+found without further setup.
+
+Qt 6.5 issues warnings if you do not pass any of the following arguments to the
+\c qt_add_qml_module command: \c RESOURCE_PREFIX, \c NO_RESOURCE_TARGET_PATH.
+Use the \l qt_policy command to suppress the warning by explicitly setting
+the policy to \c OLD or \c NEW.
+
+\qtpolicydeprecatedbehavior
+
+\sa qt_policy, {qt6_standard_project_setup}{qt_standard_project_setup()},
+ qt_cmake_policies, qt_add_qml_module
+
+*/