Skip to content

Commit 6a804f1

Browse files
iriark01LDong-Arm
authored andcommitted
Tidying up debugging since material moved
This is an attempt - I may make further changes
1 parent 6ba3a6c commit 6a804f1

File tree

6 files changed

+33
-40
lines changed

6 files changed

+33
-40
lines changed

docs.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1101,9 +1101,6 @@
11011101
"type": "markdown",
11021102
"chapters": [{
11031103
"title": "Debugging",
1104-
"intro": {
1105-
"path": "docs/tools/debug/debug_intro.md"
1106-
},
11071104
"sub_chapters": [{
11081105
"title": "Methods",
11091106
"sources": [{
@@ -1137,6 +1134,9 @@
11371134
},
11381135
{
11391136
"title": "Third party tools",
1137+
"intro": {
1138+
"path": "docs/tools/debug/debug_intro.md"
1139+
},
11401140
"sources": [{
11411141
"path": "docs/tools/debug/eclipse_pyocd.md"
11421142
},

docs/program-setup/serial/serial_communication.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This program prints a "Hello World!" message that you can view on a serial termi
1616

1717
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/tree/v6.0)](https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/blob/v6.0/main.cpp)
1818

19-
### Viewing output in a serial terminal
19+
## Viewing output in a serial terminal
2020

2121
Serial terminals run on your host PC. They provide an interface where your Mbed board can print and where you can type characters back to your board.
2222

23-
Mbed CLI provides a serial terminal that is configured with a default baud rate of `9600`. When a single board is connected, run:
23+
Mbed CLI provides a serial terminal that is configured with a default baud rate of `9600`. When a single board is connected, run:
2424

2525
```
2626
mbed sterm
@@ -45,26 +45,26 @@ To close the serial terminal, enter <kbd>Ctrl + C</kbd>.
4545

4646
- To list all options, run `mbed sterm -h`:
4747

48-
```
49-
usage: mbed sterm [-h] [-m TARGET] [-p PORT] [-b BAUDRATE] [-e ECHO] [-r] [-v] [-vv]
50-
51-
Open serial terminal to connected target (usually board), or connect to a user-specified COM port
52-
53-
optional arguments:
54-
-h, --help show this help message and exit
55-
-m TARGET, --target TARGET
56-
Compile target MCU. Example: K64F, NUCLEO_F401RE,
57-
NRF51822...
58-
-p PORT, --port PORT Communication port. Default: auto-detect. Specifying
59-
this will also ignore the -m/--target option above.
60-
-b BAUDRATE, --baudrate BAUDRATE
61-
Communication baudrate. Default: 9600
62-
-e ECHO, --echo ECHO Switch local echo on/off. Default: on
63-
-r, --reset Reset the targets (via SendBreak) before opening
64-
terminal.
65-
-v, --verbose Verbose diagnostic output
66-
-vv, --very_verbose Very verbose diagnostic output
67-
```
48+
```
49+
usage: mbed sterm [-h] [-m TARGET] [-p PORT] [-b BAUDRATE] [-e ECHO] [-r] [-v] [-vv]
50+
51+
Open serial terminal to connected target (usually board), or connect to a user-specified COM port
52+
53+
optional arguments:
54+
-h, --help show this help message and exit
55+
-m TARGET, --target TARGET
56+
Compile target MCU. Example: K64F, NUCLEO_F401RE,
57+
NRF51822...
58+
-p PORT, --port PORT Communication port. Default: auto-detect. Specifying
59+
this will also ignore the -m/--target option above.
60+
-b BAUDRATE, --baudrate BAUDRATE
61+
Communication baudrate. Default: 9600
62+
-e ECHO, --echo ECHO Switch local echo on/off. Default: on
63+
-r, --reset Reset the targets (via SendBreak) before opening
64+
terminal.
65+
-v, --verbose Verbose diagnostic output
66+
-vv, --very_verbose Very verbose diagnostic output
67+
```
6868
6969
## Auto-opening a serial terminal after compilation
7070
@@ -82,24 +82,24 @@ Use your terminal application to interact with the following examples.
8282
8383
If you're not sure how to build these examples and run them on your board, please see our [build tools section](../build-tools/index.html).
8484
85-
## Echo back characters you type
85+
### Echo back characters you type
8686
8787
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/tree/v6.0)](https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/blob/v6.0/main.cpp)
8888
89-
## Use the U and D keys to make LED1 brighter or dimmer
89+
### Use the U and D keys to make LED1 brighter or dimmer
9090
9191
<span class="tips">**Note:** This example only works if LED1 is on the Pwm pin of the board you are using, such as the NUCLEO-F401RE. </span>
9292
9393
<span class="images">![](../../images/NUCLEOF401RE.png)<span>The pin map of the NUCLEO-F401RE shows LED1 on the Pwm pin.</span></span>
9494
9595
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/tree/v6.0)](https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/blob/v6.0/main.cpp)
9696
97-
## Pass characters in both directions
97+
### Pass characters in both directions
9898
9999
Tie pins together to see characters echoed back.
100100
101101
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/tree/v6.0)](https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/blob/v6.0/main.cpp)
102102
103-
## Read to a buffer
103+
### Read to a buffer
104104
105105
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/tree/v6.0)](https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/blob/v6.0/main.cpp)

docs/quick-start/quick-start-compiler.md

-7
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,3 @@ Alternatively, you may select the import button on the top left hand side of the
6060
1. Open the folder where the executable file was downloaded, and then click and drag (or copy and paste) the file to your Mbed board's USB device folder.
6161
6262
1. Press the board's reset button.
63-
64-
## Related links
65-
66-
- [Collaborating with multiple authors](../build-tools/collaborative-work.html).
67-
- [Mbed OS statistics API](../apis/mbed-statistics.html).
68-
- [Mbed OS configuration](../program-setup/advanced-configuration.html).
69-
- [Mbed OS serial communication](../program-setup/serial-communication.html).

docs/tools/debug/debug_intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Debugging
1+
<h1 id="debugging">Debugging with third party tools</h1>
22

33
There are extensive instructions on debugging Arm Mbed OS applications with [uVision 5](../debug-test/keil-uvision.html), [Eclipse](../debug-test/third-party-tools.html) and [Visual Studio Code](../debug-test/visual-studio-code.html), but you can use any IDE that supports GDB to debug Mbed OS applications. This document gives advice on how to configure these IDEs. Before starting, first [configure your local debug toolchain](setting-up-a-local-debug-toolchain.html).
44

docs/tools/debug/debugging_mbed_os_apps.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Debugging Arm Mbed OS applications
1+
# Debugging methods for Arm Mbed OS applications
22

33
At the heart of Arm Mbed is the [Online Compiler](../build-tools/mbed-online-compiler.html). While that is incredibly convenient for getting a project started or while prototyping, chances are that at some point you'll miss a debugger, or you'll want to develop while not having an active internet connection. Through debugging, you can do things such as set breakpoints, set watchpoints, view registers, view disassembly, browse memory and examine the callstack. These docs will help you debug your applications.
44

@@ -8,7 +8,7 @@ The simplest way to debug your code is to augment your code with log statements,
88

99
Keil uVision natively supports debugging Mbed OS applications. To set up uVision, read [Debugging with Keil uVision](../debug-test/keil-uvision.html).
1010

11-
Mbed also supports debugging using any IDE that supports GDB. To set up the debugger, first read [Setting up your local debug toolchain](setting-up-a-local-debug-toolchain.html). Then read the section for your specific IDE. The same principles apply to any unlisted IDEs that supports GDB:
11+
Mbed also supports debugging using any IDE that supports GDB. To set up the debugger, first read [Setting up your local debug toolchain](../debug-test/setting-up-a-local-debug-toolchain.html). Then read the section for your specific IDE. The same principles apply to any unlisted IDEs that supports GDB:
1212

1313
1. Producing [debug builds with Arm Mbed CLI](../program-setup/debug-builds-cli.html).
1414
1. Debugging with [Eclipse](../debug-test/third-party-tools.html).

redirects.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"reference/bare-metal-apis.html": "apis/index.html",
5151
"reference/configuration-mesh.html": "apis/configuration-mesh.html",
5252
"tools/greentea-testing-applications.html": "debug-test/greentea-for-testing-applications.html",
53-
"tools/debugging-arm-mbed-os-applications.html": "debug-test/debugging-arm-mbed-os-applications.html",
53+
"tools/debugging-arm-mbed-os-applications.html": "debug-test/debugging-methods-for-arm-mbed-os-applications.html",
5454
"tools/setting-up-a-local-debug-toolchain.html": "debug-test/setting-up-a-local-debug-toolchain.html",
5555
"tools/daplink.html": "debug-test/daplink.html",
5656
"tools/icetea-testing-applications.html": "debug-test/icetea-test-applications.html",

0 commit comments

Comments
 (0)