summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@qt.io>2022-08-05 09:44:42 +0200
committerJoerg Bornemann <joerg.bornemann@qt.io>2022-08-09 12:57:12 +0200
commit4d68db43e6634b71e88085df8d57746b33ad7846 (patch)
treec4d40d8db0819413a0957e32352e32d2e2978edf
parentd405713647da23b8d218c097fb4f2457d853c669 (diff)
Doc: Document the .base modifier for qmake resources
Pick-to: 6.4 Change-Id: If8484e9bcf0aa7f0f59102b7b0120defdcd7b3fb Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/corelib/doc/src/resource-system.qdoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/corelib/doc/src/resource-system.qdoc b/src/corelib/doc/src/resource-system.qdoc
index 45934a29d0..8cee601c67 100644
--- a/src/corelib/doc/src/resource-system.qdoc
+++ b/src/corelib/doc/src/resource-system.qdoc
@@ -110,6 +110,15 @@
\snippet resource-system/application.pro 1
+ This creates a resource of several \c{.png} files, that are addressable
+ like this: \c{":/images/copy.png"}.
+
+ If the directory layout of the files you want to embed into the resource
+ doesn't match the expectations of the application, you can specify
+ \c{resources.base}. \c base is a path prefix that denotes the root point of
+ the file's alias. In the example above, if \c{resources.base} is set to
+ \c{"images"}, then \c{copy.png} is addressable as \c{":/copy.png"}.
+
\section1 Runtime API
Qt API that deals with iterating and reading files has built-in support for