From owner-freebsd-doc@freebsd.org  Wed Jun 22 16:02:00 2016
Return-Path: <owner-freebsd-doc@freebsd.org>
Delivered-To: freebsd-doc@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 7D6C0AC571D
 for <freebsd-doc@mailman.ysv.freebsd.org>;
 Wed, 22 Jun 2016 16:02:00 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from kenobi.freebsd.org (kenobi.freebsd.org
 [IPv6:2001:1900:2254:206a::16:76])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 6DD102128
 for <freebsd-doc@FreeBSD.org>; Wed, 22 Jun 2016 16:02:00 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from bugs.freebsd.org ([127.0.1.118])
 by kenobi.freebsd.org (8.15.2/8.15.2) with ESMTP id u5MG20M6050397
 for <freebsd-doc@FreeBSD.org>; Wed, 22 Jun 2016 16:02:00 GMT
 (envelope-from bugzilla-noreply@freebsd.org)
From: bugzilla-noreply@freebsd.org
To: freebsd-doc@FreeBSD.org
Subject: [Bug 210469] aio_xxx(3) manpages do not detail struct aiocb
Date: Wed, 22 Jun 2016 16:02:00 +0000
X-Bugzilla-Reason: AssignedTo
X-Bugzilla-Type: new
X-Bugzilla-Watch-Reason: None
X-Bugzilla-Product: Documentation
X-Bugzilla-Component: Documentation
X-Bugzilla-Version: Latest
X-Bugzilla-Keywords: 
X-Bugzilla-Severity: Affects Only Me
X-Bugzilla-Who: freebsd-bugzilla@ayaken.net
X-Bugzilla-Status: New
X-Bugzilla-Resolution: 
X-Bugzilla-Priority: ---
X-Bugzilla-Assigned-To: freebsd-doc@FreeBSD.org
X-Bugzilla-Flags: 
X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform
 op_sys bug_status bug_severity priority component assigned_to reporter
Message-ID: <bug-210469-9@https.bugs.freebsd.org/bugzilla/>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/
Auto-Submitted: auto-generated
MIME-Version: 1.0
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 22 Jun 2016 16:02:00 -0000

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D210469

            Bug ID: 210469
           Summary: aio_xxx(3) manpages do not detail struct aiocb
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc@FreeBSD.org
          Reporter: freebsd-bugzilla@ayaken.net

compare aio_write(3) to poll(2). While the former mentions the structure
members scattered through the text, poll(2) gives a (view of the public
interface of) struct pollfd. This is helpful information as it prevents you
from hunting header files just to see the members of the struct you ought to
touch and is generally IMO preferable to just scattering member mentions
through the prose of the description.
Suggest documenting the (public API portion of) struct aiocb in aio_xxx(3)

--=20
You are receiving this mail because:
You are the assignee for the bug.=