<div dir="ltr">Is (will be) there a section to explain the Constraints and how to interpret them? Mainly, what kind of constraints are specified, and what should be assumed (like, if a directive does not say it can be called from thread context, then it implicitly cannot)?</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Feb 10, 2021 at 9:28 AM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de">sebastian.huber@embedded-brains.de</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">This patch adds the next round of generated documentation. Patches 1 to<br>
5 try to unify the documentation accross managers. The other patches<br>
add the generated documentation for the Semaphore, Barrier, User<br>
Extensions, and Clock Managers.<br>
<br>
Here is the updated document for review:<br>
<br>
<a href="https://ftp.rtems.org/pub/rtems/people/sebh/c-user.pdf" rel="noreferrer" target="_blank">https://ftp.rtems.org/pub/rtems/people/sebh/c-user.pdf</a><br>
<br>
v2:<br>
<br>
- Use EARS syntax for pointer parameters.<br>
<br>
- Document MrsP semaphore constraint<br>
<br>
- Document extension set parameter<br>
<br>
- Generate clock manager documentation<br>
<br>
Sebastian Huber (12):<br>
c-user: Clarify timer manager documentation<br>
c-user: Clarify event manager documentation<br>
c-user: Clarify partition manager documentation<br>
c-user: Clarify IO manager documentation<br>
c-user: Clarify object services documentation<br>
c-user: Add labels to the manager chapters<br>
c-user: Add control block acronyms<br>
c-user: Move deprecated/removed directives<br>
c-user: Generate semaphore manager documentation<br>
c-user: Generate barrier manager documentation<br>
c-user: Generate user extensions manager docs<br>
c-user: Generate clock manager documentation<br>
<br>
c-user/barrier/directives.rst | 566 +++++----<br>
c-user/barrier/index.rst | 2 +<br>
c-user/barrier/introduction.rst | 45 +-<br>
c-user/board_support_packages.rst | 2 +-<br>
c-user/clock/directives.rst | 874 +++++++------<br>
c-user/clock/index.rst | 3 +<br>
c-user/clock/introduction.rst | 83 +-<br>
c-user/clock/removed-directives.rst | 81 ++<br>
c-user/config/scheduler-general.rst | 2 +-<br>
c-user/dual-ported-memory/index.rst | 2 +<br>
c-user/event/directives.rst | 57 +-<br>
c-user/event/index.rst | 2 +<br>
c-user/event/introduction.rst | 2 +-<br>
c-user/glossary.rst | 67 +-<br>
c-user/interrupt/index.rst | 2 +<br>
c-user/io/directives.rst | 6 +-<br>
c-user/io/index.rst | 2 +<br>
c-user/message/index.rst | 2 +<br>
c-user/object-services/directives.rst | 12 +-<br>
c-user/object-services/index.rst | 2 +<br>
c-user/partition/directives.rst | 24 +-<br>
c-user/partition/index.rst | 2 +<br>
c-user/rate-monotonic/index.rst | 2 +<br>
c-user/region/index.rst | 2 +<br>
c-user/scheduling-concepts/index.rst | 2 +-<br>
c-user/semaphore/directives.rst | 1485 ++++++++++++++---------<br>
c-user/semaphore/index.rst | 2 +<br>
c-user/semaphore/introduction.rst | 52 +-<br>
c-user/signal/index.rst | 2 +<br>
c-user/task/deprecated-directives.rst | 46 +<br>
c-user/task/index.rst | 4 +<br>
c-user/task/removed-directives.rst | 283 +++++<br>
c-user/timer/directives.rst | 212 +++-<br>
c-user/timer/index.rst | 2 +<br>
c-user/timer/introduction.rst | 2 +-<br>
c-user/user-extensions/directives.rst | 330 +++--<br>
c-user/user-extensions/index.rst | 2 +-<br>
c-user/user-extensions/introduction.rst | 36 +-<br>
38 files changed, 2913 insertions(+), 1391 deletions(-)<br>
create mode 100644 c-user/clock/removed-directives.rst<br>
create mode 100644 c-user/task/deprecated-directives.rst<br>
create mode 100644 c-user/task/removed-directives.rst<br>
<br>
-- <br>
2.26.2<br>
<br>
_______________________________________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a><br>
</blockquote></div>