Add "CONSTRAINTS" section do directive documentation?

[Peter Dufault]

Totally agree.

> On Jan 20, 2021, at 10:58 , Gedare Bloom <gedare at rtems.org> wrote:
> 
> I think this seems reasonable.
> 
> On Wed, Jan 20, 2021 at 3:48 AM Sebastian Huber <sebastian.huber at embedded-brains.de> wrote:
> Hello,
> 
> I would like to add a "CONSTRAINTS" section to the directive
> documentation (after or before the NOTES). For example in the NOTES of
> rtems_timer_create()
> 
> https://docs.rtems.org/branches/master/c-user/timer/directives.html#rtems-timer-create
> 
> 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
> automatically:
> 
> https://docs.rtems.org/branches/master/c-user/interrupt/operations.html#directives-allowed-from-an-isr
> 
> --
> embedded brains GmbH
> Herr Sebastian HUBER
> Dornierstr. 4
> 82178 Puchheim
> Germany
> email: sebastian.huber at embedded-brains.de
> 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:
> https://embedded-brains.de/datenschutzerklaerung/
> 
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel

Peter
-----------------
Peter Dufault
HD Associates, Inc.      Software and System Engineering

This email is delivered through the public internet using protocols subject to interception and tampering.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 235 bytes
Desc: Message signed with OpenPGP
URL: <http://lists.rtems.org/pipermail/devel/attachments/20210120/b79b7b75/attachment.bin>