Hi,

Theo de Raadt wrote on Sun, Dec 22, 2019 at 05:34:45PM -0700:
> Philip Guenther <[email protected]> wrote:
>> Somebody wrote:

>>> The man pages for readv and writev don't document the possibility of
>>> such errors.

>> IMO, weird errnos from devices should be documented in the manpage for the
>> device.  Consider the termios(4) manpage, for example.

> I agree on that.  Otherwise the information-flood is too much.
> 
> But I think some of our manual pages are a bit weak indicating there
> are other errors not listed:

Is the following good enough?

Or are you saying that *all* section 2 and 3 manual pages should be
reworded to say:  "FOOBAR may for example fail if:"?

Yours,
  Ingo


Index: read.2
===================================================================
RCS file: /cvs/src/lib/libc/sys/read.2,v
retrieving revision 1.36
diff -u -r1.36 read.2
--- read.2      30 Sep 2016 10:53:11 -0000      1.36
+++ read.2      23 Dec 2019 13:58:41 -0000
@@ -228,6 +228,11 @@
 .Fa iov
 points outside the process's allocated address space.
 .El
+.Pp
+The driver of the device that is being read from
+may return additional errors.
+Such device-specific errors may be documented
+in the section 4 manual pages of the respective drivers.
 .Sh SEE ALSO
 .Xr dup 2 ,
 .Xr fcntl 2 ,
Index: write.2
===================================================================
RCS file: /cvs/src/lib/libc/sys/write.2,v
retrieving revision 1.42
diff -u -r1.42 write.2
--- write.2     6 Sep 2019 19:25:08 -0000       1.42
+++ write.2     23 Dec 2019 13:58:41 -0000
@@ -286,6 +286,11 @@
 .It Bq Er ENOBUFS
 The system lacked sufficient buffer space or a queue was full.
 .El
+.Pp
+The driver of the device that is being written to
+may return additional errors.
+Such device-specific errors may be documented
+in the section 4 manual pages of the respective drivers.
 .Sh SEE ALSO
 .Xr fcntl 2 ,
 .Xr lseek 2 ,

Reply via email to