[PATCH v2 00/12] Generate documentation for managers

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Feb 10 16:27:57 UTC 2021


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

Here is the updated document for review:

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

v2:

- Use EARS syntax for pointer parameters.

- Document MrsP semaphore constraint

- Document extension set parameter

- Generate clock manager documentation

Sebastian Huber (12):
  c-user: Clarify timer manager documentation
  c-user: Clarify event manager documentation
  c-user: Clarify partition manager documentation
  c-user: Clarify IO manager documentation
  c-user: Clarify object services documentation
  c-user: Add labels to the manager chapters
  c-user: Add control block acronyms
  c-user: Move deprecated/removed directives
  c-user: Generate semaphore manager documentation
  c-user: Generate barrier manager documentation
  c-user: Generate user extensions manager docs
  c-user: Generate clock manager documentation

 c-user/barrier/directives.rst           |  566 +++++----
 c-user/barrier/index.rst                |    2 +
 c-user/barrier/introduction.rst         |   45 +-
 c-user/board_support_packages.rst       |    2 +-
 c-user/clock/directives.rst             |  874 +++++++------
 c-user/clock/index.rst                  |    3 +
 c-user/clock/introduction.rst           |   83 +-
 c-user/clock/removed-directives.rst     |   81 ++
 c-user/config/scheduler-general.rst     |    2 +-
 c-user/dual-ported-memory/index.rst     |    2 +
 c-user/event/directives.rst             |   57 +-
 c-user/event/index.rst                  |    2 +
 c-user/event/introduction.rst           |    2 +-
 c-user/glossary.rst                     |   67 +-
 c-user/interrupt/index.rst              |    2 +
 c-user/io/directives.rst                |    6 +-
 c-user/io/index.rst                     |    2 +
 c-user/message/index.rst                |    2 +
 c-user/object-services/directives.rst   |   12 +-
 c-user/object-services/index.rst        |    2 +
 c-user/partition/directives.rst         |   24 +-
 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/deprecated-directives.rst   |   46 +
 c-user/task/index.rst                   |    4 +
 c-user/task/removed-directives.rst      |  283 +++++
 c-user/timer/directives.rst             |  212 +++-
 c-user/timer/index.rst                  |    2 +
 c-user/timer/introduction.rst           |    2 +-
 c-user/user-extensions/directives.rst   |  330 +++--
 c-user/user-extensions/index.rst        |    2 +-
 c-user/user-extensions/introduction.rst |   36 +-
 38 files changed, 2913 insertions(+), 1391 deletions(-)
 create mode 100644 c-user/clock/removed-directives.rst
 create mode 100644 c-user/task/deprecated-directives.rst
 create mode 100644 c-user/task/removed-directives.rst

-- 
2.26.2



More information about the devel mailing list