Skip to content

Commit 95640ce

Browse files
author
AnotherButler
committed
Change 5.6 to 5.7
Update sections that weren't affected last time.
1 parent 6fb13d3 commit 95640ce

File tree

19 files changed

+32
-32
lines changed

19 files changed

+32
-32
lines changed

docs/reference/configuration/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Mbed OS provides some default memory configurations for thread memory allocation
66

77
#### Configuring the main thread stack
88

9-
The default stack size of the main application thread is 4 kilobytes. This memory is dynamically allocated from the global heap. You can configure the stack size of the main thread by using the <a href="/docs/v5.6/tools/index.html#the-configuration-system" target="_blank">Mbed config system</a>. To reduce the stack size from 4K to 2K, create an `mbed_app.json` file for your project with the following content:
9+
The default stack size of the main application thread is 4 kilobytes. This memory is dynamically allocated from the global heap. You can configure the stack size of the main thread by using the <a href="/docs/v5.7/tools/index.html#the-configuration-system" target="_blank">Mbed config system</a>. To reduce the stack size from 4K to 2K, create an `mbed_app.json` file for your project with the following content:
1010

1111
```JSON
1212
{
@@ -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.6/tools/index.html#the-configuration-system" target="_blank">Mbed config system</a> or passing in the <a href="/docs/v5.6/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 <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:
2424

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

@@ -38,7 +38,7 @@ The default stack size of a user spawned thread is 4 kilobytes. You can configur
3838

3939
`Thread thread(osPriorityNormal, 2000);`
4040

41-
By default, mbed OS dynamically allocates the memory for the thread's stack from the global heap, though you can change it in the <a href="/docs/v5.6/reference/thread.html" target="_blank">Thread constructor</a>. Here is an example application that uses memory allocated from the main thread's stack for the newly spawned thread stack:
41+
By default, mbed OS dynamically allocates the memory for the thread's stack from the global heap, though you can change it in the <a href="/docs/v5.7/reference/thread.html" target="_blank">Thread constructor</a>. Here is an example application that uses memory allocated from the main thread's stack for the newly spawned thread stack:
4242

4343
```
4444
int main() {

docs/reference/contributing/connectivity/CellularInterface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Only valid when **Case 4** is applicable.
182182

183183
Only valid when **Case 1** is applicable.
184184

185-
- This is the most complex case - the bulk of the work is implementing the <a href="/docs/v5.6/reference/network-socket-overview.html" target="_blank">NSAPI socket and network interfaces</a>. The driver implementation derives from `CellularBase` to provide both the `NetworkInterface API` and the standard cellular API. Further layering to abstract connection type may be appropriate, as for the PPP case.
185+
- This is the most complex case - the bulk of the work is implementing the <a href="/docs/v5.7/reference/network-socket-overview.html" target="_blank">NSAPI socket and network interfaces</a>. The driver implementation derives from `CellularBase` to provide both the `NetworkInterface API` and the standard cellular API. Further layering to abstract connection type may be appropriate, as for the PPP case.
186186

187187
- Use a file handle, such as `UARTSerial`, to provide the raw data connection; then you can use `ATCmdParser` to handle connection logic and the data flow of the socket API, assuming that you use AT commands to control the sockets.
188188

@@ -210,4 +210,4 @@ Once you have your target and driver port ready, you can verify your implementat
210210
mbed test -n YOUR_TEST_SUITE_NAME
211211
```
212212

213-
For more information on the `mbed-greentea` testing suite, please visit <a href="/docs/v5.6/tools/greentea.html" target="_blank">its documentation</a>.
213+
For more information on the `mbed-greentea` testing suite, please visit <a href="/docs/v5.7/tools/greentea.html" target="_blank">its documentation</a>.

docs/reference/contributing/connectivity/MeshInterface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Mbed OS port of Nanostack consist of a few helper modules that provide easie
1212

1313
![Nanostack inside Mbed OS](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/nanostack_in_mbed_OS.png)
1414

15-
- <a href="/docs/v5.6/reference/mesh.html" target="_blank">Mbed Mesh API</a> controls and initializes Nanostack on Mbed OS.
15+
- <a href="/docs/v5.7/reference/mesh.html" target="_blank">Mbed Mesh API</a> controls and initializes Nanostack on Mbed OS.
1616
- Security settings.
1717
- Channel configuration.
1818
- Connection and reconnection logic.
@@ -32,7 +32,7 @@ In Mbed OS, Socket API hides the differences between the networking stacks. User
3232

3333
For an example of a simple application using Nanostack, see <a href="https://github.com/ARMmbed/mbed-os-example-mesh-minimal" target="_blank">Example mesh application for Mbed OS</a>.
3434

35-
For more information, see the <a href="/docs/v5.6/reference/network-socket-overview.html" target="_blank">documentation of the Socket API</a>.
35+
For more information, see the <a href="/docs/v5.7/reference/network-socket-overview.html" target="_blank">documentation of the Socket API</a>.
3636

3737
##### Providing RF driver for Mbed OS applications
3838

docs/reference/contributing/connectivity/NetworkStack.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The Network-Socket-API (NSAPI) provides a TCP/UDP API on top of any IP based net
44

55
#### Class hierarchy
66

7-
All network-socket API implementations inherit from two classes: a [NetworkStack](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_network_stack.html) and a communication specific subclass of [NetworkInterface](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_network_interface.html).
7+
All network-socket API implementations inherit from two classes: a [NetworkStack](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_network_stack.html) and a communication specific subclass of [NetworkInterface](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_network_interface.html).
88

99
##### NetworkInterface Class
1010

11-
The current NetworkInterface subclasses are [CellularInterface](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_cellular_interface.html), [EthernetInterface](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_ethernet_interface.html), [MeshInterface](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_mesh_interface.html) and [WiFiInterface](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_wi_fi_interface.html). Your communication interface is a subclass of one of these, as well as the NetworkStack. For example, the [ESP8266Interface](https://github.com/ARMmbed/esp8266-driver) inheritance structure looks like this:
11+
The current NetworkInterface subclasses are [CellularInterface](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_cellular_interface.html), [EthernetInterface](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_ethernet_interface.html), [MeshInterface](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_mesh_interface.html) and [WiFiInterface](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_wi_fi_interface.html). Your communication interface is a subclass of one of these, as well as the NetworkStack. For example, the [ESP8266Interface](https://github.com/ARMmbed/esp8266-driver) inheritance structure looks like this:
1212

1313
![Class](/img/esp-class.png)
1414

@@ -23,7 +23,7 @@ Each subclass has distinct pure virtual methods. Visit their class references (l
2323

2424
`NetworkStack` provides a common interface that hardware shares. By implementing the NetworkStack, you can use a class as a target for instantiating network sockets.
2525

26-
`NetworkStack` provides [these functions](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_network_stack.html). Look for the function signature like [`declarator virt-specifier(optional) = 0`](http://en.cppreference.com/w/cpp/language/abstract_class) to determine which functions are pure virtual and which you must override in your child class.
26+
`NetworkStack` provides [these functions](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_network_stack.html). Look for the function signature like [`declarator virt-specifier(optional) = 0`](http://en.cppreference.com/w/cpp/language/abstract_class) to determine which functions are pure virtual and which you must override in your child class.
2727

2828
#### Errors
2929

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 <a href="/docs/v5.6/reference/guidelines.html#style" target="_blank">contributing code</a> for style and ABI requirements.
5+
Please see the contributing guide's section on <a href="/docs/v5.7/reference/guidelines.html#style" target="_blank">contributing code</a> for style and ABI requirements.

docs/reference/contributing/guidelines/design_guidelines.md

Lines changed: 4 additions & 4 deletions
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 <a href="/docs/v5.6/reference/guidelines.html#style" target="_blank">Mbed style guide</a>.
12+
Please refer to the <a href="/docs/v5.7/reference/guidelines.html#style" target="_blank">Mbed style guide</a>.
1313

1414
#### Organization
1515

@@ -56,7 +56,7 @@ The Arm Mbed OS codebase is organized into conceptual submodules to limit the sc
5656
- Special directories should follow consistent naming convention.
5757
5858
#### Contribution
59-
1. Please refer to the <a href="/docs/v5.6/reference/contributing-overview.html" target="_blank">Mbed contribution guide</a>.
59+
1. Please refer to the <a href="/docs/v5.7/reference/contributing-overview.html" target="_blank">Mbed contribution guide</a>.
6060
1. Each pull request should serve a single purpose.
6161
1. The code must compile every commit.
6262
1. Commit message should be prefixed with the submodule name and a colon:
@@ -174,7 +174,7 @@ A general module can be split into two APIs, the frontend (or user API) and the
174174
- Tests included in the codebase must be compatible with the Mbed OS test framework.
175175
- To avoid regressions, every bug fix should include an additional test case that identifies the bug and deterministically fails before the bug is fixed.
176176
177-
<a href="/docs/v5.6/tools/test-and-debug.html" target="_blank">Full documentation</a>.
177+
<a href="/docs/v5.7/tools/test-and-debug.html" target="_blank">Full documentation</a>.
178178
179179
#### Configuration
180180
@@ -188,4 +188,4 @@ Mbed OS provides a powerful configuration system for application development. Ho
188188
- Targets and applications should be able to override each configuration.
189189
- The default choice of optimization should be size, on all platforms.
190190
191-
<a href="/docs/v5.6/tools/the-configuration-system.html" target="_blank">Full documentation</a>.
191+
<a href="/docs/v5.7/tools/the-configuration-system.html" target="_blank">Full documentation</a>.

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 <a href="/docs/v5.6/reference/guidelines.html#cla" target="_blank">CLA</a> and <a href="/docs/v5.6/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 <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>
66

77
#### Code acceptance
88

9-
<a href="/docs/v5.6/reference/guidelines.html#cla" target="_blank">After the CLA</a> 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+
<a href="/docs/v5.7/reference/guidelines.html#cla" target="_blank">After the CLA</a> 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: 3 additions & 3 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.6/reference/guidelines.html#style" target="_blank">code style guide and GitHub pull request guidelines</a>. Please also read the <a href="/docs/v5.6/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 <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.
66

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

@@ -22,15 +22,15 @@ All Mbed OS is on GitHub; please use GitHub's <a href="https://guides.github.com
2222

2323
##### Bug fixes
2424

25-
Please refer to the <a href="/docs/v5.6/reference/guidelines.html#style" target="_blank">code contributions chapter</a>.
25+
Please refer to the <a href="/docs/v5.7/reference/guidelines.html#style" target="_blank">code contributions chapter</a>.
2626

2727
A member of the Mbed team must verify bug fixes before we pull the fixes into the main branch. You must therefore use GitHub to fork the repo and then submit a pull request with your changes.
2828

2929
The last line in your commit message description should say “Fixes #deadbeef”, where “deadbeef” is the issue number in GitHub. This allows GitHub to automatically close the issue when the commit is merged into the default branch.
3030

3131
#### Further reading
3232

33-
Please see the <a href="/docs/v5.6/reference/guidelines.html#style" target="_blank">code contributions chapter</a> for the guidelines to GitHub pull requests and the coding style guide.
33+
Please see the <a href="/docs/v5.7/reference/guidelines.html#style" target="_blank">code contributions chapter</a> for the guidelines to GitHub pull requests and the coding style guide.
3434

3535
#### Guidelines for GitHub pull requests
3636

docs/reference/contributing/storage/BlockDevice.md

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

55
#### BlockDevice class reference
66

7-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_block_device.html)
7+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_block_device.html)
88

99
<a href="https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/BlockDevice.h" target="_blank">C++ API Reference</a>
1010

docs/reference/contributing/storage/FileSystem.md

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

55
#### File system class reference
66

7-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/classmbed_1_1_file_system.html)
7+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/classmbed_1_1_file_system.html)
88

99
#### Assumptions
1010

docs/reference/contributing/target/entropy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Both of the above options are secure if done properly, and depending on the plat
134134

135135
This option is very dangerous because compiling with it results in a build that is not secure! You have to let Mbed TLS know that you are using it deliberately and you are aware of the consequences. That is why you have to turn off any entropy sources explicitly first.
136136

137-
Because it is a very dangerous option and no one should use it in production, we recommend you limit its scope as much as possible; you should apply these settings to the application specific configuration file, instead of the target related configuration as we did it above. You can read more about <a href="/docs/v5.6/tools/adding-and-configuring-targets.html" target="_blank">how to add a macro for your application</a>.
137+
Because it is a very dangerous option and no one should use it in production, we recommend you limit its scope as much as possible; you should apply these settings to the application specific configuration file, instead of the target related configuration as we did it above. You can read more about <a href="/docs/v5.7/tools/adding-and-configuring-targets.html" target="_blank">how to add a macro for your application</a>.
138138

139139
To turn the unsafe testing mode on:
140140

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.6/tools/adding-and-configuring-targets.html" target="_blank">Adding and configuring targets</a> describes to support these exporters.
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.
2424

2525
#### uVision
2626
<a href="https://github.com/ARMmbed/mbed-os/blob/master/tools/export/uvision/uvision.tmpl#L15" target="_blank">uVision project file template</a> 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.

docs/reference/contributing/target/flash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Bootloader-ready declaration of flash VTOR address:
6161

6262
#### `targets.json` metadata
6363

64-
The managed and unmanaged bootloader builds require some target metadata from CMSIS Packs. Add a `"device_name"` attribute to your target as <a href="https://os.mbed.com/docs/v5.6/tools/adding-and-configuring-targets.html" target="_blank">Adding and configuring targets</a> describes.
64+
The managed and unmanaged bootloader builds require some target metadata from CMSIS Packs. 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.
6565

6666
#### Start application
6767

0 commit comments

Comments
 (0)