Simplified doc-site generation
[AGL/documentation.git] / docs / ATTIC / 3_Developer_Guides / 4_X(cross)_Development_System:_User's_Guide / 4_X(cross)_Development_System:_ Internals / 3.4.4.5_xds-gdb / 3.4.4.5.3_Debug.md
1 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/xds-docs-guides-devguides-book.yml -->
2
3 # Debugging
4
5 ## XDS gdb architecture
6
7 This tool is written in *Go*.
8
9 ```bash
10 |
11 +-- bin/                # where xds-gdb binary will be built
12 |
13 +-- gdb-XXX.go          # xds-gdb Go sources
14 |
15 +-- conf.d/             # Linux configuration and startup files (systemd user service)
16 |
17 +-- glide.yaml          # Go package dependency file
18 |
19 +-- LICENSE             # XDS gdb license
20 |
21 +-- main.go             # main entry point (Go)
22 |
23 +-- Makefile            # makefile including
24 |
25 +-- README.md           # readme
26 |
27 +-- scripts/            # hold various scripts used for installation
28 |
29 +-- vendor/             # temporary directory to hold Go dependencies packages
30 ```
31
32 ## Debug
33
34 Install first [Visual Studio Code](https://code.visualstudio.com/) and
35 [Go plugin](https://marketplace.visualstudio.com/items?itemName=lukehoban.Go)
36 (`ext install lukehoban.Go`)
37
38 Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
39
40 Please follow instructions of xds-agent [debugging chapter](../2_xds-agent/4_debug.html#debug-xds-agent-go-code),
41 knowing that you execute these same instructions in `xds-gdb` repo, in other words
42 by replacing *xds-agent* references by *xds-gdb*.