Skip to content

Commit 8b70ae1

Browse files
committed
docs: Update to reflect Mbed CLI 2 changes
Due to the recent release of Mbed CLI 2, the command line options have been renamed to ensure good usability and harmonize with the old tools. These are the following changes done: * Minimum Cmake - 3.19.0 is required * Minimum Mbed-tools - 4.0.0 is required * mbed-tools cmd `init` to `new` * mbed-tools cmd `build` to `compile` * Removed whitespaces
1 parent e77b1d8 commit 8b70ae1

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/design-documents/tools/cmake.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CMake Mbed OS
22

33
Requirements:
4-
- CMake 3.18.2 and higher
4+
- CMake 3.19.0 and higher
55
- `mbed-tools` (python 3.6 and higher)
66

77
Two steps approach:
@@ -75,7 +75,7 @@ The rule of thumb is to not expose header files that are internal. We would like
7575

7676
`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.
7777

78-
Each application contains a top-level CMakeLists.txt file. The `mbedtools init` command can create this top-level CMakeLists.txt, or a user can create it manually. Each application also has a number of json configuration files. `mbedtools configure` creates an Mbed configuration CMake file (`.mbedbuild/mbed_config.cmake`). The process for building an application looks like:
78+
Each application contains a top-level CMakeLists.txt file. The `mbedtools new` command can create this top-level CMakeLists.txt, or a user can create it manually. Each application also has a number of json configuration files. `mbedtools configure` creates an Mbed configuration CMake file (`.mbedbuild/mbed_config.cmake`). The process for building an application looks like:
7979

8080
1. Parse the arguments provided to build command
8181
1. Parse the application configuration

tools/cmake/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Supported examples can be identified by the presence of a top level `CMakeLists.
4242

4343
Prerequisities:
4444
- CMake >=3.19.0
45-
- mbed-tools >=3.5.0
45+
- mbed-tools >=4.0.0
4646

4747
From the application root or wherever `mbed-os.lib` is found, run the following command to:
4848
* create the Mbed OS configuration CMake module
@@ -51,15 +51,15 @@ From the application root or wherever `mbed-os.lib` is found, run the following
5151
* build the project using the `Ninja` build system
5252

5353
```
54-
mbedtools build -m <mbed-target> -t <toolchain>
54+
mbedtools compile -m <mbed-target> -t <toolchain>
5555
```
5656
5757
`CMAKE_BUILD_TYPE` can overridden with Mbed specific values: `Develop` (default value), `Release` and `Debug`.
5858
59-
`mbed-tools` will pass `-DCMAKE_BUILD_TYPE=<supported-build-type>` for you when using the `--build-type` optional argument of the `build` subcommand as follows:
59+
`mbed-tools` will pass `-DCMAKE_BUILD_TYPE=<supported-build-type>` for you when using the `--build-type` optional argument of the `build` subcommand as follows:
6060
6161
```
62-
mbedtools build -m <mbed-target> -t <toolchain> -b <supported-build-type>
62+
mbedtools compile -m <mbed-target> -t <toolchain> -b <supported-build-type>
6363
```
6464
6565
If you're running CMake directly, you may need to pass it in yourself as follows:

tools/test/examples/examples_lib.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ def compile_repos(config, toolchains, targets, profiles, verbose, exp_filter, cm
383383
logging.info("Compiling %s" % summary_string)
384384

385385
if cmake:
386-
build_command_seq = ["mbed-tools build -t {} -m {} -c".format(toolchain, target)]
386+
build_command_seq = ["mbed-tools compile -t {} -m {} -c".format(toolchain, target)]
387387
else:
388388
build_command_seq = ["mbed-cli compile -t {} -m {} -j {} {}".format(toolchain, target, str(jobs), '-vv' if verbose else '') ]
389389
if profiles:

0 commit comments

Comments
 (0)