Skip to content

Commit 8fe3f93

Browse files
author
AnotherButler
committed
Fix links in examples
Fix links that point to reorganized mbed-os-examples-docs_only, so the engine builds
1 parent 8b00e69 commit 8fe3f93

16 files changed

+22
-23
lines changed

docs/api/rtos/EventFlags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ The EventFlags class provides a mechanism for setting and waiting for specific c
1010

1111
## EventFlags example
1212

13-
[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/EventFlags)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/EventFlags/main.cpp)
13+
[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/EventFlags)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/EventFlags/main.cpp)

docs/api/rtos/EventQueue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To do this, set the `mbed_app.json` configuration option `events.shared-dispatch
6161

6262
Use static EventQueue to prevent your program from failing due to queue memory exhaustion or to prevent dynamic memory allocation:
6363

64-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/main.cpp)
64+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1/main.cpp)
6565

6666
## Related content
6767

docs/api/rtos/UserAllocatedEvent.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ The UserAllocatedEvent class is thread safe. The `call`, `try_call` and `cancel`
2121

2222
This example demonstrates how you can instantiate, configure and post events:
2323

24-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/main.cpp)
25-
24+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1/main.cpp)
2625

2726
## Related content
2827

docs/api/security/Devicekey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ Run the DeviceKey functionality test with the `mbed` command as following:
5555

5656
## DeviceKey example
5757

58-
[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/DeviceKey)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/DeviceKey/main.cpp)
58+
[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Security/DeviceKey)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Security/DeviceKey/main.cpp)

docs/api/storage/BlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ For details regarding how to configure the default block device please refer to
4242

4343
## BlockDevice example
4444

45-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/BlockDevice/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/BlockDevice/main.cpp)
45+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/BlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/BlockDevice/main.cpp)
4646

4747
## Related content
4848

docs/api/storage/FlashIAPBlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To configure this class, please see our [BlockDevice configuration documentation
1717

1818
## FlashIAPBlockDevice example
1919

20-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/FlashIAPBlockDevice/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/FlashIAPBlockDevice/main.cpp)
20+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/FlashIAPBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/FlashIAPBlockDevice/main.cpp)
2121

2222
## Related content
2323

docs/api/storage/MBRBlockDevice.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ You can view more information about the configurable settings and functions in t
1919

2020
Partition a heap backed block device into two partitions. This example also uses the [HeapBlockDevice](heapblockdevice.html).
2121

22-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/MBRBlockDevice/MBRBlockDevice_ex_1/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/MBRBlockDevice/MBRBlockDevice_ex_1/main.cpp)
22+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/MBRBlockDevice_ex_1)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/MBRBlockDevice_ex_1/main.cpp)
2323

2424
Partition an SD card, and format the new partition with a FAT filesystem. A PC will now be able to recognize the SD card.
2525

26-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/MBRBlockDevice/MBRBlockDevice_ex_2/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/MBRBlockDevice/MBRBlockDevice_ex_2/main.cpp)
26+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/MBRBlockDevice_ex_2)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/MBRBlockDevice_ex_2/main.cpp)
2727

2828
## Related content
2929

docs/api/storage/ProfilingBlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To configure this class, please see our [BlockDevice configuration documentation
1616

1717
Create a ProfilingBlockDevice, perform storage operations and report back the read, write and erase counts.
1818

19-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/ProfilingBlockDevice/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/ProfilingBlockDevice/main.cpp)
19+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/ProfilingBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/ProfilingBlockDevice/main.cpp)
2020

2121
## Related content
2222

docs/api/storage/SDBlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ There is a difference between `erase` as usually defined for SD cards and the de
7676

7777
## SDBlockDevice example application
7878

79-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/SDBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/SDBlockDevice/main.cpp)
79+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SDBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SDBlockDevice/main.cpp)
8080

8181
## Related content
8282

docs/api/storage/SPIFBlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To configure this class, please see our [BlockDevice configuration documentation
1616

1717
## SPIFBlockDevice example
1818

19-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/SPIFBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/SPIFBlockDevice/main.cpp)
19+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SPIFBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SPIFBlockDevice/main.cpp)
2020

2121
## Related content
2222

docs/api/storage/SlicingBlockDevice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To configure this class, please see our [BlockDevice configuration documentation
2020

2121
This SlicingBlockDevice example partitions a [HeapBlockDevice](heapblockdevice.html) into three subunits and showcases programming and reading back data segments through both the underlying master block device and the sliced subunits.
2222

23-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/SlicingBlockDevice/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/blockdevices/SlicingBlockDevice/main.cpp)
23+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SlicingBlockDevice)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_Storage/SlicingBlockDevice/main.cpp)
2424

2525
## Related content
2626

docs/api/usb/USBCDC_ECM.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ The example below sends an Ethernet frame that carries "Hello world" payload wit
2323
5. Click captured packet from source address 12:34:56:78:9a:bc to see the "Hello world" payload.
2424

2525

26-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/USB/USBCDC_ECM)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/USB/USBCDC_ECM/main.cpp)
26+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_USB/USBCDC_ECM)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_USB/USBCDC_ECM/main.cpp)

docs/porting/porting_full_process/porting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Detailed instructions for porting each module are given in the module-specific s
177177
178178
The official `mbed-os-example-blinky` uses the RTOS, a DigitalOut object and timers. The bare metal version of the example doesn't rely on RTOS, GPIO and timers; LED toggling is done directly by accessing hardware registers. Modify the Blinky program you checked out earlier to not use the timer and DigitalOut object:
179179
180-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Direct-Register-Blinky/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Direct-Register-Blinky/main.cpp)
180+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Porting_process/Direct-Register-Blinky)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Porting_process/Direct-Register-Blinky/main.cpp)
181181
182182
## Bootstrap and entry point
183183
@@ -191,7 +191,7 @@ Mbed OS uses CMSIS for bootstrap. If your target doesn't have a CMSIS implementa
191191
C:\Keil_v5\ARM\PACK\ARM\CMSIS\5.3.0\Device\_Template_Vendor\Vendor\Device\Source
192192
C:\Keil_v5\ARM\PACK\ARM\CMSIS\5.3.0\Device\_Template_Vendor\Vendor\Device\Include
193193
```
194-
194+
195195
1. Create linker scripts from the templates.
196196
197197
1. Implement pin mapping and basic peripheral initialization code.

docs/tutorials/using_apis/alarm-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ cd mbed-os-example-alarm
1515

1616
If using the Mbed Online Compiler, use the **Import into Mbed IDE" button below:
1717

18-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Alarm)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Alarm/main.cpp)
18+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Alarm)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Alarm/main.cpp)
1919

2020
### Compile
2121

docs/tutorials/using_apis/events_tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,4 @@ This is only a small part of how event queues work in Mbed OS. The `EventQueue`,
158158

159159
The EventQueue API provides a mechanism for creating a static queue, a queue that doesn't use any dynamic memory allocation and accepts only user-allocated events. After you create a static queue (by passing zero as `size` to its constructor), you can post `UserAllocatedEvent` to it. Using static EventQueue combined with UserAllocatedEvent ensures no dynamic memory allocation will take place during queue creation and events posting and dispatching. You can also declare queues and events as static objects (static in the C++ sense), and then memory for them will be reserved at compile time:
160160

161-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/events/static-event-queue/UserAllocatedEvent_ex_1/main.cpp)
161+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/APIs_RTOS/UserAllocatedEvent_ex_1/main.cpp)

docs/tutorials/using_apis/flow_control.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If we want to automatically blink an LED, we have three main techniques:
1414

1515
Busy wait is a method that blocks the processor for a period of time. This is an effective way to create time delays, but it’s inefficient because it wastes processor time and keeps the processor running at full power for the duration of the wait:
1616

17-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/Flow-Control/Busy-Wait)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Flow-Control/Busy-Wait/main.cpp)
17+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Busy-Wait)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Busy-Wait/main.cpp)
1818

1919
Notice `printf()`; you can enable this by uncommenting the line (remove the `//`). `printf()` prints to the terminal, so you can use it to get debug information.
2020

@@ -26,13 +26,13 @@ Tickers and timers are another way of creating a time interval. These methods ar
2626

2727
Here is an example that doesn't include sleeping:
2828

29-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/Flow-Control/Ticker)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Flow-Control/Ticker/main.cpp)
29+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Ticker)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Ticker/main.cpp)
3030

3131
### Thread
3232

3333
Threads are the most efficient way to blink an LED. During the waiting period, it is possible to take advantage of Mbed OS optimizations to automatically conserve power and deal with other tasks. While this is not the most visually appealing method, nor the simplest, it is the preferred way for large scale deployments:
3434

35-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/Flow-Control/Thread)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Flow-Control/Thread/main.cpp)
35+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Thread)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Thread/main.cpp)
3636

3737
## Flow control for manual actions
3838

@@ -44,7 +44,7 @@ We can wait for digital input the same way we waited for time to pass - using a
4444

4545
<span class="tips">**Tip:** You may need to change the `SW1` pin, as the button on your board may be called something else. Please refer to the pinmap on the [boards page](https://os.mbed.com/platforms/).</span>
4646

47-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/Flow-Control/Busy-Wait-Button)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Flow-Control/Busy-Wait-Button/main.cpp)
47+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Busy-Wait-Button)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Busy-Wait-Button/main.cpp)
4848

4949
We constantly poll the button to see whether it has a value that matches `button_press`. If it matches, we toggle the LED and wait 1 second.
5050

@@ -54,7 +54,7 @@ We constantly poll the button to see whether it has a value that matches `button
5454

5555
An alternative way to poll the button is to use an interrupt. Interrupts let you say `when that pin changes value, call this function`. In other words, we can tell the MCU to call a function when the button is pressed. In our case, that function toggles the LED:
5656

57-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/tree/master/Flow-Control/Interrupt-Button)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Flow-Control/Interrupt-Button/main.cpp)
57+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Interrupt-Button)](https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/Tutorials_UsingAPIs/Flow-Control-Interrupt-Button/main.cpp)
5858

5959
In the code above a heartbeat function runs on LED2, which lets you see that your code is running. Then we connect an InterruptIn object to the button and set it so that when the button rises from 0 to 1, the toggle function is called; the function toggles LED1. This way we can turn the LED on and off as needed, without needing to “waste” our time waiting or actively polling an inactive button. We (or rather - the MCU) are free to move on to other things .
6060

0 commit comments

Comments
 (0)