Date: Tue, 18 Oct 2022 14:10:26 GMT From: Mitchell Horne <mhorne@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Subject: git: abd68709a99d - stable/13 - EVENTHANDLER(9): drop the list of event handlers Message-ID: <202210181410.29IEAQR9001723@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=abd68709a99d95fb500754a2b7f2e5bd16d334af commit abd68709a99d95fb500754a2b7f2e5bd16d334af Author: Mitchell Horne <mhorne@FreeBSD.org> AuthorDate: 2022-10-07 22:25:12 +0000 Commit: Mitchell Horne <mhorne@FreeBSD.org> CommitDate: 2022-10-18 14:08:21 +0000 EVENTHANDLER(9): drop the list of event handlers 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. Reviewed by: markj MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D36895 (cherry picked from commit 34aac98e3511d90df9209204df6772935a2b7617) --- share/man/man9/EVENTHANDLER.9 | 146 +----------------------------------------- 1 file changed, 1 insertion(+), 145 deletions(-) diff --git a/share/man/man9/EVENTHANDLER.9 b/share/man/man9/EVENTHANDLER.9 index b369e2f03258..82480ce1dc71 100644 --- a/share/man/man9/EVENTHANDLER.9 +++ b/share/man/man9/EVENTHANDLER.9 @@ -23,7 +23,7 @@ .\" SUCH DAMAGE. .\" $FreeBSD$ .\" -.Dd September 17, 2020 +.Dd October 7, 2022 .Dt EVENTHANDLER 9 .Os .Sh NAME @@ -258,150 +258,6 @@ The function removes all deregistered callbacks from the event list .Fa list . .El -.Ss Kernel Event Handlers -The following event handlers are present in the kernel: -.Bl -tag -width indent -.It Vt acpi_sleep_event -Callbacks invoked when the system is being sent to sleep. -.It Vt acpi_wakeup_event -Callbacks invoked when the system is being woken up. -.It Vt app_coredump_start -Callbacks invoked at start of application core dump. -.It Vt app_coredump_progress -Callbacks invoked during progress of application core dump. -.It Vt app_coredump_finish -Callbacks invoked at finish of application core dump. -.It Vt app_coredump_error -Callbacks invoked on error of application core dump. -.It Vt bpf_track -Callbacks invoked when a BPF listener attaches to/detaches from network interface. -.It Vt cpufreq_levels_changed -Callback invoked when cpu frequency levels have changed. -.It Vt cpufreq_post_change -Callback invoked after cpu frequency has changed. -.It Vt cpufreq_pre_change -Callback invoked before cpu frequency has changed. -.It Vt dcons_poll -Callback invoked to poll for dcons changes. -.It Vt device_attach -Callback invoked after a device has attached. -.It Vt device_detach -Callbacks invoked before and after a device has detached. -.It Vt dev_clone -Callbacks invoked when a new entry is created under -.Pa /dev . -.It Vt group_attach_event -Callback invoked when an interfance has been added to an interface group. -.It Vt group_change_event -Callback invoked when an change has been made to an interface group. -.It Vt group_detach_event -Callback invoked when an interfance has been removed from an interface group. -.It Vt ifaddr_event -Callbacks invoked when an address is set up on a network interface. -.It Vt ifaddr_event_ext -Callback invoked when an address has been added or removed from an interface. -.It Vt if_clone_event -Callbacks invoked when an interface is cloned. -.It Vt iflladdr_event -Callback invoked when an if link layer address event has happened. -.It Vt ifnet_arrival_event -Callbacks invoked when a new network interface appears. -.It Vt ifnet_departure_event -Callbacks invoked when a network interface is taken down. -.It Vt ifnet_link_event -Callback invoked when an interfance link event has happened. -.It Vt kld_load -Callbacks invoked after a linker file has been loaded. -.It Vt kld_unload -Callbacks invoked after a linker file has been successfully unloaded. -.It Vt kld_unload_try -Callbacks invoked before a linker file is about to be unloaded. -These callbacks may be used to return an error and prevent the unload from -proceeding. -.It Vt livedumper_start -Callback invoked before beginning a kernel dump of the live system. -.It Vt livedumper_dump -Callback invoked for each dumped block of data during a live kernel dump. -.It Vt livedumper_finish -Callback invoked once a live kernel dump has completed. -.It Vt lle_event -Callback invoked when a link layer event has happened. -.It Vt nmbclusters_change -Callback invoked when the number of mbuf clusters has changed. -.It Vt nmbufs_change -Callback invoked when the number of mbufs has changed. -.It Vt maxsockets_change -Callback invoked when the maximum number of sockets has changed. -.It Vt mountroot -Callback invoked when root has been mounted. -.It Vt power_profile_change -Callbacks invoked when the power profile of the system changes. -.It Vt power_resume -Callback invoked when the system has resumed. -.It Vt power_suspend -Callback invoked just before the system is suspended. -.It Vt process_ctor -Callback invoked when a process is created. -.It Vt process_dtor -Callback invoked when a process is destroyed. -.It Vt process_exec -Callbacks invoked when a process performs an -.Fn exec -operation. -.It Vt process_exit -Callbacks invoked when a process exits. -.It Vt process_fini -Callback invoked when a process memory is destroyed. -This is never called. -.It Vt process_fork -Callbacks invoked when a process forks a child. -.It Vt process_init -Callback invoked when a process is initialized. -.It Vt random_adaptor_attach -Callback invoked when a new random module has been loaded. -.It Vt register_framebuffer -Callback invoked when a new frame buffer is registered. -.It Vt route_redirect_event -Callback invoked when a route gets redirected to a new location. -.It Vt shutdown_pre_sync -Callbacks invoked at shutdown time, before file systems are synchronized. -.It Vt shutdown_post_sync -Callbacks invoked at shutdown time, after all file systems are synchronized. -.It Vt shutdown_final -Callbacks invoked just before halting the system. -.It Vt tcp_offload_listen_start -Callback invoked for TCP Offload to start listening for new connections. -.It Vt tcp_offload_listen_stop -Callback invoked ror TCP Offload to stop listening for new connections. -.It Vt thread_ctor -Callback invoked when a thread object is created. -.It Vt thread_dtor -Callback invoked when a thread object is destroyed. -.It Vt thread_init -Callback invoked when a thread object is initialized. -.It Vt thread_fini -Callback invoked when a thread object is deinitalized. -.It Vt usb_dev_configured -Callback invoked when a USB device is configured -.It Vt unregister_framebuffer -Callback invoked when a frame buffer is deregistered. -.It Vt vfs_mounted -Callback invoked when a file system is mounted. -.It Vt vfs_unmounted -Callback invoked when a file system is unmounted. -.It Vt vlan_config -Callback invoked when the vlan configuration has changed. -.It Vt vlan_unconfig -Callback invoked when a vlan is destroyed. -.It Vt vm_lowmem -Callbacks invoked when virtual memory is low. -.It Vt vxlan_start -Callback invoked when a vxlan interface starts. -.It Vt vxlan_stop -Callback invoked when a vxlan interface stops. -.It Vt watchdog_list -Callbacks invoked when the system watchdog timer is reinitialized. -.El .Sh RETURN VALUES The macro .Fn EVENTHANDLER_REGISTER
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202210181410.29IEAQR9001723>