diff options
| author | Christian Kandeler <christian.kandeler@qt.io> | 2017-11-17 16:19:57 +0100 |
|---|---|---|
| committer | Christian Kandeler <christian.kandeler@qt.io> | 2017-11-22 15:41:43 +0000 |
| commit | 3b55e4b03499730085924edfdf04b140ef62274e (patch) | |
| tree | fee3b33cdc91d2e68531c4b6757e9443df0f7741 /doc/reference | |
| parent | df04c86b873ae6167230e66c5a33b2a460e86da0 (diff) | |
Give the setupRunEnvironment script an additional parameter
Required by follow-up commit.
[ChangeLog] The Module.setupRunEnvironment script now has a new parameter
"config". Users can set it via the --setup-run-env-config option of the
run command.
Change-Id: I1be57fcff5321874cf3dcf4fb3a7ef7d6f69a8a5
Reviewed-by: Jake Petroules <jake.petroules@qt.io>
Diffstat (limited to 'doc/reference')
| -rw-r--r-- | doc/reference/cli/builtin/cli-run.qdoc | 1 | ||||
| -rw-r--r-- | doc/reference/cli/cli-options.qdocinc | 10 | ||||
| -rw-r--r-- | doc/reference/items/language/module.qdoc | 5 |
3 files changed, 15 insertions, 1 deletions
diff --git a/doc/reference/cli/builtin/cli-run.qdoc b/doc/reference/cli/builtin/cli-run.qdoc index 5b9b6456a..aa5441010 100644 --- a/doc/reference/cli/builtin/cli-run.qdoc +++ b/doc/reference/cli/builtin/cli-run.qdoc @@ -73,6 +73,7 @@ \include cli-options.qdocinc no-build \include cli-options.qdocinc products-specified \include cli-options.qdocinc settings-dir + \include cli-options.qdocinc setup-run-env-config \include cli-options.qdocinc wait-lock \section1 Parameters diff --git a/doc/reference/cli/cli-options.qdocinc b/doc/reference/cli/cli-options.qdocinc index 2b8c751cf..73cab922c 100644 --- a/doc/reference/cli/cli-options.qdocinc +++ b/doc/reference/cli/cli-options.qdocinc @@ -396,6 +396,16 @@ //! [settings-dir] +//! [setup-run-env-config] + + \section2 \c --setup-run-env-config + + A comma-separated list of strings. They will show up in the \c config parameter + of all \c setupRunEnvironment scripts. See the \l{Module Item}{Module item} for details. + +//! [setup-run-env-config] + + //! [show-progress] \section2 \c --show-progress diff --git a/doc/reference/items/language/module.qdoc b/doc/reference/items/language/module.qdoc index 58d999be8..1362b8c00 100644 --- a/doc/reference/items/language/module.qdoc +++ b/doc/reference/items/language/module.qdoc @@ -231,7 +231,10 @@ \li \c undefined \li Script for setting up the environment in which a product is run. The code in this script is treated as a function with the signature - \c{function(project, product)}. + \c{function(project, product, config)}. + The \c config parameter is a list of arbitrary strings that can be passed via + the \l{run} command. The concrete values supported by specific modules + are listed in their respective documentation. Use the \l{Environment Service}{Environment} functions to alter the environment. The return value of this script is ignored. \row |