spec: Add specification of specification items

1 files changed, 49 insertions, 0 deletions

diff --git a/spec/spec/enabled-by.yml b/spec/spec/enabled-by.yml
new file mode 100644
index 00000000..fa7de056
--- /dev/null
+++ b/spec/spec/enabled-by.yml
@@ -0,0 +1,49 @@
+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
+spec-description: |
+  A value of this type shall be an expression which defines under which
+  conditions the specification item or parts of it are enabled.  The expression
+  is evaluated with the use of an *enabled set*.  This is a set of strings
+  which indicate enabled features.
+spec-example: null
+spec-info:
+  bool:
+    description: |
+      This expression evaluates directly to the boolean value.
+  dict:
+    attributes:
+      and:
+        description: |
+          The *and* operator evaluates to the *logical and* of the evaluation
+          results of the expressions in the list.
+        spec-type: enabled-by-list
+      not:
+        description: |
+          The *not* operator evaluates to the *logical not* of the evaluation
+          results of the expression.
+        spec-type: enabled-by
+      or:
+        description: |
+          The *or* operator evaluates to the *logical or* of the evaluation
+          results of the expressions in the list.
+        spec-type: enabled-by-list
+    description: |
+      Each attribute defines an operator.
+    required-attributes: exactly-one
+  list:
+    description: |
+      This list of expressions evaluates to the *logical or* of the evaluation
+      results of the expressions in the list.
+    spec-type: enabled-by
+  str:
+    description: |
+      If the value is in the *enabled set*, this expression evaluates to true,
+      otherwise to false.
+spec-name: Enabled-By Expression
+spec-type: enabled-by
+type: spec