summaryrefslogtreecommitdiff
path: root/spec/spec/root.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:04:45 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:24 +0200
commit8832112d1a17ae976cbb2b254334ff2fee28cfac (patch)
tree87879b6baf25436c3bc104683924dd72f6b7f2de /spec/spec/root.yml
parent614b988d8afdc445812fdb05810ef5d4e2594044 (diff)
spec: Add content from engineering manual
Diffstat (limited to 'spec/spec/root.yml')
-rw-r--r--spec/spec/root.yml20
1 files changed, 18 insertions, 2 deletions
diff --git a/spec/spec/root.yml b/spec/spec/root.yml
index 42bca776..12b4a729 100644
--- a/spec/spec/root.yml
+++ b/spec/spec/root.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
spec-description: null
@@ -25,9 +25,25 @@ spec-info:
spec-type: links
type:
description: |
- It shall be the item type.
+ 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 ${/glos/term/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.
required-attributes: all
spec-name: Root Item Type