summaryrefslogtreecommitdiffstats
path: root/docs/part-2/4_xds-gdb.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2017-09-20 14:17:57 +0200
committerSebastien Douheret <sebastien.douheret@iot.bzh>2017-09-20 14:17:57 +0200
commitb919b385f5b7d3e2f41855d742c1e818ae95bd02 (patch)
tree1f7a8e28d764c98f366bb13f3ed2630b2c579067 /docs/part-2/4_xds-gdb.md
parent539cc38be44221ba526ee3a1e07ea44ec98c72da (diff)
Update xds internals doc
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.md128
1 files changed, 22 insertions, 106 deletions
diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md
index 5fe0ab9..9905eee 100644
--- a/docs/part-2/4_xds-gdb.md
+++ b/docs/part-2/4_xds-gdb.md
@@ -12,33 +12,19 @@ Two debugging models are supported:
1. XDS remote debugging requiring an XDS server and allowing cross debug your
application.
-
By default XDS remote debug is used and you need to define `XDS_NATIVE_GDB`
variable to use native gdb debug mode instead.
> **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server
-used to remotely cross build applications.
+used to remotely cross build applications.
> **SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec),
wrappers on `exec` command that allows to cross build your application through `xds-server`.
-## Getting Started
-
-## Installing xds-gdb
-
-Download latest `xds-gdb` release on [https://github.com/iotbzh/xds-gdb/releases](https://github.com/iotbzh/xds-gdb/releases).
-
-Extract the tarball anywhere you want, for example:
-
-```bash
-mkdir -p ~/opt/bin
-unzip -j $DOWNLOAD_DIR/xds-gdb_linux-amd64-v1.0.0.zip xds-gdb/xds-gdb ~/opt/bin
-```
-
## Configuration
- `xds-gdb` configuration is defined by variables (see listed below).
+ `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`
@@ -51,11 +37,11 @@ unzip -j $DOWNLOAD_DIR/xds-gdb_linux-amd64-v1.0.0.zip xds-gdb/xds-gdb ~/opt/bin
### Configuration Variables
- `XDS_CONFIG` :
+ `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
+ prefixed or not by "export" keyword.
+ Here is an example of config file
```bash
cat $HOME/myProject/xds-gdb.env
@@ -65,25 +51,32 @@ export XDS_PROJECT_ID=IW7B4EE-DBY4Z74_myProject
export XDS_SDK_ID=poky-agl_aarch64_4.0.1
```
-`XDS_LOGLEVEL` :
+`XDS_LOGLEVEL`
+
Set logging level (supported levels: panic, fatal, error, warn, info, debug)
-`XDS_LOGFILE` :
+`XDS_LOGFILE`
+
Set logging file, default `/tmp/xds-gdb.log`.
-`XDS_NATIVE_GDB` :
+`XDS_NATIVE_GDB`
+
Use native gdb mode instead of remote XDS server mode.
-`XDS_PROJECT_ID` : *(mandatory with XDS server mode)*
-Project ID you want to build
-
-`XDS_RPATH` :
+`XDS_PROJECT_ID` *(mandatory with XDS server mode)*
+
+Project ID you want to build
+
+`XDS_RPATH`
+
Relative path into project
-`XDS_SDK_ID` : *(mandatory with XDS server mode)*
+`XDS_SDK_ID` *(mandatory with XDS server mode)*
+
Cross Sdk ID to use to build project
-`XDS_SERVER_URL` : *(mandatory with XDS server mode)*
+`XDS_SERVER_URL` *(mandatory with XDS server mode)*
+
Remote XDS server url
### Configuration variables set within gdb init command file
@@ -99,83 +92,6 @@ Example of gdb init file where we define project and sdk ID:
# :XDS-ENV: XDS_SDK_ID=poky-agl_aarch64_4.0.1
```
-## Using xds-gdb from command line
-
-### XDS remote debugging mode
-
-First the project you want to debug must be declared on an xds-server and this
-project may also has been built using this xds-server (see [xds-server](https://github.com/iotbzh/xds-server) for more details).
-
-So to debug it you need to know the xds-server url (eg. <http://xds-docker:8000>),
-you also need the project and sdk unique id. You can find these IDs in project
-page of XDS dashboard or you can get them from command line using the `--list`
-option.
-This option lists all existing projects ID:
-
-```bash
-XDS_SERVER_URL=http://xds-docker:8000 xds-gdb --list
-```
-
-Now to refer your project, just set `XDS_PROJECT_ID` and `XDS_SDK_ID` variables.
-
-You are now ready to use `xds-gdb` to for example cross debug your project.
-Here is an example to build and debug a project based on CMakefile and
-[AGL app-templates](https://git.automotivelinux.org/apps/app-templates/):
-
-```bash
-# Go into your project directory (for example helloworld-service)
-git clone https://github.com/iotbzh/helloworld-service.git
-cd helloworld-service
-
-# Declare your project on xds-server
-# <for now, you can only do this step using xds HTML dashboard (see xds-server doc)>
-
-# Define XDS config
-cat <<EOF >./xds-config.env
-XDS_SERVER_URL=http://xds-docker:8000
-XDS_PROJECT_ID=IW7B4EE-DBY4Z74_myProject
-XDS_SDK_ID=poky-agl_aarch64_4.0.1
-EOF
-
-# Tell to xds-exec and xds-gdb which is your config file
-export XDS_CONFIG=../xds-config.env
-
-# Create a new build directory
-mkdir build && cd build
-
-# Start remote cross build
-xds-exec -- cmake ..
-xds-exec -- make
-xds-exec -- make remote-target-populate
-
-# Start debugging
-xds-gdb -x target/gdb-on-root@myTarget.ini
-```
-
-> **Notes** : [Helloworld-service project](https://github.com/iotbzh/helloworld-service)
-is an AGL project based on app-templates that can be build and debug using XDS.
-
-### Native debugging
-
-To enable native debugging mode, you need to define `XDS_NATIVE_GDB` variable.
-
-## Using xds-gdb within an IDE
-
-### Netbeans
-
-__Netbeans 8.x :__
-Open menu Tools -> Options
-Then open C/C++ tab, in "Build Tools" sub-tab, click on "Add" button:
-![Add new tool panel](./docs/images/nb_newtool.jpg)
-
-Then, you should set *Debugger Command* to point to xds-gdb
-
-![Add new tool panel](./docs/images/nb_xds_options.jpg)
-
-### Others IDE
-
-*Coming soon...*
-
## How to build xds-gdb from scratch
### Prerequisites