summaryrefslogtreecommitdiffstats
path: root/docs/part-2/4_xds-gdb.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/4_xds-gdb.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/4_xds-gdb.md')
-rw-r--r--docs/part-2/4_xds-gdb.md31
1 files changed, 23 insertions, 8 deletions
diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md
index 6185ce9..96f5498 100644
--- a/docs/part-2/4_xds-gdb.md
+++ b/docs/part-2/4_xds-gdb.md
@@ -22,8 +22,9 @@ used to remotely cross build applications.
## Configuration
- `xds-gdb` configuration is defined by variables (see listed below).
- These variables may be set using :
+`xds-gdb` configuration is defined by variables (see listed below).
+
+These variables may be set using:
- environment variables (inherited),
- or a config file set with `XDS_CONFIG` environment variable, for example:
@@ -37,11 +38,15 @@ used to remotely cross build applications.
### Configuration Variables
- `XDS_CONFIG` :
- Config file defining `XDS_xxx` configuration variables. Variables of this file
- will overwrite inherited environment variables. Variables definition may be
- prefixed or not by "export" keyword.
- Here is an example of config file
+`XDS_CONFIG`
+
+Config file defining `XDS_xxx` configuration variables.
+
+Variables of this file will overwrite inherited environment variables.
+
+Variables definition may be prefixed or not by "export" keyword.
+
+Here is an example of config file:
```bash
cat $HOME/myProject/xds-gdb.env
@@ -53,7 +58,16 @@ export XDS_SDK_ID=c226821b-b5c0-386d-94fe-19f807946d03
`XDS_LOGLEVEL`
-Set logging level (supported levels: panic, fatal, error, warn, info, debug)
+Set logging level
+
+Supported levels:
+
+- panic
+- fatal
+- error
+- warn
+- info
+- debug
`XDS_LOGFILE`
@@ -83,6 +97,7 @@ Local XDS agent url (default `http://localhost:8800`)
Above `XDS_xxx` variables may also be defined within gdb init command file
(see --command or -x option of genuine Gdb).
+
You must respect the following syntax: commented line including `:XDS-ENV:` tag
Example of gdb init file where we define project and sdk ID: