Re: man pthread_join(3)

["Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>]

[CC += Branden]

Hello Aitch,

On 2/10/22 01:42, hk wrote:
> Good day
> 
> I'm not sure that is a bug or I'm missing something, but still.
> 
> There is man-page for pthread_join() function and in its "ERRORS"
> section one
> error code - EINVAL - is mentioned twice with different causes, so I
> have doubts
> about how to handle such of an error.
> 
> Here is a link https://man7.org/linux/man-pages/man3/pthread_join.3.html
> 
> Could you correct that if it is a mistype? Or, may be add some kind of
> explanation for that kind of situation.

It's just that there's more than one reason you could get that error.

Other Unix systems' manual pages also use this syntax[1][2].  At first
it also seemed weird to me, I'll admit.

I don't know if some other syntax could be easier to read/understand...

Maybe something like:


[
EXXX   Reason for EXXX.

EYYY

       * One reason for EYYY.

       * Another reason for EYYY.
]



[1]:
<https://www.freebsd.org/cgi/man.cgi?query=open&apropos=0&sektion=2&manpath=FreeBSD+13.0-RELEASE+and+Ports&arch=default&format=html#ERRORS>

[2]: <https://man.openbsd.org/open.2#ERRORS>


Thanks,

Alex


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/