diff options
author | 2019-05-22 11:03:04 -0700 | |
---|---|---|
committer | 2019-05-23 17:20:40 -0700 | |
commit | 61ce0c2da83173054100ea71a94babe694ec9a05 (patch) | |
tree | 4db18c3545f6cf932e5373bdcb8b279ee34846be /docs/part-1/debug-overview.md | |
parent | 706a32e9e67fe786c0f1b6a410b1a37f15f0c32e (diff) |
XDS Debug Overview re-write for "guppy"
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Change-Id: I0d9136a7da269cf05f4c25bec9bf7058485df118
Diffstat (limited to 'docs/part-1/debug-overview.md')
-rwxr-xr-x[-rw-r--r--] | docs/part-1/debug-overview.md | 40 |
1 files changed, 27 insertions, 13 deletions
diff --git a/docs/part-1/debug-overview.md b/docs/part-1/debug-overview.md index e1bdffd..25cb30d 100644..100755 --- a/docs/part-1/debug-overview.md +++ b/docs/part-1/debug-overview.md @@ -1,22 +1,36 @@ -# Debug your first AGL application +# Overview -Debug is based on gdb and you need to use `xds-gdb` as a wrapper on gdb to +Debugging your AGL application is based on the GNU Project Debugger +([GDB](https://www.gnu.org/software/gdb/)). +In order to use GDB, you must use `xds-gdb` as a wrapper on GDB to cross-debug your application. +For information on `xds-gdb`, see the +"[Client Part](./client-part.html)" topic. -This tool allows you to debug an application built with XDS without the need to install gdb or any cross tools. +Using `xds-gdb` allows you to debug an application built with +XDS without the need to install GDB or any cross-tools. -Two debugging models are supported: +XDS supports two debugging models: -1. native debugging -1. XDS remote debugging requiring an XDS agent/server setup and that allows you to cross debug your application. +* Native debugging -By default XDS debug model is used and you need to define `XDS_NATIVE_GDB` -variable to use native gdb debug mode instead. +* XDS remote debugging ---- +The default debugging model is XDS remote. +To use this model, you must have previously set up the XDS +agent and server so that you can cross-debug your application. +See the +"[Server Part](./server-part.html)" and +"[Client Part](./client-part.html)" topics for more +information on getting set up. -Links to subchapters : +If you want to use the native debugging model, you must define the +`XDS_NATIVE_GDB` environment variable. +See the +"[Configuration](./debug-configuration.html)" topic for information +on XDS configuration variables. -- [Configuration](./5-1_debug-first-app-config.html) -- [xds-gdb from command line](./5-2_debug-first-app-cmd.html) -- [xds-gdb within an IDE](./5-3_debug-first-app-ide.html) +The remainder of this topic describes +[configurations](./debug-configuration), using the XDS +[command line](./debug-cmd-line) to debug, and using an +[IDE](./debug-ide) to debug. |