[PATCH] score: Document Futex Handler

[Joel Sherrill]

On Wed, Sep 1, 2021 at 7:04 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
>
>
> On 01/09/2021 14:03, Joel Sherrill wrote:
> >
> >
> > On Wed, Sep 1, 2021, 12:06 AM Sebastian Huber
> > <sebastian.huber at embedded-brains.de
> > <mailto:sebastian.huber at embedded-brains.de>> wrote:
> >
> >     On 31/08/2021 22:31, Joel Sherrill wrote:
> >      > On Tue, Aug 31, 2021, 7:31 AM Sebastian Huber
> >      > <sebastian.huber at embedded-brains.de
> >     <mailto:sebastian.huber at embedded-brains.de>
> >      > <mailto:sebastian.huber at embedded-brains.de
> >     <mailto:sebastian.huber at embedded-brains.de>>> wrote:
> >      >
> >      >     Use EAGIN instead of EWOULDBLOCK to be in line with the Linux
> >     man page.
> >      >
> >      >
> >      > EAGAIN AND Linux man page for what?
> >
> >     The behaviour of the futex operations is defined by Linux:
> >
> >     https://man7.org/linux/man-pages/man2/futex.2.html
> >     <https://man7.org/linux/man-pages/man2/futex.2.html>
> >
> >     Using the same error numbers helps to avoid confusion.
> >
> >     When you look at the history of the Linux man page you see that they
> >     replaced EWOULDBLOCK with EAGAIN over time. At the time of the RTEMS
> >     futex implementation they used EWOULDBLOCK.
> >
> >
> > Thanks. Just toss that in the commit. And perhaps somewhere the
> > documentation should say this is aligned with Linux
>
> Maybe something like this from the commit?

That looks good. Our future selves will appreciate the hint that this
is intended
to follow that API.

The comment says behaviour. Do we provide a compatible API at some level?
>
> +/**
> + * @defgroup RTEMSScoreFutex Futex Handler
> + *
> + * @ingroup RTEMSScore
> + *
> + * @brief This group contains the Futex Handler implementation.
> + *
> + * The behaviour of the futex operations is defined by Linux, see also:
> + *
> + * https://man7.org/linux/man-pages/man2/futex.2.html
> + */
>
> --
> 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/