rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-16 05:26:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

eng: Replace spec2doc.py with spec2modules.py

Browse Source 
Update #3715.
This commit is contained in:
Sebastian Huber 2020-10-24 12:12:31 +02:00
parent 25525dc3ac
commit abc9c4498d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
eng/req/howto.rst
View File

@ -139,12 +139,12 @@ Generate Content after Changes
Once you are done with the modifications of an existing item or the creation of Once you are done with the modifications of an existing item or the creation of
a new item, the changes need to be propagated to generated source files. This a new item, the changes need to be propagated to generated source files. This
is done by the :file:`spec2doc.py` script. Before you call this script, make is done by the :file:`spec2modules.py` script. Before you call this script,
sure the Git submodules are up-to-date. make sure the Git submodules are up-to-date.
.. code-block:: none .. code-block:: none
$ ./spec2doc.py $ ./spec2dmodules.py
The script modifies or creates source files in :file:`modules/rtems` and The script modifies or creates source files in :file:`modules/rtems` and
:file:`modules/rtems-docs`. Create patch sets for these changes just as if :file:`modules/rtems-docs`. Create patch sets for these changes just as if
@ -193,10 +193,10 @@ Define acronyms with the phrase `This term is an acronym for *.` in the
This term is an acronym for Magic Power. This term is an acronym for Magic Power.
... ...
Once you are done with the glossary items, run the script :file:`spec2doc.py` Once you are done with the glossary items, run the script
to generate the derived documentation content. Send patches for the generated :file:`spec2modules.py` to generate the derived documentation content. Send
documentation and the specification to the :r:list:`devel` and follow the patches for the generated documentation and the specification to the
normal patch review process. :r:list:`devel` and follow the normal patch review process.
Interface Specification Interface Specification
----------------------- -----------------------