summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Griebl <robert.griebl@qt.io>2021-08-19 17:45:33 +0200
committerRobert Griebl <robert.griebl@qt.io>2021-08-20 13:18:15 +0200
commitaea2eb052dbe75ff5f20c2599d7e01add253ccd7 (patch)
tree1baee6f00af4f8146dfba7d45bb74e5b700e2343 /doc
parentcd5ee5e112575ce5372d784139535c6c88e27004 (diff)
downloadqtapplicationmanager-aea2eb052dbe75ff5f20c2599d7e01add253ccd7.tar.gz
Remove the obsolete template-opt files and update the docs accordingly
Change-Id: I60a3b8e6d2caae8d094c46dc6f4471f001c90aee Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/configuration.qdoc2
-rw-r--r--doc/installation.qdoc28
2 files changed, 9 insertions, 21 deletions
diff --git a/doc/configuration.qdoc b/doc/configuration.qdoc
index dd1936af..96e76a8e 100644
--- a/doc/configuration.qdoc
+++ b/doc/configuration.qdoc
@@ -120,8 +120,6 @@ or across multiple config files, the final value is resolved based on these rule
The application manager saves the result of parsing and evaluating all the
configuration files into a cache. This cache is loaded on subsequent starts, if the
exact set of config files is used, unchanged.
-
- (default: \c /opt/am/config.yaml)
\row
\li \b --no-cache
\li bool
diff --git a/doc/installation.qdoc b/doc/installation.qdoc
index 99d2cc12..871facd4 100644
--- a/doc/installation.qdoc
+++ b/doc/installation.qdoc
@@ -239,29 +239,19 @@ The command line output provides you the URL to the generated report.
The runtime configuration of the application manager is done through command line switches and
one or more configuration files.
-Normally, the basic configuration is done via two separate config files:
-one for target system specific setup and one for System UI specific settings. The
-default location for the system specific part is \c{/opt/am}. A standard
-setup is shipped with the application manager in the \c{template-opt} directory.
+Ideally, in a production setup, the basic configuration is done via two separate config files:
+one for target system specific setup and one for System UI specific settings. The target system
+specific one would for example have the path to installation directories and the required
+logging settings; the System UI specific one would for example have the QML import path and
+the paths to built-in apps.
-You can stick with the default, via the following command:
-
-\badcode
-sudo cp -r template-opt/am /opt
-sudo chown $(whoami) /opt/am -R
-\endcode
-
-Alternatively, you can copy the contents of \c{template-opt} somewhere else; be sure to
-edit the \c{config.yaml} file to reflect the changed paths.
-
-Once this is done, add a file called \c{am-config.yaml} to your System UI with UI specific
-settings. For example, the QML import path, path to built-in apps, and so on.
-
-With everything in place, you can start the application manager:
+If you have the target settings in \c /etc/target-am-config.yaml and the System UI with its
+\c am-config.yaml and \c main.qml files at \c /path/to/system-ui, you can then the
+application manager like so:
\badcode
cd /path/to/system-ui
-appman -c /opt/am/config.yaml -c am-config.yaml --verbose main.qml
+appman -c /etc/target-am-config.yaml -c am-config.yaml --verbose main.qml
\endcode
\c{--verbose} gives you verbose output, which is quite helpful when first setting up the environment