diff options
author | Robert Griebl <robert.griebl@qt.io> | 2022-02-23 01:14:19 +0100 |
---|---|---|
committer | Robert Griebl <robert.griebl@qt.io> | 2022-02-25 12:39:26 +0100 |
commit | 4c96cd910a7e7fdf29e7c7a20b0b3012dbeffc5b (patch) | |
tree | f1043ea49ae62d53c47910e6abc41c557a0d13d4 /doc | |
parent | 1acd11515aaf37b535791ddec0bd9698ad34de59 (diff) | |
download | qtapplicationmanager-4c96cd910a7e7fdf29e7c7a20b0b3012dbeffc5b.tar.gz |
Clarify documentation and warning messages
Change-Id: If168ce2285636b2b062d8cbe5d7bc9390359b3df
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/configuration.qdoc | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/configuration.qdoc b/doc/configuration.qdoc index e413f6be..171997c2 100644 --- a/doc/configuration.qdoc +++ b/doc/configuration.qdoc @@ -82,6 +82,18 @@ or across multiple config files, the final value is resolved based on these rule \c ui/importPaths. In this case, all values, regardless of where they are specified, are merged into one single, final list. +A very minimalistic \c am-config.yaml example would be something like this, which defines the +main qml entry point and two import paths: + +\badcode +formatVersion: 1 +formatType: am-configuration +--- +ui: + mainQml: "${CONFIG_PWD}/main.qml" + importPaths: [ "${CONFIG_PWD}/imports/shared", "${CONFIG_PWD}/imports/sysui" ] +\endcode + \table 100% \header \li Command Line \br [\c {Config Key}] @@ -428,8 +440,8 @@ merged into one single, final list. \br [\c wayland/socketName] \li string \li A filesystem name for the Wayland socket that should be used when creating the - compositor component. (default: auto-detected by \c libwayland-server, most likely - \c wayland-0) + compositor component. (default: auto-detected by the application manager, most likely + \c qtam-wayland-0) \note You can only specify the name here, but not a path: Wayland will always create this socket in \c{$XDG_RUNTIME_DIR}. The compositor will fail to start if this directory is not writable or if the environment variable is not even set in the |