Skip to content

Commit b3a61d2

Browse files
author
AnotherButler
committed
Update link formats
Update link formats.
1 parent ea8ddee commit b3a61d2

31 files changed

+59
-61
lines changed

docs/reference/api/drivers/RawSerial.md

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

3-
The RawSerial class provides UART functionality without the use of <a href="/docs/reference/api/platform/Stream.md" target="_blank">Stream's</a> print and scan functions the way the Serial class does. RawSerial does not retarget the standard library print and scan functions. Instead, RawSerial reimplements the print and scan functions to use each target's underlying serial communication functions. See the porting guide for <a href="/docs/v5.7/reference/contributing-target.html#serial" target="_blank">target serial support</a>. This makes RawSerial suitable for use in interrupt handlers with the RTOS.
3+
The RawSerial class provides UART functionality without the use of [Stream's](/docs/reference/api/platform/Stream.md) print and scan functions the way the Serial class does. RawSerial does not retarget the standard library print and scan functions. Instead, RawSerial reimplements the print and scan functions to use each target's underlying serial communication functions. See the porting guide for [target serial support](/docs/v5.7/reference/contributing-target.html#serial). This makes RawSerial suitable for use in interrupt handlers with the RTOS.
44

55
Serial channels have the following configurable parameters in the constructor:
66

docs/reference/api/platform/Callback.md

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

33
A callback is a user provided function that a user may pass to an API. The callback allows the API to execute the user’s code in its own context.
44

5-
This is the technical reference for callbacks. You should read the <a href="/docs/v5.7/reference/platform.html#callbacks" target="_blank">Callbacks</a> section of the <a href="/docs/v5.7/reference/platform.html" target="_blank">Platform Overview</a> first for deeper insight into their use.
5+
This is the technical reference for callbacks. You should read the [Callbacks](/docs/v5.7/reference/platform.html#callbacks) section of the [Platform Overview](/docs/v5.7/reference/platform.html) first for deeper insight into their use.
66

77
### Callback class reference
88

docs/reference/api/platform/NonCopyable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We recommend using the NonCopyable class whenever a class owns a resource (lock/
1010

1111
### NonCopyable example
1212

13-
Copying objects of classes used for locking, network encapsulation, hardware bus and so on should not occur. Mbed OS has noncopyable classes, such as <a href="/docs/v5.7/reference/mutex.html" target="_blank">Mutex</a>, <a href="/docs/v5.7/reference/eventflags.html" target="_blank">EventFlags</a>, <a href="/docs/v5.7/reference/busout.html" target="_blank">BusOut</a>, <a href="/docs/v5.7/reference/interruptin.html" target="_blank">InterruptIn</a> and <a href="/docs/v5.7/reference/i2c.html" target="_blank">I2C</a>.
13+
Copying objects of classes used for locking, network encapsulation, hardware bus and so on should not occur. Mbed OS has noncopyable classes, such as [Mutex](/docs/v5.7/reference/mutex.html), [EventFlags](/docs/v5.7/reference/eventflags.html), [BusOut](/docs/v5.7/reference/busout.html), [InterruptIn](/docs/v5.7/reference/interruptin.html) and [I2C](/docs/v5.7/reference/i2c.html).
1414

1515
### Related content
1616

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

3-
The PlarformMutex class provides mutex stub functions in the absence of RTOS. This class enables you to use driver/application code when the RTOS is not present.
3+
The PlarformMutex class provides mutex stub functions in the absence of RTOS. This class enables you to use driver/application code when the RTOS is not present.
44

55
### PlatformMutex class reference
66

@@ -12,12 +12,12 @@ The code below demonstrates usage of PlatformMutex.
1212

1313
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/file/2084d9e90526/main.cpp)
1414

15-
Mbed OS uses the PlarformMutex class instead of the RTOS mutex for all drivers. For example, please see <a href="/docs/v5.6/reference/analogin.html" target="_blank">AnalogIn</a>, <a href="/docs/v5.6/reference/busout.html" target="_blank">BusOut</a>, <a href="/docs/v5.6/reference/spi.html" target="_blank">SPI</a>, <a href="/docs/v5.6/reference/serial.html" target="_blank">Serial</a> and <a href="/docs/v5.6/reference/i2c.html" target="_blank">I2C</a>.
15+
Mbed OS uses the PlarformMutex class instead of the RTOS mutex for all drivers. For example, please see [AnalogIn](/docs/v5.6/reference/analogin.html), [BusOut](/docs/v5.6/reference/busout.html), [SPI](/docs/v5.6/reference/spi.html), [Serial](/docs/v5.6/reference/serial.html) and [I2C](/docs/v5.6/reference/i2c.html).
1616

1717
### Related content
1818

1919
- [AnalogIn](/docs/v5.6/reference/analogin.html).
20-
- [BusOut](/docs/v5.6/reference/busout.html).
21-
- [SPI](/docs/v5.6/reference/spi.html).
22-
- [Serial](/docs/v5.6/reference/serial.html).
20+
- [BusOut](/docs/v5.6/reference/busout.html).
21+
- [SPI](/docs/v5.6/reference/spi.html).
22+
- [Serial](/docs/v5.6/reference/serial.html).
2323
- [I2C](/docs/v5.6/reference/i2c.html).

docs/reference/api/rtos/rtos.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<h2 id="rtos-api">RTOS overview</h2>
22

3-
The Arm Mbed RTOS is a C++ wrapper over the Keil RTX code. For more information about Keil RTX, check <a href="https://github.com/ARM-software/CMSIS/raw/master/CMSIS/Documentation/RTX/CMSIS_RTOS_Tutorial.pdf" target="_blank">the Keil CMSIS-RTOS tutorial</a> and <a href="https://www.element14.com/community/docs/DOC-46650/l/arm-keil-rtx-real-time-operating-system-overview" target="_blank">the element14 introduction to Keil RTX</a>. You can use these resources as a general introduction to RTOS principles; it is important to be familiar with the concepts behind an RTOS in order to understand this guide.
3+
The Arm Mbed RTOS is a C++ wrapper over the Keil RTX code. For more information about Keil RTX, check [the Keil CMSIS-RTOS tutorial](https://github.com/ARM-software/CMSIS/raw/master/CMSIS/Documentation/RTX/CMSIS_RTOS_Tutorial.pdf) and [the element14 introduction to Keil RTX](https://www.element14.com/community/docs/DOC-46650/l/arm-keil-rtx-real-time-operating-system-overview). You can use these resources as a general introduction to RTOS principles; it is important to be familiar with the concepts behind an RTOS in order to understand this guide.
44

5-
The code of the Mbed RTOS can be found in the <a href="https://github.com/ARMmbed/mbed-os" target="_blank">`mbed-os`</a> repository, in the <a href="https://github.com/ARMmbed/mbed-os/tree/master/rtos" target="_blank">RTOS subdirectory</a>. See <a href="https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/group__rtos.html" target="_blank">the Doxygen</a> for more information.
5+
The code of the Mbed RTOS can be found in the [`mbed-os`](https://github.com/ARMmbed/mbed-os) repository, in the [RTOS subdirectory](https://github.com/ARMmbed/mbed-os/tree/master/rtos). See [the Doxygen](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/group__rtos.html) for more information.
66

77
#### SysTick
88

docs/reference/api/security/TLS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Then create a file named `mbed_app.json` at the root of your application with th
4141

4242
### Other resources
4343

44-
The <a href="https://tls.mbed.org" target="_blank">Mbed TLS website</a> contains many other useful resources for developers, such as <a href="https://tls.mbed.org/dev-corner" target="_blank">developer documentation</a>, <a href="https://tls.mbed.org/kb" target="_blank">knowledge base articles</a> and a <a href="https://tls.mbed.org/discussions" target="_blank">support forum</a>.
44+
The [Mbed TLS website](https://tls.mbed.org) contains many other useful resources for developers, such as [developer documentation](https://tls.mbed.org/dev-corner), [knowledge base articles](https://tls.mbed.org/kb) and a [support forum](https://tls.mbed.org/discussions).

docs/reference/api/storage/storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `fopen` function is similar to the open function above but associates a stre
3333

3434
The [BlockDevice](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_block_device.html) class provides the underlying API for representing block-based storage that you can use to back a file system. Mbed OS provides standard interfaces for the more common storage media, and you can extend the BlockDevice class to provide support for unsupported storage.
3535

36-
Additionally, two utility block devices give you better control over storage allocation. The <a href="https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_slicing_block_device.html" target="_blank">slicing block device</a> allows you to partition storage into smaller block devices that you can use independently, and the <a href="https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_chaining_block_device.html" target="_blank">chaining block device</a> allows you to chain multiple block devices together and extend the usable amount of storage.
36+
Additionally, two utility block devices give you better control over storage allocation. The [slicing block device](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_slicing_block_device.html) allows you to partition storage into smaller block devices that you can use independently, and the [chaining block device](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_chaining_block_device.html) allows you to chain multiple block devices together and extend the usable amount of storage.
3737

3838
<span class="notes">**Note:** Some file systems may provide a format function for cleanly initializing a file system on an underlying block device or require external tools to set up the file system before the first use.</span>
3939

@@ -71,7 +71,7 @@ Partitioning allows you to split a block device among multiple storage users suc
7171

7272
### C++ classes
7373

74-
The FileSystem class provides the core user C++ API. Mbed OS provides <a href="https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/classmbed_1_1_file.html" target="_blank">File</a> and <a href="https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/classmbed_1_1_dir.html" target="_blank">Dir</a> classes that represent files and directories in a C++ API.
74+
The FileSystem class provides the core user C++ API. Mbed OS provides [File](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/classmbed_1_1_file.html) and [Dir](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/classmbed_1_1_dir.html) classes that represent files and directories in a C++ API.
7575

7676
### Block device operations
7777

docs/reference/configuration/configuration.md

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

33
The Arm Mbed configuration system customizes the compile time configuration of Mbed components: targets, libraries and applications.
44

5-
Mbed OS provides some default memory configurations for thread memory allocation. You may want to modify these configurations to better suit your project. You can read about the default configurations and how you can modify them below.
5+
Mbed OS provides some default memory configurations for thread memory allocation. You may want to modify these configurations to better suit your project. You can read about the default configurations and how you can modify them below.
66

77
#### Configuring the main thread stack
88

@@ -20,7 +20,7 @@ The default stack size of the main application thread is 4 kilobytes. This memor
2020

2121
#### Configuring user spawned thread stacks
2222

23-
The default stack size of a user spawned thread is 4 kilobytes. You can configure the stack size of user spawned threads by using the <a href="/docs/v5.7/tools/index.html#the-configuration-system" target="_blank">Mbed config system</a> or passing in the <a href="/docs/v5.7/reference/thread.html" target="_blank">Thread constructor</a>. You can reduce the default stack size for user spawned threads from 4K to 2K in the following two ways:
23+
The default stack size of a user spawned thread is 4 kilobytes. You can configure the stack size of user spawned threads by using the [Mbed config system](/docs/v5.7/tools/index.html#the-configuration-system) or passing in the [Thread constructor](/docs/v5.7/reference/thread.html). You can reduce the default stack size for user spawned threads from 4K to 2K in the following two ways:
2424

2525
1. Create an `mbed_app.json` file for your project with the following content:
2626

@@ -46,4 +46,3 @@ int main() {
4646
Thread thread(osPriorityNormal, sizeof(stack_on_main_stack), stack_on_main_stack);
4747
}
4848
```
49-

docs/reference/contributing/connectivity/CellularInterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can implement a cellular network interface in different ways depending on yo
2727

2828
**Case 3: Modem present on target board**
2929
- This refers to the case when the cellular modem is bundled with the target board.
30-
- Target board must provide an implementation of the <a href="https://github.com/ARMmbed/mbed-os/blob/master/features/netsocket/cellular/onboard_modem_api.h" target="_blank">onboard_modem_API</a>. For example, the target port for u-blox C027 Mbed Enabled IoT starter kit provides an <a href="https://github.com/ARMmbed/mbed-os/blob/master/targets/TARGET_NXP/TARGET_LPC176X/TARGET_UBLOX_C027/onboard_modem_api.c" target="_blank">implementation</a> of `onboard_modem_api`.
30+
- Target board must provide an implementation of the [onboard_modem_API](https://github.com/ARMmbed/mbed-os/blob/master/features/netsocket/cellular/onboard_modem_api.h). For example, the target port for u-blox C027 Mbed Enabled IoT starter kit provides an [implementation](https://github.com/ARMmbed/mbed-os/blob/master/targets/TARGET_NXP/TARGET_LPC176X/TARGET_UBLOX_C027/onboard_modem_api.c) of `onboard_modem_api`.
3131
- Following Mbed OS conventions, drivers for on-board modules may become part of the Mbed OS tree.
3232
- `OnboardCellularInterface` ties together `onboard_modem_api.h` with the generic `PPPCellularInterface` to provide a complete driver. At present, only UART connection type is handled.
3333

docs/reference/contributing/guidelines/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you create new software, such as drivers, libraries and examples, you can app
1818

1919
You must either write all the code you provide yourself, or have the necessary rights to provide code written by someone else.
2020

21-
In all cases, whatever license you use, please use an <a href="http://spdx.org/licenses/" target="_blank">SPDX license identifier</a> in every source file following the <a href="https://spdx.org/spdx-specification-21-web-version#h.twlc0ztnng3b" target="_blank">recommendations</a> to make it easier for users to understand and review licenses.
21+
In all cases, whatever license you use, please use an [SPDX license identifier](http://spdx.org/licenses/) in every source file following the [recommendations](https://spdx.org/spdx-specification-21-web-version#h.twlc0ztnng3b) to make it easier for users to understand and review licenses.
2222

2323
#### When to use Apache 2.0
2424

docs/reference/contributing/guidelines/style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
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 <a href="/docs/v5.7/reference/guidelines.html#cla" target="_blank">CLA</a> and <a href="/docs/v5.7/reference/guidelines.html#workflow" target="_blank">workflow</a> sections for a review of the process and legal requirements.</span>
5+
<span class="tips">**Tip:** Please also read the [CLA](/docs/v5.7/reference/guidelines.html#cla) and [workflow](/docs/v5.7/reference/guidelines.html#workflow) sections for a review of the process and legal requirements.</span>
66

77
#### Code acceptance
88

docs/reference/contributing/guidelines/workflow.md

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

33
#### Contributions
44

5-
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](#contributing-new-features-to-mbed-os) and [bugs](#reporting-and-fixing-bugs). In both cases, please follow the <a href="/docs/v5.7/reference/guidelines.html#style" target="_blank">code style guide and GitHub pull request guidelines</a>. Please also read the <a href="/docs/v5.7/reference/guidelines.html#cla" target="_blank">CLA</a> guidelines because we will immediately close pull requests submitted without a CLA.
5+
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](#contributing-new-features-to-mbed-os) and [bugs](#reporting-and-fixing-bugs). In both cases, please follow the [code style guide and GitHub pull request guidelines](/docs/v5.7/reference/guidelines.html#style)</a>. Please also read the [CLA](/docs/v5.7/reference/guidelines.html#cla) guidelines because we will immediately close pull requests submitted without a CLA.
66

77
#### Contributing new features to Mbed OS
88

@@ -88,9 +88,9 @@ All pull requests must be reviewed. The Mbed OS maintainers determine the most s
8888

8989
There are a number of CI systems available. Which CI tests we run against a particular pull request depends on the effect of that pull request to the code base. Irrespective of which CIs tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request.
9090

91-
##### Releases
91+
##### Releases
9292

93-
Once we merge a pull request, we tag it with a release. This is the release in which we first publish this pull request. For patch releases, we allow only bug fixes, new targets and enhancements to existing functionality. New features only go to feature releases.
93+
Once we merge a pull request, we tag it with a release. This is the release in which we first publish this pull request. For patch releases, we allow only bug fixes, new targets and enhancements to existing functionality. New features only go to feature releases.
9494

9595
The release tag has the following format:
9696

@@ -110,4 +110,3 @@ The following labels summarize the scope of the pull request.
110110
- *scope: bug-fix*.
111111
- *scope: feature*.
112112
- *scope: new-target*.
113-

docs/reference/contributing/target/exporter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can open the generated `.creator` project in Qt Creator, enabling integratio
2020

2121
#### CMSIS Packs
2222

23-
uVision and IAR both use <a href="http://www.keil.com/pack/doc/CMSIS/Pack/html/index.html" target="_blank">CMSIS packs</a> to find target information necessary to create a valid project file. Add a `"device_name"` attribute to your target as <a href="https://os.mbed.com/docs/v5.7/tools/adding-and-configuring-targets.html" target="_blank">Adding and configuring targets</a> describes to support these exporters.
23+
uVision and IAR both use [CMSIS packs](http://www.keil.com/pack/doc/CMSIS/Pack/html/index.html) to find target information necessary to create a valid project file. Add a `"device_name"` attribute to your target as [Adding and configuring targets](https://os.mbed.com/docs/v5.7/tools/adding-and-configuring-targets.html) describes to support these exporters.
2424

2525
#### uVision
2626
[uVision project file template](https://github.com/ARMmbed/mbed-os/blob/master/tools/export/uvision/uvision.tmpl#L15) uses target information from CMSIS Packs to generate valid uVision5 projects. If the uVision exporter cannot find the `"device_name"`, it substitutes a generic Arm CPU target.

0 commit comments

Comments
 (0)