summaryrefslogtreecommitdiffstats
path: root/docs/part-1/5_debug-first-app.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-1/5_debug-first-app.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-1/5_debug-first-app.md')
-rw-r--r--docs/part-1/5_debug-first-app.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/5_debug-first-app.md
index 2a27177..01a183e 100644
--- a/docs/part-1/5_debug-first-app.md
+++ b/docs/part-1/5_debug-first-app.md
@@ -1,13 +1,13 @@
# Debug your first AGL application
Debug is based on gdb and you need to use `xds-gdb` as a wrapper on gdb to
-cross-debug your application. This tool allows you to debug an application built
-with XDS without the need to install gdb or any cross tools.
+cross-debug your application.
+
+This tool allows you to debug an application built with XDS without the need to install gdb or any cross tools.
Two debugging models are supported:
1. native debugging
-
1. XDS remote debugging requiring an XDS agent/server setup and that allows you to cross debug your application.
By default XDS debug model is used and you need to define `XDS_NATIVE_GDB`
@@ -30,11 +30,13 @@ variable to use native gdb debug mode instead.
### 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
+`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:
@@ -78,6 +80,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:
@@ -95,9 +98,10 @@ First the project you want to debug must be declared on an xds-server and this
project may also has been built using using XDS (see [Create your first AGL application](./4_build-first-app.html) for more details).
So to debug it you need to have the XDS agent - server chain in place and
-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.
+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
@@ -107,6 +111,7 @@ 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/):