Page MenuHomeFreeBSD

Remove BUGS from aio_write(2)
Needs RevisionPublic

Authored by felix.the.red_gmail.com on Jun 25 2025, 9:20 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Oct 19, 3:18 AM
Unknown Object (File)
Sun, Oct 19, 2:27 AM
Unknown Object (File)
Mon, Oct 6, 9:44 PM
Unknown Object (File)
Sun, Oct 5, 7:03 AM
Unknown Object (File)
Sep 17 2025, 11:17 AM
Unknown Object (File)
Sep 16 2025, 8:21 AM
Unknown Object (File)
Sep 15 2025, 7:28 PM
Unknown Object (File)
Sep 10 2025, 10:13 AM
Subscribers

Details

Reviewers
0mp
obiwac
Group Reviewers
manpages
Summary

lib/libsys/aio_write.2: Remove BUGS section.

From the original PR:
The note "Invalid information in iocb->_aiocb_private may confuse the kernel."
is in the BUGS section. AFAICT, it's __aiocb_private, not _aiocb_private (double underscore)
which also hints strongly on a private implementation defined symbol,
which isn't documented properly (header file even says, don't touch directly).
Suggest cutting the BUGS section from aio_write(3) altogether.

PR:210468

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

0mp added a subscriber: 0mp.

Seems OK.

This revision is now accepted and ready to land.Jul 13 2025, 11:43 AM
0mp requested changes to this revision.Jul 13 2025, 12:08 PM

Actually, I'm not sure if this section should be removed. I posted a comment in Bugzilla about it.

At the very least, the commit message should explain why the message was there in the first place and why it is no longer needed.

This revision now requires changes to proceed.Jul 13 2025, 12:08 PM

The BUGS section is original to lib/libsys/aio_write.2.

Why was it there? Because Wes Peters put it in there in 1999.
Why did I try to remove it? A PR.

I will wait for further instructions.