Skip to content

Commit ebd1c16

Browse files
committed
Updating readme to use hyphens for unittest paths
1 parent 920db63 commit ebd1c16

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

UNITTESTS/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ mbed test --unittests
7979

8080
A subset of tests can be run by providing `-r` flag for the tool which runs tests matching a regular expression.
8181

82-
e.g. `mbed test --unittests --run -r features_netsocket`
82+
e.g. `mbed test --unittests --run -r features-netsocket`
8383

8484
### Build manually without Python tools
8585

@@ -105,7 +105,7 @@ mingw32-make
105105

106106
#### Custom CMake variables
107107

108-
Usage:
108+
Usage:
109109
`cmake [RELATIVE PATH TO UNITTESTS DIR] [OPTIONS]`
110110

111111
Keyword variables (usage `cmake -D<VARIABLE>(:<TYPE>)=<value>`:
@@ -157,17 +157,17 @@ mkdir UNITTESTS/build
157157
cd UNITTESTS/build
158158
cmake -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE:STRING=html ..
159159
make
160-
./features_netsocket_InternetSocket
161-
gcovr -r ../.. --html --html-detail -o ./index.html ./CMakeFiles/features_netsocket_InternetSocket.MbedOS.dir/
160+
./features-netsocket-InternetSocket
161+
gcovr -r ../.. --html --html-detail -o ./index.html ./CMakeFiles/features-netsocket-InternetSocket.MbedOS.dir/
162162
```
163163
Windows:
164164
```
165165
mkdir UNITTESTS/build
166166
cd UNITTESTS/build
167167
cmake -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE:STRING=html -g "MinGW Makefiles" ..
168168
mingw32-make
169-
features_netsocket_InternetSocket.exe
170-
gcovr -r ..\.. --html --html-detail -o .\index.html .\CMakeFiles\features_netsocket_InternetSocket.MbedOS.dir\
169+
features-netsocket-InternetSocket.exe
170+
gcovr -r ..\.. --html --html-detail -o .\index.html .\CMakeFiles\features-netsocket-InternetSocket.MbedOS.dir\
171171
```
172172

173173
## The structure of unit tests
@@ -203,7 +203,7 @@ Each class to be tested requires two files for unit testing:
203203

204204
A unit test definition file `unittest.cmake` requires variables to be set for a test to be configured. File source paths in `unittest.cmake` files need to be relative to the unit test folder and `CMakeLists.txt`.
205205

206-
* **TEST_SUITE_NAME** - Identifier for the test suite. Use naming convention *PATH_TO_THE_TESTABLE_FILE* e.g. *features_netsocket_InternetSocket*
206+
* **TEST_SUITE_NAME** - Identifier for the test suite. Use naming convention *PATH_TO_THE_TESTABLE_FILE* e.g. *features-netsocket-InternetSocket*
207207
* **unittest-includes** - Include paths for headers needed to build the tests in addition to the base include paths listed in [CMakeLists.txt](CMakeLists.txt). Optional.
208208
* **unittest-sources** - Mbed OS source files and stubs included for the build.
209209
* **unittest-test-sources** - Unit test source files.
@@ -291,4 +291,4 @@ TEST_F(TestSemaphore, constructor)
291291

292292
**Problem:** virus protection identifies files generated by CMake as malicious and quarantines the files on Windows.
293293

294-
* **Solution**: restore the false positive files from the quarantine.
294+
* **Solution**: restore the false positive files from the quarantine.

0 commit comments

Comments
 (0)