Document update on bare metal supported APIs. #1304
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I will need to make this and #1303 work together |
rajkan01
force-pushed
the
baremetal_update_api
branch
3 times, most recently
from
093f2f0 to
5c7d405
Compare
rajkan01
force-pushed
the
baremetal_update_api
branch
from
5c7d405 to
2db1ed7
Compare
evedon
requested changes
Apr 24, 2020
docs/api/api.md
Outdated
| @@ -1,30 +1,41 @@ | |||
| # Full API list | |||
| <!--these are now just the APIs - do I want to add the tutorials?--> | |||
|
|
|||
| This document lists Mbed OS components supported APIs. In general, it lists both common APIs (RTOS and the bare metal profile supported), and RTOS only supported APIs, but occasionally, It has either one. | |||
There was a problem hiding this comment.
This sentence needs editing.
There was a problem hiding this comment.
- In this context, what does "component" mean?
- What does "it has either one" refer to?
docs/api/api.md
Outdated
| <td><a href="semaphore.html">Semaphore</a></td> | ||
| <td><a href="userallocatedevent.html">UserAllocatedEvent</a></td> | ||
| <td><a href="eventflags.html">EventFlags</a></td> | ||
| <td><a href="kernel-interface-functions.html">Kernel interface functions</a></td> |
There was a problem hiding this comment.
Only get_ms_count is supported in bare metal.
attach_idle_hook & attach_thread_terminate_hook are RTOS only functions.
I think it is better to say that "Kernel interface functions" are RTOS only except for one. Note that you will need doxygen for Kernel.h
There was a problem hiding this comment.
We could add this information in the kernel-interface-functions.html file instead of describe in api.md file.
@iriark01 Could you please suggest
| <tr> | ||
| <th colspan="2">Features/Components</th> | ||
| <th>Mbed OS bare metal</th> | ||
| <th> Mbed OS RTOS</th> |
There was a problem hiding this comment.
This third column is not useful as all APIs are available.
There was a problem hiding this comment.
I will get help from @iriark01 to address this review comment
rajkan01
force-pushed
the
baremetal_update_api
branch
from
7fafd2a to
481be69
Compare
iriark01
suggested changes
Apr 28, 2020
| @@ -4,19 +4,125 @@ There are many use cases for IoT devices. Different use cases require different | |||
|
|
|||
| <span class="images"><span>Mbed OS bare metal profile block digram</span></span> | |||
|
|
|||
| The Mbed OS bare metal profile is a compact profile of Mbed OS without an RTOS. The Mbed OS bare metal profile is API compatible with Mbed OS and supports a subset of Mbed OS features, such as analog I/O, digital I/O, timers and digital interfaces, such as SPI, I2C, Serial and CAN. Mbed Studio, Mbed CLI and the Mbed Online Compiler all support the Mbed OS bare metal profile. | |||
| The Mbed OS bare metal profile is a compact profile of Mbed OS without an RTOS. Most of the Mbed OS APIs are compatible with bare metal profile and below table shows the availability of various Mbed OS features and components on bare metal profile. | |||
There was a problem hiding this comment.
It looks like this list and the general API list have a lot of duplicate content. What is the purpose of this list?
There was a problem hiding this comment.
One is a summary of features, the other is a list of APIs.
| @@ -4,19 +4,125 @@ There are many use cases for IoT devices. Different use cases require different | |||
|
|
|||
There was a problem hiding this comment.
Please note that in PR 1303, I edited the intro to this page.
docs/api/api.md
Outdated
| @@ -1,30 +1,41 @@ | |||
| # Full API list | |||
| <!--these are now just the APIs - do I want to add the tutorials?--> | |||
|
|
|||
| This document lists Mbed OS components supported APIs. In general, it lists both common APIs (RTOS and the bare metal profile supported), and RTOS only supported APIs, but occasionally, It has either one. | |||
There was a problem hiding this comment.
- In this context, what does "component" mean?
- What does "it has either one" refer to?
| @@ -1,30 +1,42 @@ | |||
| # Full API list | |||
| <!--these are now just the APIs - do I want to add the tutorials?--> | |||
|
|
|||
| This document lists Mbed OS components supported APIs. In general, it lists both common APIs (RTOS and the bare metal profile supported), and RTOS only supported APIs, but occasionally, It has either one. | |||
|
|
|||
| ## RTOS and event handling | |||
There was a problem hiding this comment.
- Evelyne, Bartek and Andy have just confirmed that it's "full profile" and "bare metal profile", not "RTOS profile". I will edit this page to reflect that.
- I'm going to talk to the UX team about how best to show which APIs are full profile only, and which are also for bare metal. I think the multiple headers will confuse users.
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
Co-Authored-By: Evelyne Donnaes <[email protected]>
|
@iriark01 to take over using content from this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the documentation on bare metal profile supported APIs.
Reviewers
@evedon @iriark01