diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-22 18:33:19 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
| commit | 2a2fd6dd5aadf5a892ef1f713d2ab65605f2f4ef (patch) | |
| tree | 7e8f49cd8b66d0c5bf0973ec8405b33fe38a8405 /spec/spec/build-option.yml | |
| parent | 58f5f036bf85a8ded2b75c3af1fe7693b3fdead8 (diff) | |
spec: Add specification of build items
Diffstat (limited to 'spec/spec/build-option.yml')
| -rw-r--r-- | spec/spec/build-option.yml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/spec/spec/build-option.yml b/spec/spec/build-option.yml new file mode 100644 index 00000000..0db645d8 --- /dev/null +++ b/spec/spec/build-option.yml @@ -0,0 +1,59 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +links: +- role: spec-member + uid: root +- role: spec-refinement + spec-key: build-type + spec-value: option + uid: build +spec-description: null +spec-example: null +spec-info: + dict: + attributes: + actions: + description: | + Each action operates on the *action value* handed over by a previous + action and action-specific attribute values. The actions pass the + processed action value to the next action in the list. The first + action starts with an action value of ``None``. The actions are + carried out during the configure command execution. + spec-type: build-action-list + default: + description: | + It shall be the default value of the option if no variant-specific + default value is specified. Use ``null`` to specify that no default + value exits. The variant-specific default values may be specified by + the ``default-by-variant`` attribute. + spec-type: build-option-value + default-by-variant: + description: | + The list is processed from top to bottom. If a matching variant is + found, then the processing stops. + spec-type: build-default-by-variant-list + format: + description: | + It shall be a `Python format string + <https://docs.python.org/3/library/string.html#formatstrings>`_, for + example ``'{}'`` or ``'{:#010x}'``. + spec-type: optional-str + name: + description: null + spec-type: build-option-name + description: + description: | + It shall be the description of the option. + spec-type: optional-str + description: | + This set of attributes specifies a build option. + required-attributes: + - actions + - default + - default-by-variant + - description +spec-name: Build Option Item Type +spec-type: build-option +type: spec |