Skip to content

Commit 1570d9b

Browse files
author
AnotherButler
committed
Change 5.6 to 5.7
Change tools documents from 5.6 to 5.7.
1 parent 61bfb18 commit 1570d9b

18 files changed

+43
-43
lines changed

docs/tools/DAP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
DAPlink is an open source project that implements the embedded firmware required for a Cortex debug probe. The project is hosted on GitHub and is published under an Apache 2.0 license, making it attractive for commercial developments.
44

5-
The software project is complemented by a series of reference designs for creating the DAPLink debug probe hardware, which is available in the <a href="/docs/v5.6/reference/contributing-tools.html#arm-mbed-hdk" target="_blank">HDK documentation</a>.
5+
The software project is complemented by a series of reference designs for creating the DAPLink debug probe hardware, which is available in the <a href="/docs/v5.7/reference/contributing-tools.html#arm-mbed-hdk" target="_blank">HDK documentation</a>.
66

77
### DAPLink features
88

@@ -29,7 +29,7 @@ DAPLink debug probes appear on the host computer as a USB disk. Program files in
2929
The DAPLink debug probe also provides a USB serial port, which can be bridged through to a TTL UART on the target system.
3030
The USB serial port will appear on a Windows machine as a COM port, or on a Linux machine as a /dev/tty interface.
3131

32-
For more information on configuring your host computer to use this feature, please the <a href="/docs/v5.6/tutorials/windows-serial-driver.html" target="_blank">Windows serial driver information</a>.
32+
For more information on configuring your host computer to use this feature, please the <a href="/docs/v5.7/tutorials/windows-serial-driver.html" target="_blank">Windows serial driver information</a>.
3333

3434
### Further reading
3535

docs/tools/config_system.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Arm Mbed configuration system customizes the compile time configuration of v
99

1010
The configuration system gathers and interprets all the configurations defined in the source tree. The output of the configuration system is a list of macros that are automatically defined when compiling the code.
1111

12-
<span class="notes">**Note:** In prior releases, the configuration system provided a method for adding custom targets. The Mbed OS tools now look for custom targets in a file named `custom_targets.json` in the root of a project and treat custom targets the same as <a href="/docs/v5.6/tools/adding-and-configuring-targets.html" target="_blank">Mbed targets</a>.</span>
12+
<span class="notes">**Note:** In prior releases, the configuration system provided a method for adding custom targets. The Mbed OS tools now look for custom targets in a file named `custom_targets.json` in the root of a project and treat custom targets the same as <a href="/docs/v5.7/tools/adding-and-configuring-targets.html" target="_blank">Mbed targets</a>.</span>
1313

1414
#### Defining configuration parameters
1515

@@ -91,7 +91,7 @@ In this JSON file:
9191
- `macros` is a list of extra macros that will be defined when compiling a project that includes this library. A macro can be defined without a value (such as `MYMOD_MACRO1` above) or with a value (such as `MYMOD_MACRO2` above).
9292
- `target_overrides` is a dictionary with target-specific values for the configuration parameters.
9393

94-
`target_overrides` is used to override the values of the parameters depending on the current compilation target. The keys in `target_overrides` are matched against toolchain *labels*. (You can find a description of Mbed targets in our documentation about <a href="/docs/v5.6/tools/adding-and-configuring-targets.html" target="_blank">adding and configuring targets</a>.) If a key inside `target_overrides` matches one of the target labels, the parameter values are changed according to the value of the key. In the example above:
94+
`target_overrides` is used to override the values of the parameters depending on the current compilation target. The keys in `target_overrides` are matched against toolchain *labels*. (You can find a description of Mbed targets in our documentation about <a href="/docs/v5.7/tools/adding-and-configuring-targets.html" target="_blank">adding and configuring targets</a>.) If a key inside `target_overrides` matches one of the target labels, the parameter values are changed according to the value of the key. In the example above:
9595

9696
- `config` is always processed first, independent of the target. `config` might define values for some of the parameters. In this case, `buffer_size` will be set to 1024, `queue_size` will be set to 10 and `timer_period` will not have a value.
9797
- If the library is compiled for the `K64F` target, `timer_period` will be set to 100, and `queue_size` will be set to 40 because they are overridden by the `K64F` key in `target_overrides`. `buffer_size` will be set to 1024, as defined in `config`.
@@ -107,7 +107,7 @@ If the source tree has code for more than one library, each library needs its ow
107107

108108
##### Configuration data in targets
109109

110-
Like libraries, targets can define their own configuration data. Additionally, targets can override the configuration of the target(s) they inherit from (for more details about how do define a target and target inheritance, check <a href="/docs/v5.6/tools/adding-and-configuring-targets.html" target="_blank">our configuring targets documentation</a>). Target configuration data is defined in `targets.json` using `config`, as described in the section about [defining configuration parameters](#defining-configuration-parameters). An example for a hypothetical `Base` target is given below:
110+
Like libraries, targets can define their own configuration data. Additionally, targets can override the configuration of the target(s) they inherit from (for more details about how do define a target and target inheritance, check <a href="/docs/v5.7/tools/adding-and-configuring-targets.html" target="_blank">our configuring targets documentation</a>). Target configuration data is defined in `targets.json` using `config`, as described in the section about [defining configuration parameters](#defining-configuration-parameters). An example for a hypothetical `Base` target is given below:
111111

112112
```
113113
"Base": {

docs/tools/debug/debug_intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Debugging
22

3-
There are extensive instructions on debugging Arm Mbed OS 5 applications with <a href="/docs/v5.6/tutorials/keil-uvision.html" target="_blank">uVision 5</a>, <a href="/docs/v5.6/tutorials/eclipse.html" target="_blank">Eclipse</a> and <a href="/docs/v5.6/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>, but you can use any IDE that supports GDB to debug Mbed OS 5 applications. This document gives advice on how to configure these IDEs. Before starting, first <a href="/docs/v5.6/tools/setting-up-a-local-debug-toolchain.html" target="_blank">configure your local debug toolchain</a>.
3+
There are extensive instructions on debugging Arm Mbed OS 5 applications with <a href="/docs/v5.7/tutorials/keil-uvision.html" target="_blank">uVision 5</a>, <a href="/docs/v5.7/tutorials/eclipse.html" target="_blank">Eclipse</a> and <a href="/docs/v5.7/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>, but you can use any IDE that supports GDB to debug Mbed OS 5 applications. This document gives advice on how to configure these IDEs. Before starting, first <a href="/docs/v5.7/tools/setting-up-a-local-debug-toolchain.html" target="_blank">configure your local debug toolchain</a>.
44

55
### Exporting your project
66

@@ -39,10 +39,10 @@ The resulting binary will end up at `BUILD\projectname.elf`.
3939

4040
### Debugging your project
4141

42-
To debug your project, you first need to start a <a href="/docs/v5.6/tools/setting-up-a-local-debug-toolchain.html#running-a-debug-server" target="_blank">debug server</a>. This is often exposed as a setting in your IDE under 'Remote debugging' or 'Debug server'.
42+
To debug your project, you first need to start a <a href="/docs/v5.7/tools/setting-up-a-local-debug-toolchain.html#running-a-debug-server" target="_blank">debug server</a>. This is often exposed as a setting in your IDE under 'Remote debugging' or 'Debug server'.
4343

4444
- When using pyOCD, set the full path to the `pyocd-gdbserver` binary, and do not set arguments.
45-
- When using OpenOCD, set the full path to the `openocd` binary, and set the arguments for your development board. (See <a href="/docs/v5.6/tools/setting-up-a-local-debug-toolchain.html#openocd" target="_blank">the instructions</a>.)
45+
- When using OpenOCD, set the full path to the `openocd` binary, and set the arguments for your development board. (See <a href="/docs/v5.7/tools/setting-up-a-local-debug-toolchain.html#openocd" target="_blank">the instructions</a>.)
4646

4747
Next, you need to configure GDB.
4848

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
## Debugging Arm Mbed OS applications
22

3-
At the heart of Arm Mbed is the <a href="/docs/v5.6/tools/arm-mbed-online-compiler.html" target="_blank">Online Compiler</a>. 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.
3+
At the heart of Arm Mbed is the <a href="/docs/v5.7/tools/arm-mbed-online-compiler.html" target="_blank">Online Compiler</a>. 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

55
The simplest way to debug your code is to augment your code with log statements, which you can observe from your computer.
66

77
### Debugging from an IDE
88

9-
Keil uVision natively supports debugging Mbed OS applications. To set up uVision, read <a href="/docs/v5.6/tutorials/keil-uvision.html" target="_blank">Debugging with Keil uVision</a>.
9+
Keil uVision natively supports debugging Mbed OS applications. To set up uVision, read <a href="/docs/v5.7/tutorials/keil-uvision.html" target="_blank">Debugging with Keil uVision</a>.
1010

11-
Mbed also supports debugging using any IDE that supports GDB. To set up the debugger, first read <a href="/docs/v5.6/tools/setting-up-a-local-debug-toolchain.html" target="_blank">Setting up your local debug toolchain</a>. 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 <a href="/docs/v5.7/tools/setting-up-a-local-debug-toolchain.html" target="_blank">Setting up your local debug toolchain</a>. Then read the section for your specific IDE. The same principles apply to any unlisted IDEs that supports GDB:
1212

13-
1. Producing <a href="/docs/v5.6/tools/debug-builds-with-arm-mbed-cli.html" target="_blank">debug builds with Arm Mbed CLI</a>.
14-
1. Debugging with <a href="/docs/v5.6/tutorials/eclipse.html" target="_blank">Eclipse</a>.
15-
1. Debugging with <a href="/docs/v5.6/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>.
16-
1. Debugging with <a href="/docs/v5.6/tools/debugging.html" target="_blank">other IDEs that support GDB</a>.
13+
1. Producing <a href="/docs/v5.7/tools/debug-builds-with-arm-mbed-cli.html" target="_blank">debug builds with Arm Mbed CLI</a>.
14+
1. Debugging with <a href="/docs/v5.7/tutorials/eclipse.html" target="_blank">Eclipse</a>.
15+
1. Debugging with <a href="/docs/v5.7/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>.
16+
1. Debugging with <a href="/docs/v5.7/tools/debugging.html" target="_blank">other IDEs that support GDB</a>.
1717

1818
### Links to other sources
1919

2020
- <a href="https://os.mbed.com/blog/entry/Post-mortem-debugging-with-ARM-mbed/" target="_blank">Using CMSIS-DAP to debug a device after it crashes</a>.
21-
- <a href="/docs/v5.6/tutorials/debug-microbit.html" target="_blank">Debugging the micro:bit with pyOCD and GDB</a>.
21+
- <a href="/docs/v5.7/tutorials/debug-microbit.html" target="_blank">Debugging the micro:bit with pyOCD and GDB</a>.

docs/tools/debug/local_debugging_toolchain.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ Remote debugging using localhost:3333
102102

103103
You now have set up a debug connection. From here, you can flash debug builds, step through code and use any IDE that supports GDB to debug Arm Mbed OS applications. For instructions, see:
104104

105-
1. Producing <a href="/docs/v5.6/tools/debug-builds-with-arm-mbed-cli.html" target="_blank">debug builds with Arm Mbed CLI</a>.
106-
1. Debugging with <a href="/docs/v5.6/tutorials/eclipse.html" target="_blank">Eclipse</a>.
107-
1. Debugging with <a href="/docs/v5.6/tutorials/keil-uvision.html" target="_blank">Keil uVision</a>.
108-
1. Debugging with <a href="/docs/v5.6/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>.
105+
1. Producing <a href="/docs/v5.7/tools/debug-builds-with-arm-mbed-cli.html" target="_blank">debug builds with Arm Mbed CLI</a>.
106+
1. Debugging with <a href="/docs/v5.7/tutorials/eclipse.html" target="_blank">Eclipse</a>.
107+
1. Debugging with <a href="/docs/v5.7/tutorials/keil-uvision.html" target="_blank">Keil uVision</a>.
108+
1. Debugging with <a href="/docs/v5.7/tutorials/visual-studio-code.html" target="_blank">Visual Studio Code</a>.
109109

110110
### Semihosting messages
111111

docs/tools/mbed_targets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Arm Mbed uses JSON as a description language for its build targets. You can find the JSON description of Mbed targets in `targets/targets.json` and in `custom_targets.json` in the root of a project directory. When you add new targets with `custom_targets.json`, they are added to the list of available targets.
44

5-
<span class="notes">**Note:** The Online Compiler does not support this functionality. You need to use <a href="https://os.mbed.com/docs/v5.6/tools/mbed-cli.html" target="_blank">Mbed CLI</a> to take your code offline.</span>
5+
<span class="notes">**Note:** The Online Compiler does not support this functionality. You need to use <a href="https://os.mbed.com/docs/v5.7/tools/mbed-cli.html" target="_blank">Mbed CLI</a> to take your code offline.</span>
66

77
You are not allowed to redefine existing targets in `custom_targets.json`. To better understand how a target is defined, we'll use this example (taken from `targets.json`):
88

@@ -199,7 +199,7 @@ Use this property to pass necessary data for exporting to various third party to
199199

200200
We use the tool <a href="https://github.com/ARMmbed/mbed-os/tree/master/tools/arm_pack_manager" target="_blank">ArmPackManager</a> to parse CMSIS Packs for target information. <a href="https://github.com/ARMmbed/mbed-os/blob/master/tools/arm_pack_manager/index.json" target="_blank">`index.json`</a> stores the parsed information from the <a href="http://www.keil.com/pack/doc/CMSIS/Pack/html/" target="_blank">PDSC (Pack Description</a> retrieved from each CMSIS Pack.
201201

202-
The <a href="/docs/v5.6/reference/contributing-target.html">`"device_name"`</a> attribute it `targets.json` maps from a target in Mbed OS to a device in a CMSIS Pack. To support IAR and uVision exports for your target, you must add a `"device_name"` field in `targets.json` containing this key.
202+
The <a href="/docs/v5.7/reference/contributing-target.html">`"device_name"`</a> attribute it `targets.json` maps from a target in Mbed OS to a device in a CMSIS Pack. To support IAR and uVision exports for your target, you must add a `"device_name"` field in `targets.json` containing this key.
203203

204204
<a href="http://www.keil.com/pack/Keil.Kinetis_K20_DFP.pdsc" target="_blank">http://www.keil.com/pack/Keil.Kinetis_K20_DFP.pdsc</a> is the PDSC that contains TEENSY_31 device (MK20DX256xxx7). ArmPackManager has parsed this PDSC, and `index.json` stores the device information. The device information begins on line 156 of the `.pdsc` file:
205205

docs/tools/offline/build_profiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Arm Mbed OS 5 supports three primary build profiles: *develop*, *debug* and *rel
99
- Hard to follow code flow when using a debugger.
1010
- Chip goes to sleep when idle:
1111
* Debugger is likely to drop connection.
12-
* Breaks the local file system on the <a href="/docs/v5.6/introduction/how-mbed-works.html#architecture-diagram" target="_blank">Arm Mbed interface</a> on some boards.
12+
* Breaks the local file system on the <a href="/docs/v5.7/introduction/how-mbed-works.html#architecture-diagram" target="_blank">Arm Mbed interface</a> on some boards.
1313

1414
### Debug profile
1515

@@ -24,4 +24,4 @@ Arm Mbed OS 5 supports three primary build profiles: *develop*, *debug* and *rel
2424
- Minimal error information.
2525
- Chip goes to sleep when going idle:
2626
- Debugger is likely to drop connection.
27-
- Breaks the local file system on the <a href="/docs/v5.6/introduction/how-mbed-works.html#architecture-diagram" target="_blank">Mbed interface</a> on some boards.
27+
- Breaks the local file system on the <a href="/docs/v5.7/introduction/how-mbed-works.html#architecture-diagram" target="_blank">Mbed interface</a> on some boards.

docs/tools/offline/cli-create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The arguments for *compile* are:
138138

139139
You can find the compiled binary, ELF image, memory usage and link statistics in the `BUILD` subdirectory of your program.
140140

141-
For more information on build profiles, see <a href="/docs/v5.6/tools/build-profiles.html" target="_blank">our build profiles</a> and <a href="/docs/v5.6/tools/toolchain-profiles.html" target="_blank">toolchain profiles</a> pages.
141+
For more information on build profiles, see <a href="/docs/v5.7/tools/build-profiles.html" target="_blank">our build profiles</a> and <a href="/docs/v5.7/tools/toolchain-profiles.html" target="_blank">toolchain profiles</a> pages.
142142

143143
#### Compiling static libraries
144144

@@ -170,7 +170,7 @@ Image: ../threaded_blinky-out/threaded_blinky.bin
170170

171171
### The compile configuration system
172172

173-
The <a href="/docs/v5.6/tools/the-configuration-system.html" target="_blank">compile configuration system</a> provides a flexible mechanism for configuring the Mbed program, its libraries and the build target.
173+
The <a href="/docs/v5.7/tools/the-configuration-system.html" target="_blank">compile configuration system</a> provides a flexible mechanism for configuring the Mbed program, its libraries and the build target.
174174

175175
#### Inspecting the configuration
176176

docs/tools/offline/cli-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The Windows installer for Mbed CLI for includes the following components:
7171
- <a href="https://git-scm.com/" target="_blank">Git</a> - version 2.12.2.
7272
- <a href="https://www.mercurial-scm.org/" target="_blank">Mercurial</a> - version 4.1.1.
7373
- **GNU Arm Embedded Toolchain** - <a href="https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads" target="_blank">GNU Embedded Toolchain for Arm</a>.
74-
- **Mbed Windows serial port driver** - <a href="/docs/v5.6/tutorials/windows-serial-driver.html" target="_blank">serial port driver</a>.
74+
- **Mbed Windows serial port driver** - <a href="/docs/v5.7/tutorials/windows-serial-driver.html" target="_blank">serial port driver</a>.
7575
7676
##### Install Windows installer for Mbed CLI
7777

docs/tools/offline/debug_builds_cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h2 id="debug-builds-cli">Debug builds</h2>
22

3-
After you've set up your <a href="/docs/v5.6/tools/toolchain-profiles.html" target="_blank">local debug toolchain</a>, you need firmware that includes program symbols (an `.elf` file). Because the Arm Mbed Online Compiler only produces binaries that omit the program symbols, you need to compile locally using <a href="/docs/v5.6/tools/mbed-cli.html" target="_blank">Arm Mbed CLI</a>.
3+
After you've set up your <a href="/docs/v5.7/tools/toolchain-profiles.html" target="_blank">local debug toolchain</a>, you need firmware that includes program symbols (an `.elf` file). Because the Arm Mbed Online Compiler only produces binaries that omit the program symbols, you need to compile locally using <a href="/docs/v5.7/tools/mbed-cli.html" target="_blank">Arm Mbed CLI</a>.
44

55
<span class="notes">**Note:** Make sure to do a clean build when switching to and from debug and release by removing the `BUILD` folder.</span>
66

@@ -26,7 +26,7 @@ $ mbed compile --profile .temp/tools/profiles/debug.json
2626

2727
### Exporting with debug symbols
2828

29-
You can also enable debug symbols when <a href="/docs/v5.6/tools/exporting.html" target="_blank">exporting your project</a> by using:
29+
You can also enable debug symbols when <a href="/docs/v5.7/tools/exporting.html" target="_blank">exporting your project</a> by using:
3030

3131
```
3232
$ mbed export -i uvision -m K64F --profile mbed-os/tools/profiles/debug.json

0 commit comments

Comments
 (0)