Subject: Re: wrap up of pipe(2)
To: der Mouse <mouse@Rodents.Montreal.QC.CA>
From: Jaromír <jdolecek@netbsd.org>
List: tech-userlevel
Date: 10/10/2001 19:06:28
der Mouse wrote:
> If you remove EFAULT because the pages are supposed to be exactly and
> only what NetBSD does, there are a lot of other things that should be
> cleaned up too - for example, memcpy() should be documented identically
> to bcopy(), with the current BUGS section removed.

That is going too far ;-) My aim is to have _accurate_ manpages. Our
manpages should not claim something behaves some way when it doesn't.

This is the change I'm going to commit:

Index: sys/pipe.2
===================================================================
RCS file: /cvsroot/basesrc/lib/libc/sys/pipe.2,v
retrieving revision 1.14
diff -u -p -r1.14 pipe.2
--- sys/pipe.2	2001/10/02 02:55:41	1.14
+++ sys/pipe.2	2001/10/10 17:04:58
@@ -97,13 +97,6 @@ call will fail if:
 Too many descriptors are active.
 .It Bq Er ENFILE
 The system file table is full.
-.It Bq Er EFAULT
-The
-.Fa fildes
-buffer is in an invalid area of the process's address space.  
-The reliable detection of this error cannot be guaranteed and when not
-detected may result in the generation of a signal, indicating an
-address violation, which is sent to the process.
 .El
 .Sh SEE ALSO
 .Xr sh 1 ,
@@ -121,3 +114,11 @@ A
 .Fn pipe
 function call appeared in
 .At v6 .
+.Sh NOTES
+If the
+.Fa fildes
+buffer is in invalid area of the process's address space, process
+receives signal indicating an address violation. On some other systems,
+the call might just return with error
+.Bq Er EFAULT
+in this case.

Jaromir
-- 
Jaromir Dolecek <jdolecek@NetBSD.org>      http://www.ics.muni.cz/~dolecek/
NetBSD - just plain best OS! -=*=- Got spare MCA cards or docs? Hand me them!