<div dir="ltr">I think this seems reasonable.</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Jan 20, 2021 at 3:48 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">Hello,<br>
<br>
I would like to add a "CONSTRAINTS" section to the directive <br>
documentation (after or before the NOTES). For example in the NOTES of <br>
rtems_timer_create()<br>
<br>
<a href="https://docs.rtems.org/branches/master/c-user/timer/directives.html#rtems-timer-create" rel="noreferrer" target="_blank">https://docs.rtems.org/branches/master/c-user/timer/directives.html#rtems-timer-create</a><br>
<br>
we have "This directive may cause the calling task to be preempted due <br>
to an obtain and release of the object allocator mutex.".<br>
<br>
I would like to move this to a CONSTRAINTS section and use a link in the <br>
specification to indicate this. Other examples for constraints are:<br>
<br>
* the allowed environment to call the directive (task context, interrupt <br>
context, device driver initialization, etc.)<br>
<br>
* dependency on a clock tick (directives with RTEMS_WAIT and a timeout)<br>
<br>
Due to the links in the specification we can generate list like this <br>
automatically:<br>
<br>
<a href="https://docs.rtems.org/branches/master/c-user/interrupt/operations.html#directives-allowed-from-an-isr" rel="noreferrer" target="_blank">https://docs.rtems.org/branches/master/c-user/interrupt/operations.html#directives-allowed-from-an-isr</a><br>
<br>
-- <br>
embedded brains GmbH<br>
Herr Sebastian HUBER<br>
Dornierstr. 4<br>
82178 Puchheim<br>
Germany<br>
email: <a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a><br>
phone: +49-89-18 94 741 - 16<br>
fax:   +49-89-18 94 741 - 08<br>
<br>
Registergericht: Amtsgericht München<br>
Registernummer: HRB 157899<br>
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler<br>
Unsere Datenschutzerklärung finden Sie hier:<br>
<a href="https://embedded-brains.de/datenschutzerklaerung/" rel="noreferrer" target="_blank">https://embedded-brains.de/datenschutzerklaerung/</a><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></blockquote></div>