Skip to content

Commit d587ac2

Browse files
author
Amanda Butler
authored
Update headings in mbed_targets.md
Remove code formatting from headings for improved UX.
1 parent 2005a6a commit d587ac2

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/reference/configuration/mbed_targets.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The style that we use for targets is:
3636

3737
This section lists all the properties the Mbed build system understands. Unless specified otherwise, all properties are optional.
3838

39-
#### `inherits`
39+
#### inherits
4040

4141
The description of an Mbed target can "inherit" from one or more descriptions of other targets. When a target, called a _child_ inherits from another target, called its _parent_, the child automatically copies all the properties from the parent. After the child has copied the properties of the parent, it may then overwrite, add or remove from those properties. In our example above, `TEENSY3_1` inherits from `Target`. This is the definition of `Target`:
4242

@@ -82,23 +82,23 @@ Avoid using multiple inheritance for your targets. If you use multiple inheritan
8282

8383
For more details about the Python method resolution order, please see [this Python tutorial](http://makina-corpus.com/blog/metier/2014/python-tutorial-understanding-python-mro-class-search-path).
8484

85-
#### `core`
85+
#### core
8686

8787
The name of the target's Arm core.
8888

8989
Possible values: `"Cortex-M0"`, `"Cortex-M0+"`, `"Cortex-M1"`, `"Cortex-M3"`, `"Cortex-M4"`, `"Cortex-M4F"`, `"Cortex-M7"`, `"Cortex-M7F"`, `"Cortex-A9"`, `"Cortex-M23"`, `"Cortex-M23-NS"`, `"Cortex-M33"`, `"Cortex-M33-NS"`
9090

9191
<span class="notes">**Note:** Mbed OS supports v8-M architecture devices (Cortex-M23 and Cortex-M33) on the ARMC6 toolchain (version 6.10).</span>
9292

93-
#### `public`
93+
#### public
9494

9595
The `public` property controls which targets the Mbed build system allows users to build. You may define targets as parents for other targets. When you define such a target, its description must set the `public` property to `false`. `Target`, shown above, sets `public` to `false` for this reason.
9696

9797
If `public` is not defined for a target, it defaults to `true`.
9898

9999
<span class="notes">**Note:** Unlike other target properties, **the value of `public` is not inherited from a parent to its children**.</span>
100100

101-
### `macros`, `macros_add` and `macros_remove`
101+
### macros, macros_add and macros_remove
102102

103103
The `macros` property defines a list of macros that are available when compiling code. You may define these macros with or without a value. For example, the declaration `"macros": ["NO_VALUE", "VALUE=10"]` will add `-DNO_VALUE -DVALUE=10` to the compiler's command-line.
104104

@@ -119,13 +119,13 @@ For example:
119119

120120
In this configuration, the value of `TargetB.macros` is `["PARENT_MACRO1", "CHILD_MACRO1"]`.
121121

122-
#### `extra_labels`, `extra_labels_add` and `extra_labels_remove`
122+
#### extra_labels, extra_labels_add and extra_labels_remove
123123

124124
The list of _labels_ defines how the build system looks for sources, include directories and so on. `extra_labels` makes the build system aware of additional directories that it must scan for such files.
125125

126126
When you use target inheritance, you may alter the values of `extra_labels` using `extra_labels_add` and `extra_labels_remove`. This is similar to the `macros_add` and `macros_remove` mechanism described in the previous section.
127127

128-
#### `features`, `features_add` and `features_remove`
128+
#### features, features_add and features_remove
129129

130130
The list of _features_ enables software features on a platform. Like `extra_labels`, `features` makes the build system aware of additional directories it must scan for resources. Unlike `extra_labels`, the build system recognizes a fixed set of values in the `features` list. The build system recognizes the following features:
131131
- `BLE`.
@@ -135,7 +135,7 @@ The build system errors when you use features outside of this list.
135135

136136
When you use target inheritance, you may alter the values of `features` using `features_add` and `features_remove`. This is similar to the `macros_add` and `macros_remove` mechanism the previous section describes.
137137

138-
#### `config` and `overrides`
138+
#### config and overrides
139139

140140
<span class="notes">**Note:** The [Arm Mbed configuration system](../tools/compile.html) customizes the compile time configuration of various Mbed components (targets, libraries and applications). Each component can define a number of configuration parameters. The values of these configuration parameters can then be overridden in various ways.</span>
141141

@@ -180,25 +180,25 @@ You can also modify config values for a project using the `target_overrides` key
180180

181181
This section, in an `mbed_app.json` file, sets the clock source to `RC` on all targets and the clock frequency to 16Mhz on just the `NRF51_DK` target.
182182

183-
#### `device_has`
183+
#### device_has
184184

185185
The list in `device_has` defines what hardware a device has.
186186

187187
Mbed, libraries and application source code can then select different implementations of drivers based on hardware availability; selectively compile drivers for existing hardware only; or run only the tests that apply to a particular platform. The values in `device_has` are available in C, C++ and assembly language as `DEVICE_` prefixed macros.
188188

189-
#### `is_disk_virtual`
189+
#### is_disk_virtual
190190

191191
Enabling `is_disk_virtual` adds delay after flashing firmware binary to make sure the mount was correct. This field is not used anymore. The Mbed test tools use `Mbed LS` to make sure the mount was correct before flashing it again.
192192

193-
#### `supported_toolchains`
193+
#### supported_toolchains
194194

195195
The `supported_toolchains` property is the list of toolchains that support a target. The allowed values for `supported_toolchains` are `ARM`, `uARM`, `ARMC6`, `GCC_ARM` and `IAR`.
196196

197-
#### `default_toolchain`
197+
#### default_toolchain
198198

199199
The `default_toolchain` property names the toolchain that compiles code for this target in the Online Compiler. Possible values for `default_toolchain` are `ARM` or `uARM`.
200200

201-
#### `post_binary_hook`
201+
#### post_binary_hook
202202

203203
Some targets require specific actions to generate a programmable binary image. Specify these actions using the `post_binary_hook` property and custom Python code. The value of `post_binary_hook` must be a JSON object with keys `function` and optionally `toolchain`. Within the `post_binary_hook` JSON object, the `function` key must contain a Python function that is accessible from the namespace of `tools/targets/__init__.py`, and the optional `toolchain` key must contain a list of toolchains that require processing from the `post_binary_hook`. When you do not specify the `toolchains` key for a `post_binary_hook`, you can assume the `post_binary_hook` applies to all toolchains. For the `TEENSY3_1` target above, the definition of `post_binary_hook` looks like this:
204204

@@ -229,7 +229,7 @@ class TEENSY3_1Code:
229229

230230
The `post_build_hook` for the `TEENSY3_1` converts the output file (`binf`) from binary format to Intel HEX format. See the other hooks in `tools/targets/__init__.py` for more examples of hook code.
231231

232-
#### `device_name`
232+
#### device_name
233233

234234
Use this property to pass necessary data for exporting to various third party tools and IDEs and for building applications with bootloaders.
235235

@@ -257,27 +257,27 @@ The [`"device_name"`](../porting/index.html) attribute it `targets.json` maps fr
257257

258258
The `device_name` key in `targets.json` is `MK20DX256xxx7` for any target that uses this particular MCU.
259259

260-
#### `detect_code`
260+
#### detect_code
261261

262262
The `detect_code` contains four ASCII characters containing only hexadecimal values (A-F and 0-9). This code is the same for all platforms of the same type. `Mbed LS` no longer uses this field to identify the platform. Instead, `Mbed LS` has its [own database](https://github.com/ARMmbed/mbed-os-tools/blob/master/src/mbed_os_tools/detect/platform_database.py) of detect codes.
263263

264-
#### `OUTPUT_EXT`
264+
#### OUTPUT_EXT
265265

266266
The `OUTPUT_EXT` property controls the file type emitted for a target by the build system. You may set `OUTPUT_EXT` to `bin` for binary format, `hex` for Intel HEX format and `elf` for ELF format. We discourage using the `elf` value for `OUTPUT_EXT` because the build system must always emit an ELF file.
267267

268-
#### `default_lib`
268+
#### default_lib
269269

270270
The `delault_lib` property controls which library, small or standard, the `GCC_ARM` toolchain links. The `default_lib` property may take on the values `std` for the standard library and `small` for the reduced size library.
271271

272-
#### `bootloader_supported`
272+
#### bootloader_supported
273273

274274
The `bootloader_supported` property controls whether the build system allows a bootloader or a bootloader-using application to be built for a target. The default value of `bootloader_supported` is `false`.
275275

276-
#### `release_versions`
276+
#### release_versions
277277

278278
The `release_versions` property is a list of major versions of Mbed OS that the target supports. The list within `release_versions` may only contain `2`, indicating that the support of Mbed OS 2, and `5`, indicating the support of Mbed OS 5. We build all targets that are released for Mbed OS 2 as a static library. Targets are released for Mbed OS 2 by putting a `2` in the `release_version` list.
279279

280-
#### `supported_form_factors`
280+
#### supported_form_factors
281281

282282
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.
283283

@@ -367,7 +367,7 @@ For each of these target roles, some restrictions are in place:
367367

368368
The linting script takes three subcommands: `targets`, `all-targets` and `orphans`.
369369

370-
##### `targets` and `all-targets` commands
370+
##### targets and all-targets commands
371371

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

@@ -412,7 +412,7 @@ target errors:
412412
413413
The `all-targets` command is very verbose, with output that matches the format above but is too long to reproduce here.
414414

415-
##### `orphans` command
415+
##### orphans command
416416

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

0 commit comments

Comments
 (0)