summaryrefslogtreecommitdiffstats
path: root/docs/part-2/3_xds-cli.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-16 15:57:59 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-16 15:57:59 +0100
commit2a297d08d6b686abe9ab8404a15aa892f4832e25 (patch)
tree1b675068143b7f1567e9b81926e402da82f4be1c /docs/part-2/3_xds-cli.md
parent3e719a63b4bbae57d774c34e6c8cff882a328e14 (diff)
Update XDS documentation
- remove documentation duplication for xds-server. Change-Id: Icd76d3a65a3a2ad39438524b0d43d33c0a61d077 Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh> Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/part-2/3_xds-cli.md')
-rw-r--r--docs/part-2/3_xds-cli.md56
1 files changed, 35 insertions, 21 deletions
diff --git a/docs/part-2/3_xds-cli.md b/docs/part-2/3_xds-cli.md
index a4ccca5..ade25f8 100644
--- a/docs/part-2/3_xds-cli.md
+++ b/docs/part-2/3_xds-cli.md
@@ -6,9 +6,11 @@
`xds-cli` configuration is defined either by environment variables or by
setting command line options.
+
Configuration through environment variables may also be defined in a file that
-will be sourced by `xds-cli` on start-up. Use `--config|-c` option or set
-`XDS_CONFIG` environment variable to specify the config file to use.
+will be sourced by `xds-cli` on start-up.
+
+Use `--config|-c` option or set `XDS_CONFIG` environment variable to specify the config file to use.
So configuration is driven either by environment variables or by command line
options or using a config file knowing that the following priority order is used:
@@ -19,7 +21,9 @@ options or using a config file knowing that the following priority order is used
1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable
<!-- note -->
-**Note:** all parameters after a double dash (--) are considered as the command
+**Note:**
+
+All parameters after a double dash (--) are considered as the command
to execute on xds-server.
<!-- endnote -->
@@ -35,24 +39,24 @@ __`--log|-l` option or `XDS_LOGLEVEL` env variable__
Logging level, supported levels are:
-- panic,
-- fatal,
-- error,
-- warn,
-- info,
+- panic
+- fatal
+- error
+- warn
+- info
- debug
Default level is "error".
-__`--rpath` option or `XDS_PATH` env variable__
+**`--rpath` option or `XDS_PATH` env variable**
Relative path into project
-__`timestamp|-ts` option or `XDS_TIMESTAMP` env variable__
+**`timestamp|-ts` option or `XDS_TIMESTAMP` env variable**
Prefix output with timestamp
-__`url` option or `XDS_AGENT_URL` env variable__
+**`url` option or `XDS_AGENT_URL` env variable**
Local XDS agent url (default: "localhost:8800")
@@ -61,6 +65,7 @@ Local XDS agent url (default: "localhost:8800")
### projects
`projects` (short `prj`) command should be used to managed XDS projects.
+
This command supports following sub-commands:
```bash
@@ -87,6 +92,7 @@ xds-cli prj rm 8e49
### sdks
`sdks` (alias `sdk`) command should be used to managed cross SDKs.
+
This command supports following sub-commands:
```bash
@@ -108,23 +114,25 @@ xds-cli sdks get c64d
### exec
-`exec` command should be used to exec command through XDS system. For example
-you can use this command to build your project in XDS system.
+`exec` command should be used to exec command through XDS system.
+
+For example you can use this command to build your project in XDS system.
+
This command supports following sub-commands:
`exec` command options are:
-__`--id` option or `XDS_PROJECT_ID` env variable (**mandatory option**)__
+**`--id` option or `XDS_PROJECT_ID` env variable (**mandatory option**)**
project ID you want to build
-__`--rpath` (short `-p`) or `XDS_RPATH` env variable__
+**`--rpath` (short `-p`) or `XDS_RPATH` env variable**
relative path into project
-__`--sdkid` (alias `--sdk`) or `XDS_SDK_ID` env variable (**mandatory option**)__
+**`--sdkid` (alias `--sdk`) or `XDS_SDK_ID` env variable (**mandatory option**)**
-Cross Sdk ID to use to build project
+Cross Sdk ID to use to build project.
Here are some usage examples:
@@ -140,7 +148,8 @@ xds-cli exec --id=4021 --sdkid=c226 -- "cd build && make all"
```
In case of `xds-agent` is not running on default url:port (that is `localhost:8800`)
-you can specify the url using `--url` option :
+
+You can specify the url using `--url` option :
```bash
xds-cli --url=http://localhost:8800 exec --id=4021 --sdkid=c226 -- "cd build && make all"
@@ -188,10 +197,15 @@ Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
->**Tricks:** To debug both `xds-cli` and `xds-agent` (REST API part) or common
+>**Tricks:**
+>
+>To debug both `xds-cli` and `xds-agent` (REST API part) or common
code `xds-common`, it may be useful use the same local sources.
-So you should replace `xds-agent` + `xds-common` in `vendor` directory by a symlink.
-So clone first `xds-agent` + `xds-common` sources next to `xds-cli` directory.
+>
+>So you should replace `xds-agent` + `xds-common` in `vendor` directory by a symlink.
+>
+>So clone first `xds-agent` + `xds-common` sources next to `xds-cli` directory.
+
You should have the following tree:
```bash