docs/ATTIC/3_Developer_Guides/4_X(cross)_Development_System:_User's_Guide/4_X(cross)_Development_System:_ Internals /3.4.4.5_xds-gdb/3.4.4.5.2_Config.md

   1 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/xds-docs-guides-devguides-book.yml -->
   2
   3 # Configuration
   4
   5 `xds-gdb` configuration is defined by variables (see listed below).
   6
   7 These variables may be set using:
   8
   9 - environment variables (inherited),
  10 - or a config file set with `XDS_CONFIG` environment variable, for example:
  11   `XDS_CONFIG=/tmp/my_xds_gdb_config.env xds-gdb`
  12 - or by setting variables within a gdb ini file (see details below),
  13 - or a "user" config file located in following directory (first found is taken):
  14   1. $(CURRENT_DIRECTORY)/.xds-gdb.env
  15   1. $(CURRENT_DIRECTORY)/../xds-gdb.env
  16   1. $(CURRENT_DIRECTORY)/target/xds-gdb.env
  17   1. $(HOME)/.config/xds/xds-gdb.env
  18
  19 ## Configuration Variables
  20
  21 `XDS_CONFIG`
  22
  23 Config file defining `XDS_xxx` configuration variables.
  24
  25 Variables of this file will overwrite inherited environment variables.
  26
  27 Variables definition may be prefixed or not by "export" keyword.
  28
  29 Here is an example of config file:
  30
  31 ```bash
  32 cat $HOME/myProject/xds-gdb.env
  33
  34 export XDS_AGENT_URL=http://localhost:8800
  35 export XDS_PROJECT_ID=4021617e-ced0-11e7-acd2-3c970e49ad9b
  36 export XDS_SDK_ID=c226821b-b5c0-386d-94fe-19f807946d03
  37 ```
  38
  39 `XDS_LOGLEVEL`
  40
  41 Set logging level
  42
  43 Supported levels:
  44
  45 - panic
  46 - fatal
  47 - error
  48 - warn
  49 - info
  50 - debug
  51
  52 `XDS_LOGFILE`
  53
  54 Set logging file, default `/tmp/xds-gdb.log`.
  55
  56 `XDS_NATIVE_GDB`
  57
  58 Use native gdb mode instead of XDS mode.
  59
  60 `XDS_PROJECT_ID`  *(mandatory in XDS mode)*
  61
  62 Project ID you want to build
  63
  64 `XDS_RPATH`
  65
  66 Relative path into project
  67
  68 `XDS_SDK_ID`   *(mandatory in XDS mode)*
  69
  70 Cross Sdk ID to use to build project
  71
  72 `XDS_AGENT_URL`
  73
  74 Local XDS agent url (default `http://localhost:8800`)
  75
  76 ## Configuration variables set within gdb init command file
  77
  78 Above `XDS_xxx` variables may also be defined within gdb init command file
  79 (see --command or -x option of genuine Gdb).
  80
  81 You must respect the following syntax: commented line including `:XDS-ENV:` tag
  82
  83 Example of gdb init file where we define project and sdk ID:
  84
  85 ```bash
  86      # :XDS-ENV: XDS_PROJECT_ID=4021617e-ced0-11e7-acd2-3c970e49ad9b
  87      # :XDS-ENV: XDS_SDK_ID=c226821b-b5c0-386d-94fe-19f807946d03
  88 ```