diff options
| author |   Scott Rifenbark <srifenbark@gmail.com> | 2019-05-06 13:53:15 -0700 |
|---|---|---|
| committer | Scott Rifenbark <srifenbark@gmail.com> | 2019-05-06 13:53:15 -0700 |
| commit | 327daf1e12f950b4700f9a8d8c10e143fa126b86 (patch) | |
| tree | 88e7adf1591962b4947c75e6a46860d07a6ff835 /docs/part-1/5-1_debug-first-app-config.md | |
| parent | c4cabee5bacd0412ee29853a7f4d51b39b90089a (diff) | |
XDS Debugging: Rename of files and update devguides-book.yml
The debugging section for XDS needs new file names and also
needs to fix the order in which the files appear as topics.
I have done both.
Change-Id: I57920f3c0860d1b5a7ab9299c538b57140579581
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs/part-1/5-1_debug-first-app-config.md')
| -rw-r--r-- | docs/part-1/5-1_debug-first-app-config.md | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/docs/part-1/5-1_debug-first-app-config.md b/docs/part-1/5-1_debug-first-app-config.md deleted file mode 100644 index 8743bc1..0000000 --- a/docs/part-1/5-1_debug-first-app-config.md +++ /dev/null @@ -1,76 +0,0 @@ -# Configuration - - `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: - `XDS_CONFIG=/tmp/my_xds_gdb_config.env xds-gdb` -- or by setting variables within a gdb ini file (see details below), -- or a "user" config file located in following directory (first found is taken): - 1. $(CURRENT_DIRECTORY)/.xds-gdb.env - 1. $(CURRENT_DIRECTORY)/../xds-gdb.env - 1. $(CURRENT_DIRECTORY)/target/xds-gdb.env - 1. $(HOME)/.config/xds/xds-gdb.env - -## 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 configuration file: - -```bash -# for example: -# MY_PROJECT_DIR=/home/seb/xds-workspace/helloworld-native-application -cat > $MY_PROJECT_DIR/xds-gen3.conf << EOF -export XDS_AGENT_URL=localhost:8800 -export XDS_PROJECT_ID=4021617e-ced0-11e7-acd2-3c970e49ad9b -export XDS_SDK_ID=c226821b-b5c0-386d-94fe-19f807946d03 -EOF -``` - -`XDS_LOGLEVEL` - -Set logging level (supported levels: panic, fatal, error, warn, info, debug) - -`XDS_LOGFILE` - -Set logging file, default `/tmp/xds-gdb.log`. - -`XDS_NATIVE_GDB` - -Use native gdb mode instead of remote XDS mode. - -`XDS_PROJECT_ID` *(mandatory in XDS mode)* - -Project ID you want to build - -`XDS_RPATH` - -Relative path into project - -`XDS_SDK_ID` *(mandatory in XDS mode)* - -Cross Sdk ID to use to build project - -`XDS_AGENT_URL` - -Local XDS agent url (default `http://localhost:8800`) - -## Configuration variables set within gdb init command file - -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: - -```bash - # :XDS-ENV: XDS_PROJECT_ID=4021617e-ced0-11e7-acd2-3c970e49ad9b - # :XDS-ENV: XDS_SDK_ID=c226821b-b5c0-386d-94fe-19f807946d03 -``` |