aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-07 13:32:13 -0700
committerScott Rifenbark <srifenbark@gmail.com>2019-05-07 13:32:13 -0700
commitc21de7b90e01b4f3290870524802c9ec911ff8b6 (patch)
tree5e1593951ac45b2220ef5d51cc0db0f372ee08bd /docs
parentcf2006e612958777bddbe4eb4a0a23693decda6a (diff)
XDS debug overview topic re-written.
I re-wrote the XDS debug overview topic. The content is in the "debug-overview.md" file. Change-Id: I6d9af07a53226417c17a67dfc36c5b7c1fce4c82 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/part-1/debug-overview.md36
1 files changed, 23 insertions, 13 deletions
diff --git a/docs/part-1/debug-overview.md b/docs/part-1/debug-overview.md
index 22dc82d..40f2b62 100644
--- a/docs/part-1/debug-overview.md
+++ b/docs/part-1/debug-overview.md
@@ -1,22 +1,32 @@
-# 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
+"[Overview](./xds-overview.html)" section along with "Installing XDS"
+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.
-- [Configuration](./debug-configuration.html)
-- [xds-gdb from command line](./debug-cmd-line.html)
-- [xds-gdb within an IDE](./debug-ide.html)
+The remainder of this section describes
+[configurations](./debug-configuration), using the XDS
+[command line](./debug-cmd-line) to debug, and using an
+[IDE](./debug-ide) to debug.