Bug 39748

Summary: [PATCH] Some changes to aio_*(2)
Product: Documentation Reporter: Philipp Mergenthaler <philipp.mergenthaler>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
file.diff
none
aio-patch.txt none

Description Philipp Mergenthaler 2002-06-24 02:10:00 UTC
1)
 - aio_read(2) has a DIAGNOSTICS section, which isn't appropriate for
    a system call
 - aio_read(2) and aio_write(2) lack Xrefs to the other aio_*(2) calls
 - all aio_*(2) pages lack an Xref to aio_waitcomplete(2)
 - in aio_cancel(2), aio_return(2) and aio_suspend(2), the "SEE ALSO"
   section comes before the ERRORS section

2)
  The aio_* system calls are only available if the kernel has been
  configured with "options VFS_AIO".  IMHO, this should be mentioned
  in the man pages.

Fix: The first patch fixes the bugs listed in 1).  The second patch adds
a comment to all aio_* man pages about the kernel option.  I also
mention LINT/NOTES because of a security-related warning there.
This could perhaps be formulated better :-)

(There isn't a macro which, under RELENG_4 evaluates to "LINT" and,
under -current, evaluates to "NOTES", is there?)
Comment 1 Craig Rodrigues 2002-10-22 06:22:42 UTC
Hi,

I would like to submit another patch, it is similar
to docs/39748, but includes wording to instruct
the user to kldload aio if the VFS_AIO is
not specified in the kernel config file.

-- 
Craig Rodrigues        
http://www.gis.net/~craigr    
rodrigc@attbi.com
Comment 2 Alfred Perlstein freebsd_committer freebsd_triage 2002-10-22 17:13:41 UTC
State Changed
From-To: open->closed

I have committed a variant of this delta to 5.x. 
thank you!