summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorKatja Marttila <katja.marttila@qt.io>2021-02-19 09:40:52 +0200
committerKatja Marttila <katja.marttila@qt.io>2021-02-19 09:46:44 +0200
commit0fd130fb9f117f9783b7f8b0fd6234915cc0e7cc (patch)
treefa4ed04a5ec3775622f48af03e08f0383e56611f /doc
parentcaae77f94217d562959f213b766325220a81bd9f (diff)
Fix documentation for package directory name
Package directory name cannot contain characters ':' or '-' as those are used as a separator for version number. This information was not found clear enough in the documentation. Task-number: QTIFW-2146 Change-Id: Id291cf821f35b7ef5b6d720c94b46f2e83c9d6d9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/installerfw.qdoc4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 82cc57d8e..e9a6463bc 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -738,7 +738,9 @@
Place all components in the same root directory, which is called the
\e {package directory}. The directory name acts as a domain-like identifier,
- which identifies all components. For example, \c com.vendor.root.
+ which identifies all components. For example, \c com.vendor.root. The directory
+ name must not contain \c : or \c - characters as those are reserved for separating
+ the version number from the identifier.
Within the root directory, create subdirectories called \c data and \c meta.