Skip to content

Commit 91127fb

Browse files
committed
update unit testing documentation for mbed cli
1 parent 2e9c131 commit 91127fb

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/tools/offline/cli-unittest.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@ Use the `mbed unittest` command to build and run unit tests, or to generate file
44

55
Build and run unit tests with `mbed unittest`. The arguments are:
66

7-
* `--skip-build` to skip building unit tests.
8-
* `--skip-run` to skip running unit tests.
9-
* `--clean` to clean previous build data.
7+
* `--compile` to only compile unit tests.
8+
* `--run` to only run unit tests.
9+
* `-c` or `--clean` to clean build directory.
1010
* `-d` or `--debug` to prepare debug build.
1111
* `--coverage <TYPE>` to generate code coverage report where TYPE can be "html", "xml" or "both".
1212
* `-m <NAME>` or `--make-program <NAME>` to select which make build tool to use where NAME can be "make", "gmake", "mingw32-make" or "ninja".
1313
* `-g <NAME>` or `--generator <NAME>` to select which CMake generator to use where NAME can be "Unix Makefiles", "MinGW Makefiles" or "Ninja".
1414
* `-r <EXPRESSION>` or `--regex <EXPRESSION>` to run tests matching the regular expression.
15-
* `--build-path <PATH>` to specify build path.
15+
* `--build <PATH>` to specify build directory.
1616
* `-v` or `--verbose` for verbose diagnostic output.
1717

1818
Generate files for a new unit test with `mbed unittest --new <FILE>`.
1919

2020
### Building and running unit tests
2121

22-
You can specify to only **build** the unit tests by using the `--skip-run` option:
22+
You can specify to only **build** the unit tests by using the `--compile option:
2323

2424
```
25-
$ mbed unittest --skip-run
25+
$ mbed unittest --compile
2626
```
2727

28-
You can specify to only **run** the unit tests by using the `--skip-build` option:
28+
You can specify to only **run** the unit tests by using the `--run` option:
2929

3030
```
31-
$ mbed unittest --skip-build
31+
$ mbed unittest --run
3232
```
3333

3434
If you do not specify any of these, `mbed unittest` will build all available unit tests and run them.

docs/tools/testing/unit_testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Traditional software testing is defined into three main levels: unit testing, in
1818
*-------------------> Amount of tests
1919
```
2020

21-
Integration and system testing are performed in an environment where the tests are run with full Mbed OS. Other testing tools for Mbed OS require specific hardware and whole Mbed OS to be built, which means traditional unit testing is not possible.
21+
Integration and system testing are performed in an environment where the tests are run with full Mbed OS. Other testing tools for Mbed OS require specific embedded hardware and whole Mbed OS to be built, which means traditional unit testing is not possible.
2222

23-
Unit testing takes place in a build environment where each C/C++ class or module is tested in isolation. This means test suites are built into separate test binaries and all access outside is stubbed to remove dependency of any specific hardware or software combination. This allows the testing to be done quickly using native compilers on the build machine.
23+
Unit testing takes place in a build environment where each C/C++ class or module is tested in isolation. This means test suites are built into separate test binaries and all access outside is stubbed to remove dependency of any specific embedded hardware or software combination. This allows the testing to be done quickly using native compilers on the build machine.
2424

2525
### Using unit tests
2626

0 commit comments

Comments
 (0)