[PATCH 0/8] Generate documentation for managers

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Feb 9 09:43:20 UTC 2021


This patch adds the next round of generated documentation.  Patches 1 to
3 try to unify the documentation accross managers.  The other patches
add the generated documentation for the Semaphore, Barrier, and User
Extensions Managers.

Here is the updated document for review:

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

Sebastian Huber (8):
  c-user: Clarify timer manager documentation
  c-user: Clarify event manager documentation
  c-user: Clarify partition manager documentation
  c-user: Add labels to the manager chapters
  c-user: Add control block acronyms
  c-user: Generate semaphore manager documentation
  c-user: Generate barrier manager documentation
  c-user: Generate user extensions manager docs

 c-user/barrier/directives.rst           |  569 +++++----
 c-user/barrier/index.rst                |    2 +
 c-user/barrier/introduction.rst         |   45 +-
 c-user/board_support_packages.rst       |    2 +-
 c-user/clock/index.rst                  |    2 +
 c-user/config/scheduler-general.rst     |    2 +-
 c-user/dual-ported-memory/index.rst     |    2 +
 c-user/event/directives.rst             |   60 +-
 c-user/event/index.rst                  |    2 +
 c-user/event/introduction.rst           |    2 +-
 c-user/glossary.rst                     |   14 +-
 c-user/interrupt/index.rst              |    2 +
 c-user/io/index.rst                     |    2 +
 c-user/message/index.rst                |    2 +
 c-user/object-services/index.rst        |    2 +
 c-user/partition/directives.rst         |    6 +
 c-user/partition/index.rst              |    2 +
 c-user/rate-monotonic/index.rst         |    2 +
 c-user/region/index.rst                 |    2 +
 c-user/scheduling-concepts/index.rst    |    2 +-
 c-user/semaphore/directives.rst         | 1485 ++++++++++++++---------
 c-user/semaphore/index.rst              |    2 +
 c-user/semaphore/introduction.rst       |   52 +-
 c-user/signal/index.rst                 |    2 +
 c-user/task/index.rst                   |    2 +
 c-user/timer/directives.rst             |  198 ++-
 c-user/timer/index.rst                  |    2 +
 c-user/timer/introduction.rst           |    2 +-
 c-user/user-extensions/directives.rst   |  326 +++--
 c-user/user-extensions/index.rst        |    2 +-
 c-user/user-extensions/introduction.rst |   36 +-
 31 files changed, 1865 insertions(+), 968 deletions(-)

-- 
2.26.2



More information about the devel mailing list