Skip to content

Commit a6915af

Browse files
committed
CMake readme: add naming scheme for our CMake targets
Be consistent
1 parent b3181a1 commit a6915af

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

tools/cmake/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,11 @@ $ mbedtools configure -t <TOOLCHAIN> -m <MBED_TARGET>
100100
Notes:
101101
* These steps will change when `mbedtools` implements a sub-command to invoke Greentea tests
102102
* Some Greentea tests require specific application configuration files in order to build and run successfully. For example, the `connectivity/mbedtls/tests/TESTS/mbedtls/sanity` test requires the configuration file found at `TESTs/configs/experimental.json`.
103+
104+
## Naming convention
105+
106+
- `mbed` namespace: Mbed CMake targets must have `mbed` prefix
107+
- all characters are lower case
108+
- words separated by hyphens
109+
110+
For example: `mbed-ble-cordio`

0 commit comments

Comments
 (0)