Bug 190942 - aio_{cancel,error,return,suspend,waitcomplete} don't mention ENOSYS in the ERRORS section
Summary: aio_{cancel,error,return,suspend,waitcomplete} don't mention ENOSYS in the ER...
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Enji Cooper
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-06-11 18:20 UTC by Enji Cooper
Modified: 2025-03-28 02:41 UTC (History)
5 users (show)

See Also:


Attachments
Patch to manpages noting missing ENOSYS requirement (3.47 KB, patch)
2014-06-11 21:07 UTC, Enji Cooper
no flags Details | Diff
non-ATF ENOSYS testcase (610 bytes, text/plain)
2014-06-11 21:15 UTC, Enji Cooper
no flags Details
Patch to manpages noting missing ENOSYS requirement (3.41 KB, patch)
2025-03-01 02:19 UTC, Mark Linimon
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Enji Cooper freebsd_committer freebsd_triage 2014-06-11 18:20:48 UTC
The ERRORS section for aio_{fsync,mlock,read,write} mention ENOSYS (aio(4) support in optional), but aio_{cancel,error,return,suspend,waitcomplete} don't.
Comment 1 Enji Cooper freebsd_committer freebsd_triage 2014-06-11 21:06:50 UTC
I confirmed my assertion with the attached non-ATF testcase on FreeBSD 11-CURRENT without aio kldload'ed. I'll try to add an ATF testcase for it.
Comment 2 Enji Cooper freebsd_committer freebsd_triage 2014-06-11 21:07:54 UTC
Created attachment 143692 [details]
Patch to manpages noting missing ENOSYS requirement
Comment 3 Enji Cooper freebsd_committer freebsd_triage 2014-06-11 21:15:16 UTC
Created attachment 143693 [details]
non-ATF ENOSYS testcase
Comment 4 tsg168 2024-11-01 12:23:42 UTC
MARKED AS SPAM
Comment 5 Alexander Ziaee freebsd_triage 2024-11-18 05:55:43 UTC
Hello! Adding these errors and organization seems sane to me on 15-current, can you commit this? I don't have my computer to see if it still applies cleanly.
Comment 6 Mark Linimon freebsd_committer freebsd_triage 2025-03-01 02:19:58 UTC
Created attachment 258143 [details]
Patch to manpages noting missing ENOSYS requirement

^Triage: rebase patch.
Comment 7 Alexander Ziaee freebsd_triage 2025-03-23 07:04:45 UTC
The change seems good to me, can I commit this and close this bug?
Comment 8 Enji Cooper freebsd_committer freebsd_triage 2025-03-23 08:17:02 UTC
(In reply to Alexander Ziaee from comment #7)

I can take it since I submitted the original patch -- I'll stick it up on Phabricator soon!
Comment 9 commit-hook freebsd_committer freebsd_triage 2025-03-26 04:51:42 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=d97e44784bb5a510b7af7593c86cfbcff73855c4

commit d97e44784bb5a510b7af7593c86cfbcff73855c4
Author:     Enji Cooper <ngie@FreeBSD.org>
AuthorDate: 2025-03-25 21:57:52 +0000
Commit:     Enji Cooper <ngie@FreeBSD.org>
CommitDate: 2025-03-26 04:49:33 +0000

    aio_*(2): mention ENOSYS under ERRORS

    ENOSYS can occur if aio(4) is not loaded in the kernel. Document this
    behavior so consumers on FreeBSD can better understand that this is a
    possible scenario.

    Clean up the manpages slightly while here:
    - Sort `ERRORS` by errno(3).
    - Use `.Fx` instead of `FreeBSD`.

    MFC after:      2 weeks
    Reviewed by:    ziaee
    PR:             190942
    Differential Revision: https://reviews.freebsd.org/D49502

 lib/libsys/aio_cancel.2       |  7 +++++++
 lib/libsys/aio_error.2        |  7 +++++++
 lib/libsys/aio_fsync.2        |  7 +++++++
 lib/libsys/aio_mlock.2        |  7 +++++++
 lib/libsys/aio_read.2         | 11 ++++++++++-
 lib/libsys/aio_return.2       |  7 +++++++
 lib/libsys/aio_suspend.2      |  7 +++++++
 lib/libsys/aio_waitcomplete.2 | 11 +++++++++--
 lib/libsys/aio_write.2        | 11 ++++++++++-
 9 files changed, 71 insertions(+), 4 deletions(-)
Comment 10 commit-hook freebsd_committer freebsd_triage 2025-03-28 02:41:46 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=e24279e0f9e28ba0c1920cb539fc357568790c0a

commit e24279e0f9e28ba0c1920cb539fc357568790c0a
Author:     Enji Cooper <ngie@FreeBSD.org>
AuthorDate: 2025-03-27 19:26:59 +0000
Commit:     Enji Cooper <ngie@FreeBSD.org>
CommitDate: 2025-03-28 02:40:07 +0000

    Remove mentions of ENOSYS added in d97e44784bb5

    aio(4) is a hard requirement in the kernel as of f3215338ef82. The
    scenario that the patch was submitted for is no longer possible.

    This isn't a straight up revert since the previous change also addressed
    some minor issues.

    PR:             190942
    Reported by:    asomers
    MFC after:      2 weeks
    MFC with:       d97e44784bb5
    Fixes:          d97e44784bb5 ("aio_*(2): mention ENOSYS under ERRORS")
    Differential Revision: https://reviews.freebsd.org/D49541

 lib/libsys/aio_cancel.2       | 7 -------
 lib/libsys/aio_error.2        | 7 -------
 lib/libsys/aio_fsync.2        | 7 -------
 lib/libsys/aio_mlock.2        | 7 -------
 lib/libsys/aio_read.2         | 7 -------
 lib/libsys/aio_return.2       | 7 -------
 lib/libsys/aio_suspend.2      | 7 -------
 lib/libsys/aio_waitcomplete.2 | 7 -------
 lib/libsys/aio_write.2        | 7 -------
 9 files changed, 63 deletions(-)