diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-25 08:48:50 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
commit | f9cff66d1c1fe69e0814602403279cdf001d36cb (patch) | |
tree | 5e92135850c5c39cec63d57c435288e75980cc3f /spec/spec | |
parent | Rename glossary attributes (diff) | |
download | rtems-central-f9cff66d1c1fe69e0814602403279cdf001d36cb.tar.bz2 |
spec: Add specification of glossary items
Diffstat (limited to 'spec/spec')
-rw-r--r-- | spec/spec/glossary-group.yml | 30 | ||||
-rw-r--r-- | spec/spec/glossary-term.yml | 30 | ||||
-rw-r--r-- | spec/spec/glossary.yml | 26 | ||||
-rw-r--r-- | spec/spec/requirement-non-functional-type.yml | 1 |
4 files changed, 87 insertions, 0 deletions
diff --git a/spec/spec/glossary-group.yml b/spec/spec/glossary-group.yml new file mode 100644 index 00000000..24863b2e --- /dev/null +++ b/spec/spec/glossary-group.yml @@ -0,0 +1,30 @@ +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: glossary-type + spec-value: group + uid: glossary +spec-description: null +spec-example: null +spec-info: + dict: + attributes: + name: + description: | + It defines the human readable name of the glossary group. + spec-type: str + text: + description: | + It states the requirement for the glossary group. + spec-type: str + description: | + This set of attributes specifies a glossary group. + required-attributes: all +spec-name: Glossary Group Item Type +spec-type: glossary-group +type: spec diff --git a/spec/spec/glossary-term.yml b/spec/spec/glossary-term.yml new file mode 100644 index 00000000..d1c10b5b --- /dev/null +++ b/spec/spec/glossary-term.yml @@ -0,0 +1,30 @@ +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: glossary-type + spec-value: term + uid: glossary +spec-description: null +spec-example: null +spec-info: + dict: + attributes: + term: + description: | + It names the glossary term. + spec-type: str + text: + description: | + It gives the definition of the glossary term. + spec-type: str + description: | + This set of attributes specifies a glossary term. + required-attributes: all +spec-name: Glossary Term Item Type +spec-type: glossary-term +type: spec diff --git a/spec/spec/glossary.yml b/spec/spec/glossary.yml new file mode 100644 index 00000000..847851ba --- /dev/null +++ b/spec/spec/glossary.yml @@ -0,0 +1,26 @@ +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: type + spec-value: glossary + uid: root +spec-description: null +spec-example: null +spec-info: + dict: + attributes: + glossary-type: + description: | + It defines the glossary item type. + spec-type: name + description: | + This set of attributes specifies glossary items. + required-attributes: all +spec-name: Glossary Item Type +spec-type: glossary +type: spec diff --git a/spec/spec/requirement-non-functional-type.yml b/spec/spec/requirement-non-functional-type.yml index 7d83daae..68de439a 100644 --- a/spec/spec/requirement-non-functional-type.yml +++ b/spec/spec/requirement-non-functional-type.yml @@ -14,6 +14,7 @@ spec-info: - build-configuration - constraint - design + - documentation - interface - interface-requirement - maintainability |