Skip to content

Commit e71b6b6

Browse files
committed
LinkChecker fun
1 parent 917f51d commit e71b6b6

26 files changed

+37
-39
lines changed

docs/api/api.md

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

33
### Platform APIs
44

5-
[Platform APIs](platform.html) provide general purpose MCU management infrastructure, common data structures and a consistent user experience on top of different standard libraries and toolchains.
5+
[Platform APIs](platform.html) provide general purpose MCU management infrastructure, common data structures and a consistent user experience on top of different standard libraries and toolchains.
66

77
<table>
88
<tbody>
99
<tr>
1010
<td><a href="wait.html">Wait</a></td>
11-
<td><a href="idleloop.html">IdleLoop</a></td>
11+
<td><a href="Idle-loop.html">IdleLoop</a></td>
1212
<td><a href="debug.html">Debug</a></td>
1313
<td><a href="noncopyable.html">NonCopyable</a></td>
1414
<td><a href="circularbuffer.html">CircularBuffer</a></td>
@@ -38,7 +38,7 @@
3838

3939
### Drivers APIs
4040

41-
[Driver APIs](drivers.html) include analog and digital inputs and outputs on development boards, as well as digital interfaces, which allow your board to interface with a computer or external devices.
41+
[Driver APIs](drivers.html) include analog and digital inputs and outputs on development boards, as well as digital interfaces, which allow your board to interface with a computer or external devices.
4242

4343
<table>
4444
<tbody>

docs/api/drivers/RawSerial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ _9600-8-N-1_, a common notation for serial port settings, describes the default
2222

2323
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_raw_serial.html)
2424

25-
<span class="notes">**Note**: On a Windows machine, you need to install a USB serial driver. See [Windows serial configuration](/docs/development/tutorials/serial-communication.html#windows-serial-driver).</span>
25+
<span class="notes">**Note**: On a Windows machine, you need to install a USB serial driver. See [Windows serial configuration](/docs/development/tutorials//docs/development/tutorials/serial-communication.html#windows-serial-driver).</span>
2626

2727
### RawSerial hello, world
2828

docs/api/networkinterfaces/networkinterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ if (wifi) {
8282
### Related content
8383

8484
- [Configuring the default network interface](/docs/development/reference/configuration-connectivity.html#selecting-the-default-network-interface).
85-
- [Network connectivity](/docs/development/reference/connectivity-tech.html).
85+
- [Network connectivity](/docs/development/reference/connectivity-stacks.html).
8686
- [IP networking](/docs/development/reference/ip-networking.html).
8787
- [Network status API](network-status.html).
8888
- [Network sockets](/docs/development/apis/network-socket.html).

docs/api/platform/IdleLoop.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Idle loop
1+
## Idle loop
22

33
Idle loop is a background system thread, which scheduler executes when no other threads are ready to run. That may happen when your application is waiting for an event to happen. By default, the idle loop invokes sleep manager to enter a sleep mode. You can overwrite this behavior by providing a different handler:
44

@@ -14,7 +14,7 @@ void main()
1414
}
1515
```
1616

17-
#### Function reference
17+
### Function reference
1818

1919
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__rtos___idle.html)
2020

@@ -24,8 +24,6 @@ void main()
2424

2525
### Related content
2626

27-
### Related content
28-
2927
- [DeepSleepLock API reference](deepsleeplock.html).
3028
- [Power management API reference](power-management.html).
3129
- [Office Hours video about low power, tickless and sleep](https://www.youtube.com/watch?v=OFfOlBaegdg).

docs/introduction/terms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
**Application** - An executable module built out of libraries that acts as a final product.
88

9-
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](/docs/development/tools/developing-arm-mbed-cli.html), packaged as `mbed-cli`.
9+
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](/docs/development/tools/developing-mbed-cli.html), packaged as `mbed-cli`.
1010

1111
**Arm Mbed interface** - The extra chip that sits on all [Mbed Enabled development boards](index.html). It's what makes the target chip (for example, K64F) look like a USB drive. It usually runs a separate piece of software that generally doesn't change. That software is usually `DAPLink`, `CMSIS-DAP` or `STLink`.
1212

13-
**Arm Mbed Online Compiler** - [Arm’s online tool](/docs/development/tools/developing-arm-mbed-online-compiler.html), which you can use to create and compile your code.
13+
**Arm Mbed Online Compiler** - [Arm’s online tool](/docs/development/tools/developing-mbed-online-compiler.html), which you can use to create and compile your code.
1414

1515
**Arm Mbed OS** - Arm's [platform operating system](https://os.mbed.com/docs) for the Internet of Things.
1616

docs/porting/connectivity/LoRaPortingGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h2 id="lora-port">Porting LoRaWAN stack and LoRa RF drivers</h2>
22

3-
Mbed OS contains a native LoRaWAN stack (inside the Mbed OS tree) augmented with most commonly used LoRa RF drivers (outside the Mbed OS tree). Arm encourages developers around the globe to contribute to any of the Mbed OS features and functionality, including the LoRaWAN stack and related RF drivers using the [general guidelines provided](/docs/development/reference/guidelines.html).
3+
Mbed OS contains a native LoRaWAN stack (inside the Mbed OS tree) augmented with most commonly used LoRa RF drivers (outside the Mbed OS tree). Arm encourages developers around the globe to contribute to any of the Mbed OS features and functionality, including the LoRaWAN stack and related RF drivers using the [general guidelines provided](/docs/development/reference/contributing.html).
44

55
The information in this section can be classified in two subsections:
66

docs/reference/configuration/mesh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This guide is divided in sections, and generic Nanostack configurations are firs
88

99
For understanding the technologies and APIs, please refer to following sections before this one:
1010

11-
- [Network connectivity in Mbed OS](connectivity-tech.html) technology page.
11+
- [Network connectivity in Mbed OS](connectivity-stacks.html) technology page.
1212
- [6LoWPAN Mesh technology](mesh-tech.html) page.
1313
- [6LoWPAN Mesh class reference](/docs/development/apis/mesh-api.html) user API.
1414
- [Socket API](/docs/development/apis/network-socket.html).

docs/reference/contributing/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
The Arm Mbed OS porting guide describes how to a add development board Mbed OS and configure it. It includes porting information about related features, such as cellular, exporters and Mbed TLS. It also contains information about CMSIS, RTX and Thread safety.
44

5-
Please see the contributing guide's section on [contributing code](/docs/development/reference/guidelines.html#style) for style and ABI requirements.
5+
Please see the contributing guide's section on [contributing code](/docs/development/reference/style.html) for style and ABI requirements.

docs/reference/contributing/guidelines/design_guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Principles of Arm Mbed software:
99

1010
### Style
1111

12-
Please refer to the [Mbed style guide](/docs/development/reference/guidelines.html#style).
12+
Please refer to the [Mbed style guide](/docs/development/reference/style.html).
1313

1414
### Organization
1515

docs/reference/contributing/guidelines/style.md

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

33
The Arm Mbed OS codebase is hosted on GitHub, and you can submit new features or bug fixes. Please follow the [guidelines for GitHub pull requests](#guidelines-for-github-pull-requests) and the [coding style guide](#coding-style) in your submissions.
44

5-
<span class="tips">**Tip:** Please also read the [CLA](guidelines.html#cla) and [workflow](guidelines.html#workflow) sections for a review of the process and legal requirements.</span>
5+
<span class="tips">**Tip:** Please also read the [CLA](/docs/development/reference/license.html) and [workflow](/docs/development/reference/workflow.html) sections for a review of the process and legal requirements.</span>
66

77
### Code acceptance
88

9-
[After the CLA](guidelines.html#cla) is in place and the code has gone through automated testing, developers will take a look and comment on the pull request. If all is well and acceptable, your code will be ready for merging into the central development branch.
9+
[After the CLA](/docs/development/reference/license.html) is in place and the code has gone through automated testing, developers will take a look and comment on the pull request. If all is well and acceptable, your code will be ready for merging into the central development branch.
1010

1111
### Coding style
1212

docs/reference/contributing/guidelines/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Workflow
22

3-
All code changes and additions to Mbed OS are handled through GitHub. If you want to contribute, either by adding features or by fixing bugs, please follow the guidelines for [new features](#features) and [bugs](#reporting-bugs). In both cases, please follow the [code style guide and GitHub pull request guidelines](guidelines.html#style). Please also read the [Contributor License Agreement (CLA)](guidelines.html#cla) guidelines because we will immediately close pull requests submitted without a CLA.
3+
All code changes and additions to Mbed OS are handled through GitHub. If you want to contribute, either by adding features or by fixing bugs, please follow the guidelines for [new features](#features) and [bugs](#reporting-bugs). In both cases, please follow the [code style guide and GitHub pull request guidelines](/docs/development/reference/style.html). Please also read the [Contributor License Agreement (CLA)](/docs/development/reference/license.html) guidelines because we will immediately close pull requests submitted without a CLA.
44

55
### Mbed OS maintainers
66

docs/tools/CLI/debug_builds_cli.md

Lines changed: 1 addition & 1 deletion
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 [local debug toolchain](toolchain-profiles.html), 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 [Arm Mbed CLI](developing-arm-mbed-cli.html).
3+
After you've set up your [local debug toolchain](toolchain-profiles.html), 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 [Arm Mbed CLI](developing-mbed-cli.html).
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

docs/tools/IDE/compiler_pull_requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ An important thing to know about pull requests is that they can only exist betwe
1010

1111
#### Tutorial
1212

13-
For more information about using pull requests on the Online Compiler, please see [our tutorial](/docs/development/tutorials/pr-tutorial.html), which covers creating and editing a pull request, viewing a pull request and accepting or rejecting a pull request.
13+
For more information about using pull requests on the Online Compiler, please see [our tutorial](/docs/development/tools/pr-tutorial.html), which covers creating and editing a pull request, viewing a pull request and accepting or rejecting a pull request.

docs/tools/IDE/oc_tut.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The **Compile** menu offers five options:
9797

9898
### Copying the file to the board
9999

100-
<span class="notes">**Note:** If you're working on Windows, you might need to install a driver to allow you to copy to your board. Please see the [Windows Serial Driver section](serial-communication.html).</span>
100+
<span class="notes">**Note:** If you're working on Windows, you might need to install a driver to allow you to copy to your board. Please see the [Windows Serial Driver section](/docs/development/tutorials/serial-communication.html).</span>
101101

102102
Your board should appear on your computer as removable storage. To run your program on the board, simply drag and drop the file you downloaded in the previous section.
103103

docs/tools/debug/debugging_mbed_os_apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Debugging Arm Mbed OS applications
22

3-
At the heart of Arm Mbed is the [Online Compiler](developing-arm-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.
3+
At the heart of Arm Mbed is the [Online Compiler](developing-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

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

docs/tools/mbed_targets.md

Lines changed: 1 addition & 1 deletion
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. If you provide a source directory using the `--source` switch, Mbed looks for `custom_targets.json` in that directory instead. 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 [Mbed CLI](developing-arm-mbed-cli.html) to take your code offline.</span>
5+
<span class="notes">**Note:** The Online Compiler does not support this functionality. You need to use [Mbed CLI](developing-mbed-cli.html) 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

docs/tools/testing/testing_greentea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ A test case is named by its position in your project's file structure. For insta
4444

4545
#### Building tests
4646

47-
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](developing-arm-mbed-cli.html).
47+
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](developing-mbed-cli.html).
4848

4949
When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a **test specification** file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the [Greentea documentation](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).
5050

docs/tools/testing/testing_icetea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Test names are defined in the Python scripts themselves. For example, `TEST_APPS
1818

1919
#### Building tests
2020

21-
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](developing-arm-mbed-cli.html).
21+
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](developing-mbed-cli.html).
2222

2323
When you build tests for a target and a toolchain, the script discovers the available test cases. The required C++ applications are determined from the available test cases and build in parallel.
2424

docs/tools/testing/unit_testing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Detailed instructions for supported operating systems are below.
3030
sudo easy_install pip
3131
```
3232

33-
1. Install Gcovr and [Mbed CLI](developing-arm-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
33+
1. Install Gcovr and [Mbed CLI](developing-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
3434

3535
#### Installing dependencies on macOS
3636

@@ -43,15 +43,15 @@ Detailed instructions for supported operating systems are below.
4343
sudo easy_install pip
4444
```
4545

46-
1. Install Gcovr and [Mbed CLI](developing-arm-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
46+
1. Install Gcovr and [Mbed CLI](developing-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
4747

4848
#### Installing dependencies on Windows
4949

5050
1. Download and install [MinGW-W64](http://mingw-w64.org/).
5151
1. Download CMake binaries from https://cmake.org/download/, and run the installer.
5252
1. Download Python 2.7 or Python 3 from https://www.python.org/getit/, and run the installer.
5353
1. Add MinGW, CMake and Python into system PATH.
54-
1. Install Gcovr and [Mbed CLI](developing-arm-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
54+
1. Install Gcovr and [Mbed CLI](developing-mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
5555

5656
### Test code structure
5757

@@ -69,7 +69,7 @@ The build system automatically generates names of test suites. The name is const
6969

7070
### Unit testing with Mbed CLI
7171

72-
Mbed CLI supports unit tests through `mbed test --unittests` command. To learn how to use unit tests with Mbed CLI, please see the [appropriate documentation section](test-and-debug.html#unit-testing). For other information on using Mbed CLI, please see the [CLI documentation in handbook](developing-arm-mbed-cli.html).
72+
Mbed CLI supports unit tests through `mbed test --unittests` command. To learn how to use unit tests with Mbed CLI, please see the [appropriate documentation section](test-and-debug.html#unit-testing). For other information on using Mbed CLI, please see the [CLI documentation in handbook](developing-mbed-cli.html).
7373

7474
### Writing unit tests
7575

docs/tools/toolchains/export_to_third_party.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The export process generates a ZIP archive with a project file matching your sel
3535

3636
### Exporting from Arm Mbed CLI
3737

38-
[Mbed CLI](developing-arm-mbed-cli.html) currently supports [exporting](exporting.html#exporting-from-arm-mbed-cli) to all of the development environments mentioned above by using the `export` command.
38+
[Mbed CLI](developing-mbed-cli.html) currently supports [exporting](exporting.html#exporting-from-arm-mbed-cli) to all of the development environments mentioned above by using the `export` command.
3939

4040
For example, to export to uVision5 with the K64F target, run:
4141

docs/tools/tools_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ We developed Mbed OS 5 using the Mbed CLI tool, which is a Python program that c
1515

1616
##### Arm Mbed CLI
1717

18-
We created the Mbed command-line tool (Mbed CLI), a Python-based tool, specifically for Mbed OS 5. For more information, see the [Mbed CLI page](developing-arm-mbed-cli.html).
18+
We created the Mbed command-line tool (Mbed CLI), a Python-based tool, specifically for Mbed OS 5. For more information, see the [Mbed CLI page](developing-mbed-cli.html).
1919

2020
##### Compiler versions
2121

@@ -27,7 +27,7 @@ Mbed OS 5 can be built with various toolchains. The currently supported versions
2727

2828
##### Arm Mbed Online Compiler
2929

30-
The Mbed Online Compiler is our in-house IDE, and should be familiar to anyone who's been working with Mbed for a while. For more information, see the [Online Compiler page](developing-arm-mbed-online-compiler.html).
30+
The Mbed Online Compiler is our in-house IDE, and should be familiar to anyone who's been working with Mbed for a while. For more information, see the [Online Compiler page](developing-mbed-online-compiler.html).
3131

3232
##### Third party development tools
3333

docs/tutorials/debug/vs_code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document explains how to build and debug Arm Mbed OS applications using Visual Studio Code. Before starting, first [configure your local debug toolchain](/docs/development/tools/setting-up-a-local-debug-toolchain.html).
44

5-
Also install [GNU Make](https://www.gnu.org/software/make/) or [Mbed CLI](/docs/development/tools/developing-arm-mbed-cli.html) to build the project.
5+
Also install [GNU Make](https://www.gnu.org/software/make/) or [Mbed CLI](/docs/development/tools/developing-mbed-cli.html) to build the project.
66

77
### Installing Visual Studio Code
88

0 commit comments

Comments
 (0)