Skip to content

Commit 541fde7

Browse files
committed
Make names and slash direction consistent
1 parent 07b51da commit 541fde7

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/tutorials/porting.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,20 @@ Mbed Cloud Client provides reference implementation for three Mbed Enabled targe
2828

2929
Our sample target is identified by the following:
3030

31-
* The name of the target for builds is `MyTarget123`.
31+
* The name of the target for builds is `MY_BOARD_1`.
3232
* A Cortex-M4F based core.
3333
* Supports Mbed OS v5.x.
3434
* Has SERIAL interface as a bare minimum to print standard printf messages to the console, once built successfully.
3535
* Supports ARMCC and IAR compilers.
36-
* Inherits some features, such as the default toolchain and the virtual disk, from the standard `target` defined in `targets.json`.
37-
* Has all the drivers, APIs, HAL and so on defined in the `/mbed-os/TARGETS` directory as
38-
`TARGET_MY_Vendor/TARGET_VendorMCUs/TARGET_VendorDevice1/TARGET_VendorBoard_1`.
36+
* Inherits some features, such as the default toolchain and the virtual disk, from the standard `Target` defined in `targets.json`.
3937
* The public flag is set to `true` to indicate that this target is visible for compilation from the toolchains.
4038

4139
All of these requirements are directly mapped to relevant tags in the `targets.json` entry for our target. This is shown in step 3 below.
4240

4341

4442
### Add the target entry in `targets.json`
4543
```
46-
"MyTarget123": {
44+
"MY_BOARD_1": {
4745
"inherits":["Target"],
4846
"core":"Cortex-M4F",
4947
"public": true,
@@ -68,12 +66,12 @@ The target’s directory structure has the following hierarchy:
6866
- The specific board that uses the MCU in the previous level:
6967

7068
```
71-
\mbed-os\targets\TARGET_<Manf>\<Device_Family>\<specific_MCU>\<specific_board>\
69+
/mbed-os/targets/TARGET_<Manf>/<Device_Family>/<specific_MCU>/<specific_board>/
7270
```
7371

7472
Our sample implementation uses:
7573
```
76-
\mbed-os\targets\TARGET_MY_Vendor\TARGET_VendorMCUs\TARGET_VendorDevice1\TARGET_VendorBoard_1\
74+
/mbed-os/targets/TARGET_MY_VENDOR/TARGET_MY_FAMILY/TARGET_MY_DEVICE_1/TARGET_MY_BOARD_1/
7775
```
7876

7977

0 commit comments

Comments
 (0)