Skip to content

Commit 1a02329

Browse files
Irit ArkinIrit Arkin
authored andcommitted
Replacing links in 5.5 branch
1 parent e605f5f commit 1a02329

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

docs/APIs/intro.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,4 @@ Once you're familiar with the basic concepts, you can move on to more advanced e
1212
* [Building a LoRa network](https://docs.mbed.com/docs/lora-with-mbed/en/latest/).
1313
* Or any of the other examples [on our full list](https://docs.mbed.com/docs/examples-list/en/latest/).
1414

15-
<span class="tips">The full API references are [here](https://docs.mbed.com/docs/mbed-os-api-reference/). The [doxygen is here](https://docs.mbed.com/docs/mbed-os-api/en/mbed-os-5.4/api/index.html).</span>
16-
15+
<span class="tips">The full API references are [here](https://docs.mbed.com/docs/mbed-os-api-reference/). The [doxygen is here](https://docs.mbed.com/docs/mbed-os-api/en/mbed-os-5.5/api/index.html).</span>

docs/advanced/MINAR_migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If you don't like asynchronous programming, or if you wrote your code in asynchr
6060

6161
## Porting strategy 2: use the optional mbed OS 5 event loop
6262

63-
To help ease porting MINAR applications, and to provide support for asynchronous style programming, mbed OS 5 provides an optional event loop. The main documentation for the event loop can be found [here](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.4/APIs/tasks/events/). In short, the mbed OS 5 event loop implementation consists of an [EventQueue class](https://github.com/ARMmbed/mbed-os/blob/master/events/EventQueue.h) that implements the storage for the events and has a `dispatch` function. There are differences between MINAR and `EventQueue`:
63+
To help ease porting MINAR applications, and to provide support for asynchronous style programming, mbed OS 5 provides an optional event loop. The main documentation for the event loop can be found [here](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.5/APIs/tasks/events/). In short, the mbed OS 5 event loop implementation consists of an [EventQueue class](https://github.com/ARMmbed/mbed-os/blob/master/events/EventQueue.h) that implements the storage for the events and has a `dispatch` function. There are differences between MINAR and `EventQueue`:
6464

6565
- MINAR and the mbed OS 5 event loop have incompatible APIs.
6666
- Both MINAR and `EventQueue` work with *events* (objects that are placed in the event queue). However, the interface and implementations of events in MINAR and mbed OS 5 are different, and that's also true for the APIs that use them. Look at [the Callback class](https://docs.mbed.com/docs/mbed-os-api/en/mbed-os-5.3/api/group__drivers.html), [the Event class](https://github.com/ARMmbed/mbed-os/blob/master/events/Event.h) and [the EventQueue class](https://github.com/ARMmbed/mbed-os/blob/master/events/EventQueue.h) for more details about the mbed OS 5 implementation.
@@ -71,7 +71,7 @@ To help ease porting MINAR applications, and to provide support for asynchronous
7171

7272
Even if you choose to use the mbed OS 5 event loop, the RTOS is always present, so you need to consider all the RTOS-specific issues (such as synchronization).
7373

74-
If you want to keep the asynchronous aspect of your mbed OS 3 application, the best way to proceed is to read the [documentation of the mbed OS event loop](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.4/APIs/tasks/events/) and rewrite your application using the new APIs. Here are some rough API compatibility guides:
74+
If you want to keep the asynchronous aspect of your mbed OS 3 application, the best way to proceed is to read the [documentation of the mbed OS event loop](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.5/APIs/tasks/events/) and rewrite your application using the new APIs. Here are some rough API compatibility guides:
7575

7676
- You can replace the MINAR function `postCallback` with `EventQueue::call`.
7777
- You can replace the MINAR function `delay` with `EventQueue::call_in`.

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction to the mbed OS 5 Handbook
22

3-
Welcome to the mbed OS 5 handbook.
3+
Welcome to the mbed OS 5 handbook.
44

55
If you’re an experienced mbed applications developer, you might want to dive straight into the [API References](https://docs.mbed.com/docs/mbed-os-api-reference/en/) or look at our [development tools documentation](dev_tools/options.md).
66

@@ -10,7 +10,7 @@ If you're new to all this, continue reading.
1010

1111
mbed OS lets you write applications that run on embedded devices, by providing the layer that interprets your application's code in a way the hardware can understand.
1212

13-
Your application code is written in C++. It uses the *application programming interfaces* (APIs) that mbed OS provides. These APIs allow your code to work on different microcontrollers in a uniform way. This reduces a lot of the challenges in getting started with microcontrollers and integrating large amounts of software.
13+
Your application code is written in C++. It uses the *application programming interfaces* (APIs) that mbed OS provides. These APIs allow your code to work on different microcontrollers in a uniform way. This reduces a lot of the challenges in getting started with microcontrollers and integrating large amounts of software.
1414

1515
### Where to start
1616

@@ -22,7 +22,7 @@ When you know how to build an existing application, it's time to learn [how to w
2222

2323
### Development tools
2424

25-
* Our offline development tool is the [mbed CLI](dev_tools/cli.md), a command-line tool. This requires having a toolchain installed on your computer.
25+
* Our offline development tool is the [mbed CLI](dev_tools/cli.md), a command-line tool. This requires having a toolchain installed on your computer.
2626
* The [mbed Online Compiler](dev_tools/online_comp.md) lets you write and build applications using just a web browser and USB connection.
2727
* If you're working with third party tools, look at [exporting instructions for the most popular ones](dev_tools/third_party.md).
2828

@@ -46,7 +46,7 @@ When you've started writing applications using your selected development tool:
4646

4747
If you want to contribute to the mbed OS codebase, please see [the contribution section](cont/contributing.md).
4848

49-
The current version of mbed OS 5 is 5.4.0. It is available on [GitHub](https://github.com/ARMmbed/mbed-os/releases/tag/mbed-os-5.4.0).
49+
The current version of mbed OS 5 is 5.5.0. It is available on [GitHub](https://github.com/ARMmbed/mbed-os/releases/tag/mbed-os-5.5.0).
5050

5151
## Porting to mbed OS
5252

0 commit comments

Comments
 (0)