Docs: Rename "api" to "lib" #422
Merged
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
This is currently required by the docs.mbed.com engine, which expects Doxygen documentation to be placed in an api folder. Once the website moves to a different engine, we can revert back to "api", if we want to.
iriark01
reviewed
Apr 12, 2017
docs/core/PORTING.md
Outdated
| @@ -280,7 +280,7 @@ $ cd ~/code/uvisor | |||
| $ make | |||
| ``` | |||
|
|
|||
| The build process generates as many static libraries (`*.a` files) as your family configurations, multiplied by two (debug and release builds). You can find them in `~/code/uvisor/api/lib/${family}`. Please note that these libraries are not published in the uVisor repository. Instead, the glue-layer library deploys them and makes them available to the target OS. | |||
| The build process generates as many static libraries (`*.a` files) as your family configurations, multiplied by two (debug and release builds). You can find them in `~/code/uvisor/lib/lib/${family}`. Please note that these libraries are not published in the uVisor repository. Instead, the glue-layer library deploys them and makes them available to the target OS. | |||
There was a problem hiding this comment.
Did you mean to change this one?
There was a problem hiding this comment.
Good catch! Fixed :)
iriark01
reviewed
Apr 12, 2017
docs/lib/manual/UseCases.md
Outdated
| @@ -691,4 +691,4 @@ void example(void) | |||
| ``` | |||
|
|
|||
| ### More information about the RPC API | |||
| For more information about the RPC API, please refer to [the well-commented RPC API C header file](https://github.com/ARMmbed/uvisor/blob/master/api/inc/rpc.h). | |||
| For more information about the RPC API, please refer to [the well-commented RPC API C header file](https://github.com/ARMmbed/uvisor/blob/master/lib/inc/rpc.h). | |||
There was a problem hiding this comment.
Did you mean to change this one?
There was a problem hiding this comment.
Good catch! Fixed :)
Note: This only applies to documentation, not to the API source folder.
AlessandroA
force-pushed
the
docs_mv_api_lib
branch
from
58d5d62 to
ae26e37
Compare
|
LGTM, but I will have to build once to find out (after you merge) |
|
The CI is red because of backwards-incompatibility. This PR is now blocked by ARMmbed/mbed-os#4179. |
|
ARMmbed/mbed-os#4179 has been merged. I'm updating the tests so that this PR can go green as well. |
|
retest uvisor |
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.
This is currently required by the docs.mbed.com engine, which expects
Doxygen documentation to be placed in an
apifolder, and will not recognizeour Markdown files.
Once the website moves to a different engine, we can revert back to
"api", if we want to.
@iriark01 Could you please verify that this fixes the issue you reported?
@Patater