diff options
author | Robert Griebl <robert.griebl@qt.io> | 2022-05-15 01:19:58 +0200 |
---|---|---|
committer | Robert Griebl <robert.griebl@qt.io> | 2022-05-17 20:14:21 +0200 |
commit | c64ed3321fd7a4fab5b046ce7d1c81cf61aed301 (patch) | |
tree | 7a1b77b34a9c62fd724dea3ba89bcc738532d16f /doc | |
parent | 8ba47c18814ba4178cdafa05953c79701b012516 (diff) | |
download | qtapplicationmanager-c64ed3321fd7a4fab5b046ce7d1c81cf61aed301.tar.gz |
Document all environment variables
Also make sure to check the values against what is actually documented.
Also make sure to forward all relevant variables to apps, even if they
might be running in custom containers.
Change-Id: Ie016383d49ed5fc575fadc32087ed585efc5ce99
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/container.qdoc | 2 | ||||
-rw-r--r-- | doc/debugging.qdoc | 28 |
2 files changed, 25 insertions, 5 deletions
diff --git a/doc/container.qdoc b/doc/container.qdoc index 1135194f..29fa7bad 100644 --- a/doc/container.qdoc +++ b/doc/container.qdoc @@ -143,7 +143,7 @@ the application. A custom container plugin must forward these variables or adjus \li A YAML, UTF-8 string encoded version of the \l{amConfigDetails}{amConfig} map. \row \li \c{AM_NO_DLT_LOGGING} - \li Tells the application to not use DLT for logging. + \li Tells the application to not use DLT for logging, if set to \c 1. \endtable \section1 Configuration diff --git a/doc/debugging.qdoc b/doc/debugging.qdoc index 56eac81b..8f8860ed 100644 --- a/doc/debugging.qdoc +++ b/doc/debugging.qdoc @@ -56,18 +56,24 @@ This is a (incomplete) list of environment variables that influence the logging \li Variable \li Description \row + \li AM_NO_CUSTOM_LOGGING + \li If set to \c 1, debug output is not redirected to DLT, colorized or nicely formatted. +\row + \li AM_NO_DLT_LOGGING + \li If set to \c 1, debug output is not redirected to DLT. +\row \li AM_STARTUP_TIMER - \li If set to 1, a startup performance analysis is printed on the console. Anything other than - 1 is interpreted as the name of a file to use, instead of the console. For more + \li If set to \c 1, a startup performance analysis is printed to the console. Anything other + than \c 1 is interpreted as the name of a file to use, instead of the console. For more information, see StartupTimer. \row \li AM_FORCE_COLOR_OUTPUT \li Can be set to \c on to force color output to the console or to \c off to disable it. Any - other value results in the default, auto-detection behavior. + other value enables the default, auto-detection behavior. \row \li AM_TIMEOUT_FACTOR \li An integer factor that slows down all timed wait statements within the application manager. - Useful if running in slow wrappers, such as Valgrind. The default value is \c 1. + Useful if running in slow wrappers, such as Valgrind. The default value is \c 1. \row \li QT_MESSAGE_PATTERN \li Setting this variable has the same effect as described in @@ -104,6 +110,20 @@ with the \c --qml-debug argument. For more information, see \l{QML Debugging Inf tasks only. They are also useful for various other tasks that involve running the application under test through a wrapper, like profiling tools. +\section2 Environment Variables + +This is a (incomplete) list of environment variables that influence debugging at runtime: + +\table +\header + \li Variable + \li Description +\row + \li AM_NO_CRASH_HANDLER + \li If set to \c 1, no crash handler is installed. Use this, if the application manager's + crash handler is interfering with other debugging tools you are using. +\endtable + \target DebugWrappers \section2 Use Debug Wrappers |