Skip to content

Commit aadff01

Browse files
iriark01iriark01
committed
Some comments from Wen
Not fully implemented, but enough so she can use it when testing
1 parent 24923e7 commit aadff01

File tree

3 files changed

+89
-73
lines changed

3 files changed

+89
-73
lines changed

‎docs.json

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"branch": "master"
1212
},
1313
{
14-
"title": "Mbed OS 6",
14+
"title": "Introduction to Mbed OS 6",
1515
"description": "Introducing Mbed OS: the overview, architecture, features and licensing",
1616
"slug": "introduction",
1717
"type": "markdown",
@@ -39,6 +39,25 @@
3939
"introduction"
4040
]
4141
},
42+
{
43+
"title": "Mbed OS bare metal profile",
44+
"description": "",
45+
"slug": "bare-metal",
46+
"type": "markdown",
47+
"sources": [{
48+
"path": "docs/program-setup/bare_metal/bare_metal.md"
49+
},
50+
{
51+
"path": "docs/program-setup/bare_metal/bare_metal_api.md"
52+
},
53+
{
54+
"path": "docs/program-setup/bare_metal/baremetal_example.md"
55+
},
56+
{
57+
"path": "docs/program-setup/bare_metal/c_small_libs.md"
58+
}
59+
]
60+
},
4261
{
4362
"title": "Quick start",
4463
"description": "Guide to getting started using Mbed OS",
@@ -104,7 +123,16 @@
104123
]
105124
},
106125
{
107-
"title": "APIs",
126+
"title": "Tutorials",
127+
"description": "",
128+
"slug": "tutorials",
129+
"type": "markdown",
130+
"sources": [{
131+
"path": "docs/introduction/tutorials_intro.md"
132+
}]
133+
},
134+
{
135+
"title": "API references, configurations and tutorials",
108136
"description": "",
109137
"slug": "apis",
110138
"type": "markdown",
@@ -393,8 +421,7 @@
393421
"intro": {
394422
"path": "docs/api/networking-arch.md"
395423
},
396-
"sources": [
397-
{
424+
"sources": [{
398425
"path": "docs/api/networkinterfaces/ethernet-arch.md"
399426
},
400427
{
@@ -404,7 +431,7 @@
404431
"path": "docs/api/networkinterfaces/cellular-arch.md"
405432
},
406433
{
407-
"path": "docs/api/networkinterfaces/mesh-arch/thread_intro.md"
434+
"path": "docs/api/networkinterfaces/mesh-arch/thread_intro.md"
408435
},
409436
{
410437
"path": "docs/api/networkinterfaces/mesh-arch/wisun_intro.md"
@@ -831,9 +858,6 @@
831858
"type": "markdown",
832859
"chapters": [{
833860
"title": "Concepts",
834-
"intro": {
835-
"path": "docs/program-setup/reference.md"
836-
},
837861
"sources": [{
838862
"path": "docs/program-setup/runtime/Execution.md"
839863
},
@@ -853,8 +877,7 @@
853877
},
854878
{
855879
"title": "Serial communication",
856-
"sources": [
857-
{
880+
"sources": [{
858881
"path": "docs/program-setup/serial/serial_communication.md"
859882
},
860883
{
@@ -1105,25 +1128,6 @@
11051128
}
11061129
]
11071130
},
1108-
{
1109-
"title": "Mbed OS bare metal",
1110-
"description": "",
1111-
"slug": "bare-metal",
1112-
"type": "markdown",
1113-
"sources": [{
1114-
"path": "docs/program-setup/bare_metal/bare_metal.md"
1115-
},
1116-
{
1117-
"path": "docs/program-setup/bare_metal/bare_metal_api.md"
1118-
},
1119-
{
1120-
"path": "docs/program-setup/bare_metal/baremetal_example.md"
1121-
},
1122-
{
1123-
"path": "docs/program-setup/bare_metal/c_small_libs.md"
1124-
}
1125-
]
1126-
},
11271131
{
11281132
"title": "Contributing",
11291133
"description": "Guide to contributing to Mbed OS source code and documentation and information about contribution workflow and licensing",

‎docs/api/api.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,3 +327,11 @@ With [Arm Mbed TLS](security.html), a comprehensive SSL/TLS solution, you can in
327327
</tr>
328328
</tbody>
329329
</table>
330+
331+
## Deprecated APIs
332+
333+
Some Mbed OS 5 APIs are not supported in Mbed OS 6, and you'll need to replace them in your code.
334+
335+
| Deprecated API | Replaced by |
336+
| - | - |
337+
| Serial | [BufferedSerial](../apis/bufferedserial.html), [UnbufferedSerial](../apis/unbufferedserial.html) |

‎docs/api/tutorials_intro.md renamed to ‎docs/introduction/tutorials_intro.md

Lines changed: 48 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,26 @@ The Arm Mbed ecosystem is expansive and offers many opportunities. In contrast t
1010

1111
These tutorials and examples show you how to perform specific tasks that use the Arm Mbed APIs:
1212

13-
### Using platform APIs
1413

15-
| API | Examples |
16-
| --- | --- |
17-
| Callback | [Serial passthrough example](../apis/callback.html#serial-passthrough-example-with-callbacks)<br> [Thread example](../apis/callback.html#thread-example-with-callbacks)<br> [Sonar example](../apis/callback.html#sonar-example) |
18-
| DeepSleepLock | [DeepSleepLock example](../apis/deepsleeplock.html#example) |
19-
| PowerManagement | [PowerManagement example](../apis/power-management-sleep.html#example) |
20-
| IdleLoop | [IdleLoop example](../apis/idle-loop.html#example) |
21-
| CriticalSectionLock | [CriticalSectionLock example](../apis/criticalsectionlock.html#criticalsectionlock-example) |
22-
| Time | [Time example](../apis/time.html#time-example) |
23-
| RTC | [RTC example](../apis/rtc.html#rtc-time-example) |
24-
| Debug | [Debug example](../apis/debug.html#debug-example) |
25-
| Memory tracing | [Memory tracing example](../apis/memory-tracing.html#memory-tracing-example) |
26-
| Error handling | [Error handling example](../apis/error-handling.html#error-handling-example)<br> [Crash reporting example](../apis/error-handling.html#crash-reporting-example) |
27-
| Assert | [Assert example](../apis/assert.html#assert-example) |
28-
| NonCopyable | [NonCopyable example](../apis/noncopyable.html#noncopyable-example) |
29-
| SharedPtr | [Shared pointer example](../apis/shared-pointer.html#shared-pointer-example) |
30-
| Span | [Span example](../apis/span.html#span-example) |
31-
| FileHandle | [C library example](../apis/filehandle.html#filehandle-using-c-library-example)<br> [Sigio example](../apis/filehandle.html#filehandle-sigio-example) |
32-
| Poll | [Poll example](../apis/poll.html#poll-example) |
33-
| PlatformMutex | [PlatformMutex example](../apis/platformmutex.html#platformmutex-example) |
34-
| CircularBuffer | [CircularBuffer example](../apis/circularbuffer.html#circularbuffer-example) |
35-
| ATCmdParser | [ATCmdParser example](../apis/atcmdparser.html#atcmdparser-examples) |
36-
| Mbed statistics | [Memory statistics example](../apis/mbed-statistics.html#memory-statistics-example) <br> [Thread statistics example](../apis/mbed-statistics.html#thread-statistics-example) <br> [System information example](../apis/mbed-statistics.html#system-information-example) <br> [CPU statistics example](../apis/mbed-statistics.html#cpu-statistics-example)|
37-
| MPU management | [MPU management example](../apis/mpu-management.html#example) |
38-
| ScopedRamExecutionLock | [ScopedRamExecutionLock](../apis/scopedramexecutionlock.html#example) |
39-
| ScopedRomWriteLock | [ScopedRomWriteLock example](../apis/scopedromwritelock.html#scopedromwritelock-class-reference) |
14+
### Using RTOS APIs
15+
16+
| API | Examples | Tutorials |
17+
| --- | --- | --- |
18+
| EventQueue | [Chaining events from more than one queue](../apis/eventqueue.html#eventqueue-example-chaining-events-from-more-than-one-queue)<br> [Deferring from interrupt context](../apis/eventqueue.html#eventqueue-example-deferring-from-interrupt-contextl) <br> [Posting events to the queue](../apis/eventqueue.html#eventqueue-example-posting-events-to-the-queue) <br> [Shared event: deferring from interrupt context](../apis/eventqueue.html#shared-event-example-running-the-shared-queue-from-main)<br> [Shared event: running the shared queue from main](../apis/eventqueue.html#shared-event-example-running-the-shared-queue-from-main)<br> [Static event queue example](../apis/eventqueue.html#static-eventqueue-example-posting-user-allocated-events-to-the-static-queue) | [EventQueue tutorial](the-eventqueue-api.html)|
19+
| UserAllocatedEvent | [Static event queue example](../apis/userallocatedevent.html#static-eventqueue-example-posting-user-allocated-events-to-the-queue) | |
20+
| Mutex | [Mutex example](../apis/mutex.html#mutex-example) | |
21+
| MemoryPool | [MemoryPool example](../apis/memorypool.html#memorypool-example) | |
22+
| Kernel | [Example: get_ms_count()](../apis/kernel-interface-functions.html#get-ms-count-example)<br> [Example: hooks](../apis/kernel-interface-functions.html#kernel-hooks-example) | |
23+
| Thread | [Thread example](../apis/thread.html#thread-example)<br> [Thread example with callbacks](../apis/thread.html#thread-example-with-callbacks)<br> | |
24+
| ThisThread | [ThisThread example](../apis/thisthread.html#thisthread-example) | |
25+
| Semaphore | [Semaphore example](../apis/semaphore.html#semaphore-example) | |
26+
| Mail | [Mail example](../apis/mail.html#mail-example) | |
27+
| EventFlags | [EventFlags example](../apis/eventflags.html#eventflags-example) | |
28+
| ConditionVariable | [ConditionVariable example](../apis/conditionvariable.html#conditionvariable-example) | |
29+
| Queue | [Queue example](../apis/queue.html#queue-example) <br> [Queue and MemoryPool](../apis/queue.html#queue-and-memorypool-example)| |
30+
4031

41-
### Using drivers APIs
32+
### Using Input/Output (I/O) APIs
4233

4334
| API | Examples | Hello, World |
4435
| --- | --- | --- |
@@ -77,23 +68,6 @@ And the following tutorials:
7768
- [Application flow control](../tutorials/application-flow-control.html)
7869
- [Alarm](../tutorials/alarm-tutorial.html)
7970

80-
### Using RTOS APIs
81-
82-
| API | Examples | Tutorials |
83-
| --- | --- | --- |
84-
| EventQueue | [Chaining events from more than one queue](../apis/eventqueue.html#eventqueue-example-chaining-events-from-more-than-one-queue)<br> [Deferring from interrupt context](../apis/eventqueue.html#eventqueue-example-deferring-from-interrupt-contextl) <br> [Posting events to the queue](../apis/eventqueue.html#eventqueue-example-posting-events-to-the-queue) <br> [Shared event: deferring from interrupt context](../apis/eventqueue.html#shared-event-example-running-the-shared-queue-from-main)<br> [Shared event: running the shared queue from main](../apis/eventqueue.html#shared-event-example-running-the-shared-queue-from-main)<br> [Static event queue example](../apis/eventqueue.html#static-eventqueue-example-posting-user-allocated-events-to-the-static-queue) | [EventQueue tutorial](the-eventqueue-api.html)|
85-
| UserAllocatedEvent | [Static event queue example](../apis/userallocatedevent.html#static-eventqueue-example-posting-user-allocated-events-to-the-queue) | |
86-
| Mutex | [Mutex example](../apis/mutex.html#mutex-example) | |
87-
| MemoryPool | [MemoryPool example](../apis/memorypool.html#memorypool-example) | |
88-
| Kernel | [Example: get_ms_count()](../apis/kernel-interface-functions.html#get-ms-count-example)<br> [Example: hooks](../apis/kernel-interface-functions.html#kernel-hooks-example) | |
89-
| Thread | [Thread example](../apis/thread.html#thread-example)<br> [Thread example with callbacks](../apis/thread.html#thread-example-with-callbacks)<br> | |
90-
| ThisThread | [ThisThread example](../apis/thisthread.html#thisthread-example) | |
91-
| Semaphore | [Semaphore example](../apis/semaphore.html#semaphore-example) | |
92-
| Mail | [Mail example](../apis/mail.html#mail-example) | |
93-
| EventFlags | [EventFlags example](../apis/eventflags.html#eventflags-example) | |
94-
| ConditionVariable | [ConditionVariable example](../apis/conditionvariable.html#conditionvariable-example) | |
95-
| Queue | [Queue example](../apis/queue.html#queue-example) <br> [Queue and MemoryPool](../apis/queue.html#queue-and-memorypool-example)| |
96-
9771
### Using USB APIs
9872

9973
| API | Examples | Tutorials |
@@ -189,6 +163,36 @@ A [private network tutorial](../tutorials/LoRa-tutorial.html) and [an example fo
189163
| SPIFBlockDevice | [SPIFBlockDevice example](../apis/spi-flash-block-device.html#spifblockdevice-example) |
190164
| QSPIFBlockDevice | [QSPIFBlockDevice example](../apis/qspifblockdevice.html#qspifblockdevice-example) |
191165

166+
167+
### Using utility APIs
168+
169+
| API | Examples |
170+
| --- | --- |
171+
| Callback | [Serial passthrough example](../apis/callback.html#serial-passthrough-example-with-callbacks)<br> [Thread example](../apis/callback.html#thread-example-with-callbacks)<br> [Sonar example](../apis/callback.html#sonar-example) |
172+
| DeepSleepLock | [DeepSleepLock example](../apis/deepsleeplock.html#example) |
173+
| PowerManagement | [PowerManagement example](../apis/power-management-sleep.html#example) |
174+
| IdleLoop | [IdleLoop example](../apis/idle-loop.html#example) |
175+
| CriticalSectionLock | [CriticalSectionLock example](../apis/criticalsectionlock.html#criticalsectionlock-example) |
176+
| Time | [Time example](../apis/time.html#time-example) |
177+
| RTC | [RTC example](../apis/rtc.html#rtc-time-example) |
178+
| Debug | [Debug example](../apis/debug.html#debug-example) |
179+
| Memory tracing | [Memory tracing example](../apis/memory-tracing.html#memory-tracing-example) |
180+
| Error handling | [Error handling example](../apis/error-handling.html#error-handling-example)<br> [Crash reporting example](../apis/error-handling.html#crash-reporting-example) |
181+
| Assert | [Assert example](../apis/assert.html#assert-example) |
182+
| NonCopyable | [NonCopyable example](../apis/noncopyable.html#noncopyable-example) |
183+
| SharedPtr | [Shared pointer example](../apis/shared-pointer.html#shared-pointer-example) |
184+
| Span | [Span example](../apis/span.html#span-example) |
185+
| FileHandle | [C library example](../apis/filehandle.html#filehandle-using-c-library-example)<br> [Sigio example](../apis/filehandle.html#filehandle-sigio-example) |
186+
| Poll | [Poll example](../apis/poll.html#poll-example) |
187+
| PlatformMutex | [PlatformMutex example](../apis/platformmutex.html#platformmutex-example) |
188+
| CircularBuffer | [CircularBuffer example](../apis/circularbuffer.html#circularbuffer-example) |
189+
| ATCmdParser | [ATCmdParser example](../apis/atcmdparser.html#atcmdparser-examples) |
190+
| Mbed statistics | [Memory statistics example](../apis/mbed-statistics.html#memory-statistics-example) <br> [Thread statistics example](../apis/mbed-statistics.html#thread-statistics-example) <br> [System information example](../apis/mbed-statistics.html#system-information-example) <br> [CPU statistics example](../apis/mbed-statistics.html#cpu-statistics-example)|
191+
| MPU management | [MPU management example](../apis/mpu-management.html#example) |
192+
| ScopedRamExecutionLock | [ScopedRamExecutionLock](../apis/scopedramexecutionlock.html#example) |
193+
| ScopedRomWriteLock | [ScopedRomWriteLock example](../apis/scopedromwritelock.html#scopedromwritelock-class-reference) |
194+
195+
192196
## Serial communication
193197

194198
These tutorials teach you to communicate with your development board, an essential part of programming and debugging:

0 commit comments

Comments
 (0)