summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2017-10-13 15:55:52 +0200
committerSebastien Douheret <sebastien.douheret@iot.bzh>2017-10-13 15:55:52 +0200
commite661ef5b90f40ef61a1f8c0030abcf597c2dcbc6 (patch)
tree58756d860c3c3a37780d58c31d4dc3fd79e86df5 /docs
parent3401dabb3709c6507bada077eec5d4626e902cc2 (diff)
Doc xds-exec config priority order
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/part-2/3_xds-exec.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/part-2/3_xds-exec.md b/docs/part-2/3_xds-exec.md
index 203eb31..504cf01 100644
--- a/docs/part-2/3_xds-exec.md
+++ b/docs/part-2/3_xds-exec.md
@@ -18,10 +18,11 @@ Configuration through environment variables may also be defined in a file that
will be sourced on `xds-exec` start-up. Use `--config|-c` option or set
`XDS_CONFIG` environment variable to specify the config filename.
-Order between options, config file settings and environment variables is :
+So configuration is driven either by environment variables or by command line
+options or using a config file knowning that the following priority order is used:
-1. use option value (for example `-id`)
-1. else use variable `XDS_xxx` (for example `XDS_PROJECT_ID`) when a config file is specified with `--config|-c` option.
+1. use option value (for example use project ID set by `--id` option),
+1. else use variable `XDS_xxx` (for example `XDS_PROJECT_ID` variable) when a config file is specified with `--config|-c` option,
1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable
<!-- note -->