Skip to content

Document features whitelist #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 30, 2017
Merged

Document features whitelist #190

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cf4734
Document features whitelist
theotherjimmy Jun 30, 2017
e9022d6
Add periods after list items
theotherjimmy Jun 30, 2017
f157eb9
Capitolize nanostack
theotherjimmy Jun 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion docs/advanced/mbed_targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,27 @@ When you use target inheritance, you may alter the values of `extra_labels` usin

### `features`, `features_add` and `features_remove`

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.
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:
- `UVISOR`.
- `BLE`.
- `CLIENT`.
- `IPV4`.
- `LWIP`.
- `COMMON_PAL`.
- `STORAGE`.
- `NANOSTACK`.

The following features, also recognized by the build system, are all Nanostack configurations:
- `LOWPAN_BORDER_ROUTER`.
- `LOWPAN_HOST`.
- `LOWPAN_ROUTER`.
- `NANOSTACK_FULL`.
- `THREAD_BORDER_ROUTER`.
- `THREAD_END_DEVICE`.
- `THREAD_ROUTER`.
- `ETHERNET_HOST`.

The build system errors when you use features outside of this list.

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.

Expand Down