Add "CONSTRAINTS" section do directive documentation?

Sebastian Huber sebastian.huber at
Wed Jan 20 10:48:51 UTC 2021


I would like to add a "CONSTRAINTS" section to the directive 
documentation (after or before the NOTES). For example in the NOTES of 

we have "This directive may cause the calling task to be preempted due 
to an obtain and release of the object allocator mutex.".

I would like to move this to a CONSTRAINTS section and use a link in the 
specification to indicate this. Other examples for constraints are:

* the allowed environment to call the directive (task context, interrupt 
context, device driver initialization, etc.)

* dependency on a clock tick (directives with RTEMS_WAIT and a timeout)

Due to the links in the specification we can generate list like this 

embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
email: sebastian.huber at
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:

More information about the devel mailing list