summaryrefslogtreecommitdiffstats
path: root/spec/spec/root.yml
blob: 58d65280649319996c25f76af02a665aec032ec6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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