This patch demonstrates the automatic generation of the general glossary and the
new glossary for the RTEMS Software Engineering manual. In a private repository
I have specification items for groups of glossary terms (e.g. the general
glossary) and glossary terms. I also have a prototype for a generator script
which reads the specification items and the Sphinx format sources. The script
outputs the glossary.rst files.
The licence and copyright information is aggregated from the individual
specification items, e.g.
SPDX-License-Identifier: CC-BY-SA-4.0
active: true
copyrights:
- Copyright (C) 1988, 1998 On-Line Applications Research Corporation
(OAR)
derived: false
enabled-by: []
glossary-term: TCB
glossary-type: term
header: ''
level: 1.172
links:
- RTEMS-GLOS-GENERAL: y-DGLwoqVNRBlzUau_mx_yR3iKlhE02h2mRxK7VkLQE=
normative: true
ref: ''
reviewed: KJcc81zY_4KUf8oXIu-oJZ5DRMiFc9DoDsmhl9PZxac=
text: |
An acronym for @term{RTEMS-GLOS-TERM-TASKCONTROLBLOCK}.
type: glossary
The specification text can use macros to reference other specification items,
e.g. @term{RTEMS-GLOS-TERM-TASKCONTROLBLOCK} in the example above.
A contribution of the scripts and the specification items to the RTEMS Project
is currently blocked due to several undecided things related to the RTEMS
Qualification Project:
https://lists.rtems.org/pipermail/devel/2020-February/057246.html
Sebastian Huber (1):
eng: Add glossary
c-user/glossary.rst | 51 +++++++++++++++++++++++++++++++++++++++++++-
eng/glossary.rst | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++
eng/index.rst | 1 +
3 files changed, 112 insertions(+), 1 deletion(-)
create mode 100644 eng/glossary.rst
--
2.16.4
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel
