From 0142d85d6cbd9aef8f90686548c7584c44d08416 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Sat, 8 Jun 2019 19:26:18 -0700 Subject: Getting Started -> debug app: General edits. I updated content so the links target topic name actually matches the target topic title. Also, used the box formatting for a couple notes. Signed-off-by: Scott Rifenbark --- docs/getting-started/app-workflow-debug-app.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/getting-started/app-workflow-debug-app.md b/docs/getting-started/app-workflow-debug-app.md index 9273bee..78b0bb5 100644 --- a/docs/getting-started/app-workflow-debug-app.md +++ b/docs/getting-started/app-workflow-debug-app.md @@ -11,33 +11,41 @@ Or, is it better for you to use a remote user interface that is part of an Integrated Development Environment (IDE) such as Eclipse? For general information on debugging an application, see the -"[Debug Your First AGL Application](../../../devguides/reference/xds/part-1/debug-overview.html)" -section. +"[Overview](../../../devguides/reference/xds/part-1/debug-overview.html)" +topic under "Debugging Your First AGL Application". -Here are three methods: +Three methods exist: * Use `gdb` on the target. - **NOTE:** How to use `gdb` and other debugging tools such as `valgrind`, `strace`, + + **NOTE:** + + How to use `gdb` and other debugging tools such as `valgrind`, `strace`, and so forth is beyond the scope of the AGL Documentation. See the appropriate documentation for third-party debugging tools. + * Use Core Dumps if you have set the `agl-devel` feature. Core Dumps are obviously more suited for post-mortem analysis. For features, see the "[Initializing Your Build Environment](./image-workflow-initialize-build-environment.html#initializing-your-build-environment)" - section. + topic. + + + **NOTE:** - **NOTE:** Core Dumps are available only with the "Flunky Flounder" release (i.e. 6.x). + Core Dumps are available only with the "Flunky Flounder" release (i.e. 6.x). + * Use XDS remotely, which is based on `gdb` and [`gdbserver`](https://en.wikipedia.org/wiki/Gdbserver). See the - "[XDS remote debugging mode](../../../devguides/reference/xds/part-1/debug-cmd-line.html#xds-remote-debugging-mode)" - section for more information. + "[Using the Command Line](../../../devguides/reference/xds/part-1/debug-cmd-line.html#xds-remote-debugging-mode)" + topic for more information. For information on how to remotely debug the application using XDS from within an IDE, see the - "[Debug using `xds-gdb` within an IDE](../../../devguides/reference/xds/part-1/debug-ide.html)" + "[Using an IDE](../../../devguides/reference/xds/part-1/debug-ide.html)" section. In order to use third-party debugging tools, you need to include the tools in the target image. -- cgit 1.2.3-korg