Changes between Initial Version and Version 1 of Ticket #3853


Ignore:
Timestamp:
01/08/20 06:38:00 (4 years ago)
Author:
Sebastian Huber
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #3853 – Description

    initial v1  
    33https://lists.rtems.org/pipermail/devel/2020-January/056728.html
    44
     5== Approach A
     6
    57Use c-user/glossary.rst as the project-wide glossary. Generate document-specific glossaries from this file and the use of :term: in the specific document.  Add new waf target "./waf regenerate" to carry out the glossary generation.
     8
     9== Approach B
     10
     11Move the glossary terms to the RTEMS specification (e.g. in the RTEMS sources "spec/glossary/*.yml") and generate the glossary.rst for the documents with a script.  This gives us more flexibility and removes the need for the special parser code, see:
     12
     13https://lists.rtems.org/pipermail/devel/2020-January/056811.html
     14
     15The AV-2 mentioned of the DoD Architecture Framework (DoDAF) wants the glossary terms in categories. We could add categories to the glossary specification items. This would be difficult with a master glossary in reST.