Bug 212103 - ENODATA documentation error
Summary: ENODATA documentation error
Status: RESOLVED DOCUMENTED
Alias: None
Product: Documentation
Classification: Unclassified
Component: man-pages (show other bugs)
Hardware: All Linux
: P1 normal
Assignee: documentation_man-pages@kernel-bugs.osdl.org
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-03-07 13:46 UTC by Mark Kettenis
Modified: 2021-03-19 23:12 UTC (History)
1 user (show)

See Also:
Kernel Version:
Subsystem:
Regression: No
Bisected commit-id:


Attachments

Description Mark Kettenis 2021-03-07 13:46:53 UTC
The documentation for the ENODATA incorrectly documents it as (POSIX.1-2001).  This error value is part of the (obsolete) XSI STREAMS option so it should be documented as (POSIX.1 (XSI STREAMS option)).  This is important since ENODATA
should not be used in portable software as implementation of the options is, well, optional.  This is especially important for the XSI STREAMS option since that option has been marked as obsolete for more than a decade now.

Also note that ENOBUFS is also documented incorrectly.  This error value is properly part of POSIX and not part of the XSI STREAMS option, so it should be part of (POSIX.1-2001).
Comment 1 Alejandro Colomar 2021-03-19 23:12:22 UTC
Hi Mark,

Thanks for the report!

I applied the following patch:
<https://github.com/alejandro-colomar/man-pages/commit/f2b03a66a862c6110a4e19803b21f951b2e418e8>

Cheers,

Alex

Note You need to log in before you can comment on or make changes to this bug.