summaryrefslogtreecommitdiffstats
path: root/docs/part-1/debug-ide.md
blob: be9ab0fd2c189bf277ef28d93e734a0996fea386 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# Using an IDE

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.

## Prerequisites

Before using the IDE, you need to declare the project you want to debug
on the `xds-server`.

<!--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"}

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"}

5. Click on **OK** button.

6. Select the **Project Properties** item in the **File** menu to
   update your debug settings.

7. In the "Project Properties" dialog, be sure that the "Gen3 board"
   appears in the "Configuration" field (i.e. active).

8. In the "Categories" navigation pane, select **Run**.

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:

    - Debug command: `/bin/true`

    - Working Directory: Leave this field blank

    - Gdb Init File: `target/gdb-on-root@renesas-gen3.ini`
      <!--section-note-->
      **NOTE:**

      The script name could depend on the `RSYNC_TARGET`
      variable you set in pre-build command.
      <!--end-section-note-->

      ![Select Model panel](./pictures/nb_project_debug-1.png){:: style="width:90%; max-width:700px; margin:auto; display:flex"}

12. Click **Apply**.

13. Click **OK** to save your settings.

14. Start debugging your application by selecting the **Debug Project** item
    in the **Debug** menu, or by entering the **CTRL+F5** shortcut.