summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-20 16:20:01 -0700
committerScott Rifenbark <srifenbark@gmail.com>2019-05-20 16:20:01 -0700
commit830b6629d3f0bfe0509b086335352b3af7848fde (patch)
tree6642ae9d0026cf6bbe9db12c8c12d67c603b0cf4
parent3771a57534872fc1f7da8b2a1044f75167886cac (diff)
XDS Debug: Re-wrote the section on using the IDE
Re-write of the section that talks about debugging with xds-dbg from within an IDE. Change-Id: Ife3b1432338ce2efcc482ae03660a9d686463fd1 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
-rw-r--r--docs/part-1/debug-ide.md87
1 files changed, 64 insertions, 23 deletions
diff --git a/docs/part-1/debug-ide.md b/docs/part-1/debug-ide.md
index bd4d15f..ffecd74 100644
--- a/docs/part-1/debug-ide.md
+++ b/docs/part-1/debug-ide.md
@@ -1,44 +1,85 @@
-# Debug using xds-gdb within an IDE
+# Using an IDE
-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](../../../#create-your-first-agl-application) for more details).
+This topic describes how to use `xds-gdb` from within an Interactive
+Development Environment (IDE) to debug your application.
+The topic uses the
+[NetBeans](https://netbeans.org/) IDE as an example.
-## Netbeans
+## Prerequisites
-__Netbeans 8.x :__
+Before using the IDE, you need to declare the project you want to debug
+on the `xds-server`.
-- Open menu **Tools** -> **Options**
- - Open **C/C++** tab, in **Build Tools** sub-tab, click on **Add** button:
+<!--section-note-->
+**NOTE:**
+
+The project you declare can also have been built using XDS.
+For information on building the project using XDS, see the
+"[Create your first AGL application](../../../#create-your-first-agl-application)"
+section.
+<!--end-section-note-->
+
+## NetBeans
+
+This section presents an example using NetBeans version 8.x:
+
+1. Select the **Options** item in the **Tools** menu.
+
+2. Open the **Build Tools** tab.
+
+3. Open the **C/C++** tab and click the **Add** button to reveal the "Add New
+ Tool Collection dialog box:
![Add new tool panel](./pictures/nb_newtool.png){:: style="width:90%; max-width:700px; margin:auto; display:flex"}
- - Then, you should set **Make Command** and **Debugger Command** to point to xds tools:
+4. Fill in the **Make Command** and **Debugger Command** fields so that they point to the XDS tools.
+ Following is an example:
![Add new tool panel](./pictures/nb_xds_options.png){:: style="width:90%; max-width:700px; margin:auto; display:flex"}
- - Finally click on **OK** button.
+5. Click on **OK** button.
+
+6. Select the **Project Properties** item in the **File** menu to
+ update your debug settings.
-- Edit project properties (using menu **File** -> **Project Properties**) to update Debug settings:
+7. In the "Project Properties" dialog, be sure that the "Gen3 board"
+ appears in the "Configuration" field (i.e. active).
- - Be sure that "Gen3 board" configuration is selected
+8. In the "Categories" navigation pane, select **Run**.
- - Select **Run** category, and set:
- - Run Command: `target/start-on-root@renesas-gen3.sh`
- (_script name may depend of RSYNC_TARGET variable you set in pre-build command_)
- - Run Directory: `build_gen3`
+9. Set the following:
+
+ - Run Command: `target/start-on-root@renesas-gen3.sh`
+ <!--section-note-->
+ **NOTE:**
+
+ The script name could depend on the `RSYNC_TARGET`
+ variable you set in pre-build command.
+ <!--end-section-note-->
+
+ - Run Directory: `build_gen3`
+
+10. In the "Categories" navigation pane, select **Debug**.
+
+11. Set the following:
- - Select **Debug** category, and set:
- Debug command: `/bin/true`
- - Working Directory: _empty field_
+
+ - Working Directory: Leave this field blank
+
- Gdb Init File: `target/gdb-on-root@renesas-gen3.ini`
- (_script name may depend of RSYNC_TARGET variable you set in pre-build command_)
+ <!--section-note-->
+ **NOTE:**
- ![Select Model panel](./pictures/nb_project_debug-1.png){:: style="width:90%; max-width:700px; margin:auto; display:flex"}
+ The script name could depend on the `RSYNC_TARGET`
+ variable you set in pre-build command.
+ <!--end-section-note-->
- - Click on **Apply** and then **OK** button to save settings
+ ![Select Model panel](./pictures/nb_project_debug-1.png){:: style="width:90%; max-width:700px; margin:auto; display:flex"}
-You can now start debugging your application with menu **Debug** -> **Debug Project** (or **CTRL+F5** shortcut)
+12. Click **Apply**.
-## Others IDE
+13. Click **OK** to save your settings.
-*Coming soon...*
+14. Start debugging your application by selecting the **Debug Project** item
+ in the **Debug** menu, or by entering the **CTRL+F5** shortcut.