summaryrefslogtreecommitdiff
path: root/spec/spec/root.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-24 14:17:15 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-18 13:27:33 +0200
commit1fce758513a51f35fd38ce684a51c3f497a5d833 (patch)
treef2dcb0ebd9871b3de98bf7698ba4e957d7d0955d /spec/spec/root.yml
parente3563c1d0d1137d1397463fedeb754db61067677 (diff)
spec: Move specification of specification items
This makes it reusable.
Diffstat (limited to 'spec/spec/root.yml')
-rw-r--r--spec/spec/root.yml51
1 files changed, 0 insertions, 51 deletions
diff --git a/spec/spec/root.yml b/spec/spec/root.yml
deleted file mode 100644
index 58d65280..00000000
--- a/spec/spec/root.yml
+++ /dev/null
@@ -1,51 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-links: []
-spec-description: null
-spec-example: null
-spec-info:
- dict:
- attributes:
- SPDX-License-Identifier:
- description: |
- It shall be the license of the item.
- spec-type: spdx-license-identifier
- copyrights:
- description: |
- It shall be the list of copyright statements of the item.
- spec-type: copyrights
- enabled-by:
- description: |
- It shall define the conditions under which the item is enabled.
- spec-type: enabled-by
- links:
- description: null
- spec-type: links
- type:
- description: |
- It shall be the item type. The selection of types and the level of
- detail depends on a particular standard and product model. We need
- enough flexibility to be in line with ECSS-E-ST-10-06 and possible
- future applications of other standards. The item type may be refined
- further with additional type-specific subtypes.
- spec-type: name
- description: |
- The technical specification of RTEMS will contain for example
- requirements, specializations of requirements, interface specifications,
- test suites, test cases, and requirement validations. These things will
- be called *specification items* or just *items* if it is clear from the
- context.
-
- The specification items are stored in files in ${/glossary/yaml:/term}
- format with a defined set of key-value pairs called attributes. Each
- attribute key name shall be a :ref:`SpecTypeName`. In particular, key
- names which begin with an underscore (``_``) are reserved for internal
- use in tools.
-
- This is the root specification item type.
- mandatory-attributes: all
-spec-name: Root Item Type
-spec-type: root
-type: spec