Skip to content

Commit ae99878

Browse files
0xc0170Patater
andauthored
Apply suggestions from code review
Co-authored-by: Jaeden Amero <[email protected]>
1 parent 44a89ad commit ae99878

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/design-documents/tools/cmake.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ The rule of thumb is to not expose header files that are internal. We would like
8080

8181
## Building an Application
8282

83-
`mbed-tools` is the next generation of command line tooling for Mbed OS. `mbed-tools` replaces the `mbed-cli` and the Python modules in the `mbed-os/tools` directory.
83+
`mbed-tools` is the next generation of command line tooling for Mbed OS. `mbed-tools` replaces `mbed-cli` and the Python modules in the `mbed-os/tools` directory.
8484

85-
`mbed-tools` has consolidated all of the required modules to build Mbed OS, along with the command line interface, into a single Python package which can be installed using standard python packaging tools.
85+
`mbed-tools` consolidates all of the required modules to build Mbed OS, along with the command line interface, into a single Python package which can be installed using standard Python packaging tools.
8686

8787
A user create own CMake file to configure an application, also with `mbed_app.json` configuration file. The building of an app would look like:
8888

@@ -111,8 +111,8 @@ This will output `mbed_config.cmake` in a directory named `.mbedbuild` at the ro
111111

112112
The tools also generate an `MBED_TARGET_LABELS` variable, containing the labels, components and feature definitions from `targets.json`, used to select the required Mbed OS components to be built.
113113

114-
The macro definitions parsed from the Mbed OS configuration system are also included in `mbed_config.cmake`. The decision was made to remove `mbed_config.h`.
114+
The macro definitions parsed from the Mbed OS configuration system are also included in `mbed_config.cmake`, so it is no longer necessary for the tools to generate any `mbed_config.h` file to define macros.
115115

116116
### mbedignore
117117

118-
TBD
118+
With a build system that can understand dependencies between applications, features, components, and targets, `mbedignore` is no longer needed. CMake creates a list of exactly what's needed for an application build, rather than do what the legacy tools did and include everything by default, leaving the application to specify what is not needed. It's far more natural to express what you need rather than what you don't need, not to mention more future proof should some new feature appear in Mbed OS which your application would need to ignore.

0 commit comments

Comments
 (0)