aboutsummaryrefslogtreecommitdiffstats
path: root/docs/part-1
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-22 12:23:27 -0700
committerSebastien Douheret <sebastien.douheret@iot.bzh>2019-05-24 08:01:52 +0000
commit7182daa990d09ceac1b8bde2c225f44edf8bc9e6 (patch)
tree7ed4d789697c06c82c88fa70133cde4508023fde /docs/part-1
parent9b299ed8b8a900a01a1e4c1b2944165228cfce20 (diff)
XDS Debug cmd-line "master" minor edits.
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Change-Id: I6ca53456dfc10c2ae8907f109df9d3be30a7e876
Diffstat (limited to 'docs/part-1')
-rw-r--r--docs/part-1/debug-cmd-line.md37
1 files changed, 20 insertions, 17 deletions
diff --git a/docs/part-1/debug-cmd-line.md b/docs/part-1/debug-cmd-line.md
index f279c7b..0fac5cf 100644
--- a/docs/part-1/debug-cmd-line.md
+++ b/docs/part-1/debug-cmd-line.md
@@ -11,19 +11,19 @@ application.
Follow this procedure to use XDS remotely to debug your application:
-1. Declare to the `xds-server` the project you want to debug.
+1. Declare the project you want to debug to the `xds-server`.
The project can also have been built using XDS.
See the "[Create your first AGL application](../../../#create-your-first-agl-application)"
- section for more details.
+ topic for more details.
2. Be sure you have the XDS agent and XDS server chain in place.
You can find more information on this chain in the
- "[Overview](../../../#xds-overview)" section.
+ "[Installing XDS](../../../#installing-xds)" topic.
-3. Determine the unique project and sdk ID values.
+3. Determine the unique project and SDK ID values.
Two methods exist for you to locate these ID values:
- - Use the "Project" page of XDS dashboard.
+ - Use the "Project" page of the XDS dashboard.
- Use the `xds-gdb --list` command from the XDS command line.
This command returns the list of all existing project and SDK
@@ -58,7 +58,7 @@ cd helloworld-service
# Declare your project on xds-server
# For now, you can only do this step using the XDS Dashboard.
# See the "Build Using the XDS Dashboard" topic in the "Create Your
-# First Application" section.
+# First Application" topic.
# Define XDS configuration variables by creating a "xds-config.env" file.
cat <<EOF >./xds-config.env
@@ -67,13 +67,13 @@ XDS_PROJECT_ID=IW7B4EE-DBY4Z74_myProject
XDS_SDK_ID=poky-agl_aarch64_4.0.1
EOF
-# Tell the xds-cli and xds-gdb what configuration file to use.
+# Define the configuration file to use.
export XDS_CONFIG=../xds-gen3.conf
# Create a new build directory.
mkdir build && cd build
-# Start remote cross build
+# Start remote cross-build
xds-cli exec -- cmake -DRSYNC_TARGET=root@myTarget ..
xds-cli exec -- make
xds-cli exec -- make remote-target-populate
@@ -90,22 +90,25 @@ project is an AGL project based on the
[cmake-apps-module](https://git.automotivelinux.org/src/cmake-apps-module/).
For information on installing this module, see the
"[Installing the CMAKE Templates](../../cmakeafbtemplates/dev_guide/installing-cmake.html))"
-section.
+topic.
-The CMake templates, used to develop applications with the AGL Application
-Framework, automatically generates Makefile rules
-(e.g. `remote-target-populate`) or scripts (e.g. `build/target/*`).
+The CMake templates that are used to develop applications
+with the AGL Application Framework, automatically generate
+Makefile rules (e.g. `remote-target-populate`) or scripts
+(e.g. `build/target/*`).
For more info about the CMake templates, see the
-"[Using the Cmake Applications Module](../../../#using-the-cmake-applications-module).
+"[Using the Cmake Applications Module](../../../#using-the-cmake-applications-module)"
+topic.
<!-- end-section-note -->
## Native debugging
-Native debugging using GDB directly.
+Native debugging is best for applications or services that are also
+built natively and you want to use any debugger (e.g. GDB) on an actual
+piece of hardware.
To enable native debugging mode, set the `XDS_NATIVE_GDB` variable.
-For information on debugging with GDB, see the
-"[Debugging with GDB](https://www.sourceware.org/gdb/onlinedocs/gdb.html#index-_002d_002dcommand)"
-section.
+For information on debugging with GDB, see
+"[Debugging with GDB](https://www.sourceware.org/gdb/onlinedocs/gdb.html)".