diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-04 14:15:49 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-04 14:22:46 +0200 |
| commit | 84280e6e7a683f70c9ba7a8b1141b190dbecf95e (patch) | |
| tree | 0e657ad5f99e8b7e52b1c86e1a111990769c6b4c /spec/spec | |
| parent | spec: Add missing references attributes (diff) | |
| download | rtems-central-84280e6e7a683f70c9ba7a8b1141b190dbecf95e.tar.bz2 | |
spec: Move glossary terms
The previous structure was a relict of the Doorstop era. This makes it
easier to reference terms via ${/glossary/abc:/term} substitutions.
Diffstat (limited to 'spec/spec')
| -rw-r--r-- | spec/spec/interface.yml | 2 | ||||
| -rw-r--r-- | spec/spec/requirement-validation.yml | 4 | ||||
| -rw-r--r-- | spec/spec/root.yml | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/spec/spec/interface.yml b/spec/spec/interface.yml index f9616cff..d975a949 100644 --- a/spec/spec/interface.yml +++ b/spec/spec/interface.yml @@ -23,7 +23,7 @@ spec-info: Interface items shall specify the interface of the software product to other software products and the hardware. Use ${interface-domain:/spec-name} items to specify interface domains, for - example the ${/glos/term/api:/term}, C language, compiler, interfaces to + example the ${/glossary/api:/term}, C language, compiler, interfaces to the implementation, and the hardware. required-attributes: all spec-name: Interface Item Type diff --git a/spec/spec/requirement-validation.yml b/spec/spec/requirement-validation.yml index 6b5fc07d..4b1bbf42 100644 --- a/spec/spec/requirement-validation.yml +++ b/spec/spec/requirement-validation.yml @@ -25,10 +25,10 @@ spec-info: * *By analysis*: A statement shall be provided how the requirement is met, by analysing static properties of the - ${/glos/term/softwareproduct:/term}. + ${/glossary/softwareproduct:/term}. * *By inspection*: A statement shall be provided how the requirement - is met, by inspection of the ${/glos/term/sourcecode:/term}. + is met, by inspection of the ${/glossary/sourcecode:/term}. * *By review of design*: A rationale shall be provided to demonstrate how the requirement is satisfied implicitly by the software design. diff --git a/spec/spec/root.yml b/spec/spec/root.yml index 12b4a729..b819dddf 100644 --- a/spec/spec/root.yml +++ b/spec/spec/root.yml @@ -38,7 +38,7 @@ spec-info: 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} + 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 |