Skip to content

Commit 2bc593c

Browse files
Amanda ButlerOlli-Pekka Puolitaival
authored andcommitted
Make changes from comments to cli-test-debug.md
Make requested changes, and make a few other copy edits.
1 parent f2a2532 commit 2bc593c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/tools/offline/cli-test-debug.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Use the `mbed test` command to compile and run tests.
44

5-
There are two testing frameworks: Greentea and Icetea. Greentea provides tests designed for driver porting and target verification. Icetea provides and manages tests for multiple devices at the same time. Devices being tested are referred to as devices under test (DUTs). For example, you can test the network setup for a server and multiple clients, simultaneously controlling them from the test environment.
5+
There are two testing frameworks: Greentea and Icetea. Greentea provides tests designed for driver porting and target verification. Icetea provides and manages tests for multiple devices at the same time. For example, you can test the network setup for a server and multiple clients, simultaneously controlling them from the test environment.
66

77
The arguments to `test` are:
88

@@ -12,16 +12,16 @@ The arguments to `test` are:
1212
- `--run-list`: to list all the tests that can be run, after they have been built.
1313
- `--compile`: to only compile the tests.
1414
- `--run`: to only run the tests.
15-
- `-n <TESTS_BY_NAME>`: to limit the tests built or run to a comma separated list, for example, test1, test2, test3.
15+
- `-n <TESTS_BY_NAME>`: to limit the tests built or run to a comma separated list, for example, `test1, test2, test3`.
1616
- `--source <SOURCE>`: to select the source directory. The default is `.` for the the current directory. You can specify multiple source locations, even outside the program tree.
1717
- `--build <BUILD>`: to select the build directory. The default is `BUILD/` inside your program.
1818
- `--profile <PATH_TO_BUILD_PROFILE>`: to select a path to a build profile configuration file, for example, `mbed-os/tools/profiles/debug.json`.
1919
- `-c or --clean`: to clean the build directory before compiling.
2020
- `--test-spec <TEST_SPEC>`: to set the path for the test specification file used when building and running tests. The default path is the build directory.
2121
- `--build-data <BUILD_DATA>`: dumps build_data to this file.
22-
- `--app-config <APP_CONFIG>`: the path of an app configuration file. The default is to look for 'mbed_app.json'.
23-
- `--test-config <TEST_CONFIG>`: the path or mbed OS keyword of a test configuration file, for example, ethernet, odin_wifi, or path/to/config.json.
24-
- `--greentea`: to run Greentea tests. As a default, it only runs greentea tests.
22+
- `--app-config <APP_CONFIG>`: the path of an app configuration file. The default is to look for `mbed_app.json`.
23+
- `--test-config <TEST_CONFIG>`: the path or Mbed OS keyword of a test configuration file, for example, `ethernet`, `odin_wifi` or `path/to/config.json`.
24+
- `--greentea`: to run Greentea tests. As a default, it only runs Greentea tests.
2525
- `--icetea`: to run Icetea tests. If used without the `--greentea` flag, then it only runs Icetea tests.
2626
- `-v` or `--verbose`: for verbose diagnostic output.
2727
- `-vv` or `--very_verbose`: for very verbose diagnostic output.
@@ -157,7 +157,7 @@ You can specify that the tests only **run** by using the `--run` option:
157157
$ mbed test -m K64F -t GCC_ARM --run
158158
```
159159

160-
If you don't specify any of these, `mbed test` first compilea all available tests and then runs them.
160+
If you don't specify any of these, `mbed test` first compiles all available tests and then runs them.
161161

162162
### Limiting the test scope
163163

@@ -208,7 +208,7 @@ mbed-os-program
208208

209209
As shown above, tests exist inside `TESTS\testgroup\testcase\` directories. Please note that `TESTS` is a special upper-case directory that is excluded from module sources while compiling.
210210

211-
<span class="notes">**Note:** `mbed test` does not work in applications that contain a `main` function that is outside of the `TESTS` directory.</span>
211+
<span class="notes">**Note:** `mbed test` does not work in applications that contain a `main` function that is outside of a `TESTS` directory.</span>
212212

213213
### Troubleshooting
214214

0 commit comments

Comments
 (0)