Bug 28915

Summary: inconsistency in a man page (versus KERNEL config)
Product: Documentation Reporter: thierry <thierry>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description thierry 2001-07-12 14:50:00 UTC
the man page for mkfifo(2) says :
--------------
ERRORS
     Mkfifo() will fail and no fifo will be created if:

     [ENOTSUP] The kernel has not been configured to support fifo's.
--------------

I do not see any FIFO config option in the LINT kernel config file, thus the man page seems to be wrong : it is not possible to compile a FreeBSD kernel without FIFO's

Fix: 

the manual lines cited should be removed
Comment 1 dima 2001-07-13 15:49:38 UTC
Thierry Herbelot <thierry@herbelot.com> writes:
> >Description:
> the man page for mkfifo(2) says :
> --------------
> ERRORS
>      Mkfifo() will fail and no fifo will be created if:
> 
>      [ENOTSUP] The kernel has not been configured to support fifo's.
> --------------
> 

> I do not see any FIFO config option in the LINT kernel config file,
> thus the man page seems to be wrong : it is not possible to compile
> a FreeBSD kernel without FIFO's

Man pages for calls that are defined by some standard (in this case,
by POSIX.2) should document all allowed error returns even if they
aren't possible in FreeBSD today.  This allows program authors to
write portable code; portable not only across platforms, but across
different versions of FreeBSD (who's to say there won't be a kernel
option for this tomorrow?).
Comment 2 alex freebsd_committer freebsd_triage 2001-08-06 14:39:12 UTC
State Changed
From-To: open->closed

As Dima pointed out, this return code is for 
compatibility.  Remember software that is ported to other 
OSes.