CMake: Add documentation about CMakeLists.txt file #1434
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
0xc0170
reviewed
Mar 22, 2021
hugueskamba
force-pushed
the
hk_feature-cmake-docs_overview
branch
from
28c9170 to
1eee139
Compare
0xc0170
approved these changes
Mar 22, 2021
|
|
||
| ## Library configuration | ||
| Source files are included in libraries by listing them in `CMakeLists.txt` files using `target_sources()`. Some source code are provided in Mbed as pre-built libraries and are added to libraries using `target_link_libraries()`. `target_link_libraries()` is also used to link other Mbed libraries if there are dependencies. | ||
| Header files are included by listing the directories where they are found using `target_include_directories()`. Additionally, compile defintions are added to libraries using `target_compile_defintions()`. |
There was a problem hiding this comment.
Suggested change
| Header files are included by listing the directories where they are found using `target_include_directories()`. Additionally, compile defintions are added to libraries using `target_compile_defintions()`. | |
| compile defintions are added to libraries using `target_compile_definitions()`. |
There was a problem hiding this comment.
I do not understand the suggestion. Are you suggesting to remove talking about target_include_directories()? If so, why?
There was a problem hiding this comment.
The suggestion was incorrect 🤦
Add documentation to explain how CMakeLists.txt file are used in Mbed OS.
hugueskamba
force-pushed
the
hk_feature-cmake-docs_overview
branch
from
1eee139 to
0cd3f1d
Compare
0xc0170
approved these changes
Mar 23, 2021
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.
Add documentation to explain how CMakeLists.txt file
are used in Mbed OS.