summaryrefslogtreecommitdiffstats
path: root/doc/installerfw.qdoc
diff options
context:
space:
mode:
authorArttu Tarkiainen <arttu.tarkiainen@qt.io>2023-09-25 15:46:33 +0300
committerArttu Tarkiainen <arttu.tarkiainen@qt.io>2023-09-29 09:33:57 +0300
commit170d9b46b4f3ff3d1bdf9a1c2550c2c34ff9b591 (patch)
tree32c32d604ea7a6e7df2bab49bf0880cdf0c6d6e9 /doc/installerfw.qdoc
parentb91a864a051cf15e8839a22e5c4368c509f8914a (diff)
Add support for optional alias dependencies
In addition to RequiresComponent and RequiresAlias, introduce new OptionalComponent and OptionalAlias properties for component aliases. The new properties are used to declare optional requirements for aliases, which do not cause the declaring alias to become unstable in case the referred component or alias is missing from the installer. Task-number: QTIFW-3166 Change-Id: I43c8cd08099e879180ec7e028b55836750c727bd Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'doc/installerfw.qdoc')
-rw-r--r--doc/installerfw.qdoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 8daeff0ed..71a824bbc 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -682,6 +682,18 @@
\li Comma-separated list of aliases that this component alias requires. The
required aliases are selected for installation when this component alias
is selected.
+ \row
+ \li OptionalComponent
+ \li Comma-separated list of identifiers of components that this component alias
+ optionally depends on. The components are selected for installation when the
+ component alias is selected, if the components exists and are user selectable.
+ Even if the components cannot be found in the installer, this alias is not marked unstable.
+ \row
+ \li OptionalAlias
+ \li Comma-separated list of aliases that this component alias optionally depends on. The
+ listed aliases are selected for installation when this component alias is selected,
+ if the aliases exist. Even if the aliases don't exists in the installer,
+ this alias is not marked unstable.
\endtable
*/