Page MenuHomeFreeBSD

EVENTHANDLER(9): drop the list of event handlers
ClosedPublic

Authored by mhorne on Oct 6 2022, 6:54 PM.
Tags
None
Referenced Files
F102649655: D36895.diff
Fri, Nov 15, 8:18 AM
Unknown Object (File)
Sat, Oct 26, 8:54 AM
Unknown Object (File)
Sat, Oct 26, 8:54 AM
Unknown Object (File)
Sat, Oct 26, 8:54 AM
Unknown Object (File)
Sat, Oct 26, 8:40 AM
Unknown Object (File)
Sep 23 2024, 5:58 PM
Unknown Object (File)
Sep 23 2024, 10:42 AM
Unknown Object (File)
Sep 23 2024, 9:30 AM
Subscribers

Details

Summary

Maintaining a comprehensive list of event handlers in this man page is a
futile endeavor. It is entirely detached from the source code, and
therefore requires that anyone adding/removing an event handler have
prior knowledge of the list. Many do not, so it will naturally become
stale (and is).

This is demonstrated by the fact that there are currently 88 instances
of EVENTHANDLER_DECLARE() in the source tree, but the list contains 66
items.

Many of the descriptions do not offer much detail that could not be
gleaned from the handler name alone. It is a more effective strategy to
document the purpose/details of the event handler in a comment alongside
its declaration.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mhorne requested review of this revision.Oct 6 2022, 6:54 PM

I think this is fine. Without parameter info and some info about what kind of locks are held/may be acquired, this listing isn't useful. Certainly I always just look at the code.

This revision is now accepted and ready to land.Oct 6 2022, 7:47 PM