[PATCH] errno.3: ENODATA is an XSI STREAMS extension

[PATCH] errno.3: ENODATA is an XSI STREAMS extension

[Alejandro Colomar]

Reported-by: Mark Kettenis <kettenis@openbsd.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man3/errno.3 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/man3/errno.3 b/man3/errno.3
index fe9b7f715..48e3e63f3 100644
--- a/man3/errno.3
+++ b/man3/errno.3
@@ -403,7 +403,8 @@ No buffer space available (POSIX.1 (XSI STREAMS option)).
 .\" ENOCSI is defined but appears to be unused.
 .TP
 .B ENODATA
-No message is available on the STREAM head read queue (POSIX.1-2001).
+No message is available on the STREAM head read queue
+(POSIX.1-2001 (XSI STREAMS option).
 .TP
 .B ENODEV
 No such device (POSIX.1-2001).
-- 
2.30.1

Re: [PATCH] errno.3: ENODATA is an XSI STREAMS extension

[Jakub Wilk]

* Alejandro Colomar <alx.manpages@gmail.com>, 2021-03-20, 00:57:
>-No message is available on the STREAM head read queue (POSIX.1-2001).
>+No message is available on the STREAM head read queue
>+(POSIX.1-2001 (XSI STREAMS option).

The parentheses are unbalanced.

-- 
Jakub Wilk

Re: [PATCH] errno.3: ENODATA is an XSI STREAMS extension

[Alejandro Colomar (man-pages)]

On 3/20/21 10:58 AM, Jakub Wilk wrote:
> * Alejandro Colomar <alx.manpages@gmail.com>, 2021-03-20, 00:57:
>> -No message is available on the STREAM head read queue (POSIX.1-2001).
>> +No message is available on the STREAM head read queue
>> +(POSIX.1-2001 (XSI STREAMS option).
> 
> The parentheses are unbalanced.

D'oh!

Thanks,

Alex

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

[PATCH v2] errno.3: ENODATA is an XSI STREAMS extension

[Alejandro Colomar]

Reported-by: Mark Kettenis <kettenis@openbsd.org>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man3/errno.3 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/man3/errno.3 b/man3/errno.3
index fe9b7f715..48e3e63f3 100644
--- a/man3/errno.3
+++ b/man3/errno.3
@@ -403,7 +403,8 @@ No buffer space available (POSIX.1 (XSI STREAMS option)).
 .\" ENOCSI is defined but appears to be unused.
 .TP
 .B ENODATA
-No message is available on the STREAM head read queue (POSIX.1-2001).
+No message is available on the STREAM head read queue
+(POSIX.1-2001 (XSI STREAMS option)).
 .TP
 .B ENODEV
 No such device (POSIX.1-2001).
-- 
2.30.1

Re: [PATCH v2] errno.3: ENODATA is an XSI STREAMS extension

[Florian Weimer]

* Alejandro Colomar:

> Reported-by: Mark Kettenis <kettenis@openbsd.org>
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
> ---
>  man3/errno.3 | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/man3/errno.3 b/man3/errno.3
> index fe9b7f715..48e3e63f3 100644
> --- a/man3/errno.3
> +++ b/man3/errno.3
> @@ -403,7 +403,8 @@ No buffer space available (POSIX.1 (XSI STREAMS option)).
>  .\" ENOCSI is defined but appears to be unused.
>  .TP
>  .B ENODATA
> -No message is available on the STREAM head read queue (POSIX.1-2001).
> +No message is available on the STREAM head read queue
> +(POSIX.1-2001 (XSI STREAMS option)).
>  .TP
>  .B ENODEV
>  No such device (POSIX.1-2001).

Would it make sense to mention that this error code is reused for
extended attributes?

Re: [PATCH v2] errno.3: ENODATA is an XSI STREAMS extension

[Alejandro Colomar (man-pages)]

Hi Florian,

On 3/20/21 8:08 PM, Florian Weimer wrote:
> 
> Would it make sense to mention that this error code is reused for
> extended attributes?
> 

Hmm, I think so.  In fact, AFAICS in the man-pages, it is only used for
that:

[
$ grep -rn ENODATA man?
man2/setxattr.2:124:.B ENODATA
man2/setxattr.2:129:.\" .BR ENODATA
man2/getxattr.2:118:.B ENODATA
man2/getxattr.2:123:.\" .BR ENODATA
man2/removexattr.2:85:.B ENODATA
man2/removexattr.2:89:.\" .BR ENODATA
man3/errno.3:405:.B ENODATA
]

Proposal:

[
       ENODATA
              The  named  attribute does not exist, or the process
              has no access to this attribute.

              In POSIX.1-2001 (XSI STREAMS option), this error was
              described as  "No message is available on the STREAM
              head read queue".

]

What do you think about it?

Thanks,

Alex


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

Re: [PATCH v2] errno.3: ENODATA is an XSI STREAMS extension

[Florian Weimer]

* Alejandro Colomar:

> Proposal:
>
> [
>        ENODATA
>               The  named  attribute does not exist, or the process
>               has no access to this attribute.
>
>               In POSIX.1-2001 (XSI STREAMS option), this error was
>               described as  "No message is available on the STREAM
>               head read queue".
>
> ]
>
> What do you think about it?

Please reference xattr(7), so that it's clear what kind of attributes
are meant here.

[PATCH v3] errno.3: Fix ENODATA text

[Alejandro Colomar]

ENODATA is an XSI STREAMS extension (not base POSIX).

Linux reused the name for extended attributes.
The current manual pages don't use ENODATA with its POSIX
meaning, so use the xattr(7) specific text, and leave the POSIX
meaning for a secondary paragraph.

Reported-by: Mark Kettenis <kettenis@openbsd.org>
Reported-by: Florian Weimer <fw@deneb.enyo.de>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man3/errno.3 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/man3/errno.3 b/man3/errno.3
index fe9b7f715..eeb885823 100644
--- a/man3/errno.3
+++ b/man3/errno.3
@@ -403,7 +403,13 @@ No buffer space available (POSIX.1 (XSI STREAMS option)).
 .\" ENOCSI is defined but appears to be unused.
 .TP
 .B ENODATA
-No message is available on the STREAM head read queue (POSIX.1-2001).
+The named attribute does not exist,
+or the process has no access to this attribute; see
+.BR xattr (7).
+.IP
+In POSIX.1-2001 (XSI STREAMS option),
+this error was described as
+"No message is available on the STREAM head read queue".
 .TP
 .B ENODEV
 No such device (POSIX.1-2001).
-- 
2.30.1

Re: [PATCH v3] errno.3: Fix ENODATA text

[Michael Kerrisk (man-pages)]

Hi Alex,

On 3/20/21 9:01 PM, Alejandro Colomar wrote:
> ENODATA is an XSI STREAMS extension (not base POSIX).
> 
> Linux reused the name for extended attributes.
> The current manual pages don't use ENODATA with its POSIX
> meaning, so use the xattr(7) specific text, and leave the POSIX
> meaning for a secondary paragraph.

Thanks. Nice work on improving the patch!

Cheers,

Michael

> 
> Reported-by: Mark Kettenis <kettenis@openbsd.org>
> Reported-by: Florian Weimer <fw@deneb.enyo.de>
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
> ---
>  man3/errno.3 | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/man3/errno.3 b/man3/errno.3
> index fe9b7f715..eeb885823 100644
> --- a/man3/errno.3
> +++ b/man3/errno.3
> @@ -403,7 +403,13 @@ No buffer space available (POSIX.1 (XSI STREAMS option)).
>  .\" ENOCSI is defined but appears to be unused.
>  .TP
>  .B ENODATA
> -No message is available on the STREAM head read queue (POSIX.1-2001).
> +The named attribute does not exist,
> +or the process has no access to this attribute; see
> +.BR xattr (7).
> +.IP
> +In POSIX.1-2001 (XSI STREAMS option),
> +this error was described as
> +"No message is available on the STREAM head read queue".
>  .TP
>  .B ENODEV
>  No such device (POSIX.1-2001).
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

Re: [PATCH v3] errno.3: Fix ENODATA text

[Michael Kerrisk (man-pages)]

On 4/4/21 10:16 PM, Michael Kerrisk (man-pages) wrote:
> Hi Alex,
> 
> On 3/20/21 9:01 PM, Alejandro Colomar wrote:
>> ENODATA is an XSI STREAMS extension (not base POSIX).
>>
>> Linux reused the name for extended attributes.
>> The current manual pages don't use ENODATA with its POSIX
>> meaning, so use the xattr(7) specific text, and leave the POSIX
>> meaning for a secondary paragraph.
> 
> Thanks. Nice work on improving the patch!

Sorry -- and I meant to say: Patch applied.

Cheers,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/