diff options
| author |   Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-02-06 18:20:55 +0100 |
|---|---|---|
| committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-02-06 18:21:00 +0100 |
| commit | e123f729c2d02e8cba8e0c631bf5f736626ffb46 (patch) | |
| tree | ed436154c289d16e00c968ecc84c74edcb9b4be7 | |
| parent | 614a0538ca128f458ccd781db299e2e3e7232fd0 (diff) | |
Added documentation about sdkDbUpdate config field.
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
| -rw-r--r-- | docs/part-2/1_xds-server/1_config.md | 3 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/2_how-to-run.md | 2 |
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/part-2/1_xds-server/1_config.md b/docs/part-2/1_xds-server/1_config.md index fc82807..ad86043 100644 --- a/docs/part-2/1_xds-server/1_config.md +++ b/docs/part-2/1_xds-server/1_config.md @@ -16,6 +16,8 @@ Supported fields in configuration file are: - **shareRootDir** : root directory where projects will be copied - **logsDir** : directory to store logs (eg. syncthing output) - **sdkScriptsDir** : directory where scripts, used to managed SDKs, are installed +- **sdkDbUpdate** : define how SDK database(s) is(are) updated, supported values are: + `disable`, `startup` (default: `startup`) - **syncthing.binDir** : syncthing binaries directory (default: executable directory) - **syncthing.home"** : syncthing home directory (usually .../syncthing-config) - **syncthing.gui-address** : syncthing gui url (default <http://localhost:8385>) @@ -30,6 +32,7 @@ All fields are optional and example below corresponds to the default values. "shareRootDir": "${HOME}/.xds/server/projects", "logsDir": "/tmp/logs", "sdkScriptsDir": "${EXEPATH}/scripts/sdks", + "sdkDbUpdate": "startup", "syncthing": { "binDir": "./bin", "home": "${HOME}/.xds/server/syncthing-config", diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/2_how-to-run.md index 8c6aa55..04c14cf 100644 --- a/docs/part-2/1_xds-server/2_how-to-run.md +++ b/docs/part-2/1_xds-server/2_how-to-run.md @@ -134,6 +134,8 @@ For example, here 2 SDKs family (`agl` and `zephyr`) are defined: On startup `xds-server` will call in order: - `sdks/*/get-family-config` to get configuration of each SDK family. +- `sdks/*/db-update` to update database (only when `SdkDbUpdate` is set to ̀`startup`, + see [Configuration chapter](1_config.html) for more details) - `sdks/*/db-dump` scripts to get the initial list of available and installed SDKs. Please refer to `sdks/README.md` for more information about scripts definition |