Skip to content

Commit 752da30

Browse files
author
Amanda Butler
authored
Update mbed_targets.md
Fix header sizes
1 parent 08a9f14 commit 752da30

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/advanced/mbed_targets.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,14 +193,14 @@ The `release_versions` property is a list of major versions of mbed OS that the
193193

194194
The `supported_form_factors` property is an optional list of form factors that a development board supports. You can use this property in C, C++ and assembly language by passing a macro prefixed with `TARGET_FF_` to the compiler. The accepted values for `supported_form_factors` are `ARDUINO`, which indicates compatibility with Arduino headers, and `MORPHO`, which indicates compatibility with ST Morpho headers.
195195

196-
# Style guide
196+
## Style guide
197197

198198
A linting script for `targets.json` is available as `tools/targets/lint.py` in mbed OS. This script is a utility for avoiding common errors when defining targets and detecting style inconsistencies between targets. This linting script displays style errors based on a few rules outlined below.
199199

200-
## Rules enforced
200+
### Rules enforced
201201
There are two sets of rules: rules that affect how you must structure target inheritance and rules that govern what each role within the inheritance hierarchy can do.
202202

203-
### Inheritance rules
203+
#### Inheritance rules
204204
A target's inheritance must look like one of these:
205205

206206
```
@@ -214,7 +214,7 @@ Family -> Subfamily -> MCU -> Module -> Board
214214

215215
The linting script guesses where the Boards and Modules stop and the MCUs, Families and Subfamilies begin. An MCU, Family or Subfamily must have at least one Board or Module above it in any hierarchy.
216216

217-
### Role rules
217+
#### Role rules
218218

219219
For each of these target roles, some restrictions are in place:
220220
- Families, MCUs and Subfamilies may contain the following keys:
@@ -272,10 +272,10 @@ For each of these target roles, some restrictions are in place:
272272
- if `release_versions` contains 5, then `supported_toolchains` must contain all of `GCC_ARM`, `ARM` and `IAR`
273273
- MCUs, Families and SubFamilies must set `public` to `false`
274274

275-
## Sample output
275+
### Sample output
276276
The linting script takes three subcommands: `targets`, `all-targets` and `orphans`.
277277

278-
### `targets` and `all-targets` commands
278+
#### `targets` and `all-targets` commands
279279

280280
The `targets` and `all-targets` commands both show errors within public inheritance hierarchies. For example:
281281

@@ -320,7 +320,7 @@ target errors:
320320
321321
The `all-targets` command is very verbose, with output that matches the format above but is too long to reproduce here.
322322

323-
### `orphans` command
323+
#### `orphans` command
324324

325325
The `orphans` command shows all targets that you cannot reach from a public target.
326326

0 commit comments

Comments
 (0)