summaryrefslogtreecommitdiffstats
path: root/spec/spec/spec.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-26 16:08:20 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit53d462fbd04463f3749ae88144a3d28332fe4c58 (patch)
tree4d52e98ad9304abb7b42826a9f540984dd3d514d /spec/spec/spec.yml
parentspec: Add rationale attribute to requirements (diff)
downloadrtems-central-53d462fbd04463f3749ae88144a3d28332fe4c58.tar.bz2
spec: Canonicalize specification of specification
Diffstat (limited to 'spec/spec/spec.yml')
-rw-r--r--spec/spec/spec.yml20
1 files changed, 9 insertions, 11 deletions
diff --git a/spec/spec/spec.yml b/spec/spec/spec.yml
index 7f33c78a..3bdd17b6 100644
--- a/spec/spec/spec.yml
+++ b/spec/spec/spec.yml
@@ -29,14 +29,14 @@ spec-example: |
attributes:
an-example-attribute:
description: |
- This mandatory attribute shall be an example.
+ It shall be an example.
spec-type: optional-str
example-number:
description: |
- This mandatory attribute shall be the example number.
+ It shall be the example number.
spec-type: int
description: |
- This set of attributes gives an example.
+ This set of attributes specifies an example.
required-attributes: all
spec-name: Example Item Type
spec-type: spec
@@ -46,25 +46,23 @@ spec-info:
attributes:
spec-description:
description: |
- This mandatory attribute shall be the description of the
- specification type.
+ It shall be the description of the specification type.
spec-type: optional-str
spec-example:
description: |
- This mandatory attribute shall an example of the specification type.
+ If this value is present, then tt shall be an example of the
+ specification type.
spec-type: optional-str
spec-info:
- description: |
- This mandatory attribute defines the specification type information.
+ description: null
spec-type: spec-info
spec-name:
description: |
- This mandatory attribute shall be the human readable name of the
- specification type.
+ It shall be the human readable name of the specification type.
spec-type: optional-str
spec-type:
description: |
- This mandatory attribute defines the specification type name.
+ It shall the specification type.
spec-type: name
description: |
This set of attributes specifies specification types.