[PATCH 0/8] Generate documentation for managers

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Apr 21 13:49:58 UTC 2021


This patch adds the next round of generated documentation.  The first
free patches just split up the existing documentation into multiple
files so that parts of it can be generated.  The fourth patch adds new
glossar terms.  The other patches add the generated documentation for
the Initialization, Fatal Error, Multiprocessing, and Dual-Ported Memory
Managers.

Here is the updated document for review:

https://ftp.rtems.org/pub/rtems/people/sebh/c-user.pdf

Sebastian Huber (8):
  c-user: Split up initialization manager
  c-user: Split up fatal error manager
  c-user: Split up multiprocessing manager
  c-user: Add user extensions glossary terms
  c-user: Generate initialization manager docs
  c-user: Generate fatal error manager docs
  c-user: Generate multiprocessing manager docs
  c-user: Generate dual-ported memory manager docs

 c-user/dual-ported-memory/directives.rst      | 500 ++++++++++++------
 c-user/dual-ported-memory/introduction.rst    |  43 +-
 .../background.rst}                           | 300 -----------
 c-user/fatal-error/directives.rst             | 355 +++++++++++++
 c-user/fatal-error/index.rst                  |  17 +
 c-user/fatal-error/introduction.rst           |  57 ++
 c-user/fatal-error/operations.rst             |  51 ++
 c-user/glossary.rst                           |  40 +-
 c-user/index.rst                              |   6 +-
 c-user/initialization/background.rst          |  48 ++
 c-user/initialization/directives.rst          |  69 +++
 c-user/initialization/index.rst               |  15 +
 c-user/initialization/introduction.rst        |  39 ++
 .../operations.rst}                           |  98 ----
 .../background.rst}                           |  89 ----
 c-user/multiprocessing/directives.rst         |  74 +++
 c-user/multiprocessing/index.rst              |  17 +
 c-user/multiprocessing/introduction.rst       |  61 +++
 c-user/multiprocessing/operations.rst         |  13 +
 c-user/user-extensions/background.rst         |  13 +-
 20 files changed, 1234 insertions(+), 671 deletions(-)
 rename c-user/{fatal_error.rst => fatal-error/background.rst} (62%)
 create mode 100644 c-user/fatal-error/directives.rst
 create mode 100644 c-user/fatal-error/index.rst
 create mode 100644 c-user/fatal-error/introduction.rst
 create mode 100644 c-user/fatal-error/operations.rst
 create mode 100644 c-user/initialization/background.rst
 create mode 100644 c-user/initialization/directives.rst
 create mode 100644 c-user/initialization/index.rst
 create mode 100644 c-user/initialization/introduction.rst
 rename c-user/{initialization.rst => initialization/operations.rst} (80%)
 rename c-user/{multiprocessing.rst => multiprocessing/background.rst} (84%)
 create mode 100644 c-user/multiprocessing/directives.rst
 create mode 100644 c-user/multiprocessing/index.rst
 create mode 100644 c-user/multiprocessing/introduction.rst
 create mode 100644 c-user/multiprocessing/operations.rst

-- 
2.26.2



More information about the devel mailing list