kern_reboot(9): describe event handlers
ClosedPublic
Actions

Authored by mhorne on Mar 16 2023, 7:36 PM.

Details

Reviewers

markj
imp

Group Reviewers

manpages

Commits

rGf6f8cbda8efc: kern_reboot(9): describe event handlers

Summary

Add more details about the execution and purpose of these shutdown
handlers. Make a point to mention the requirement that they can be run
in a normal or panic context. Add a simple example of a shutdown_final
handler.

Add a brief comment to the declaration in sys/eventhandler.h.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 50483
Build 47374: arc lint + arc unit

Event Timeline

mhorne created this revision.Mar 16 2023, 7:36 PM

Herald added a subscriber: imp. · View Herald TranscriptMar 16 2023, 7:36 PM

mhorne requested review of this revision.Mar 16 2023, 7:36 PM

Harbormaster completed remote builds in B50428: Diff 118950.Mar 16 2023, 7:36 PM

mhorne added a parent revision: D39134: kern_reboot(9): document shutdown_nice().Mar 16 2023, 7:36 PM

mhorne added a child revision: D39136: callout(9): adopt old references to timeout(9).

mhorne added reviewers: markj, imp.Mar 16 2023, 7:41 PM

markj accepted this revision.Mar 16 2023, 7:49 PM

markj added inline comments.

share/man/man9/kern_reboot.9
218

This revision is now accepted and ready to land.Mar 16 2023, 7:49 PM

rpokala added a subscriber: rpokala.Mar 16 2023, 8:39 PM

rpokala added inline comments.

share/man/man9/kern_reboot.9
272	This example .Vt shutdown_final handler uses the .Dv RB_NOSYNC flag to detect that a panic or other unusual condition has occurred, and returns early.

Very minor, fixable on commit.

share/man/man9/kern_reboot.9
185	Clarity for EFL readers
208
239

Fix nits.

This revision now requires review to proceed.Mar 20 2023, 2:35 PM

Harbormaster completed remote builds in B50483: Diff 119129.Mar 20 2023, 2:35 PM

markj accepted this revision.Mar 20 2023, 4:26 PM

This revision is now accepted and ready to land.Mar 20 2023, 4:26 PM

rpokala added inline comments.Mar 20 2023, 4:58 PM

share/man/man9/kern_reboot.9
272	In this example, the This one's my fault, I botched it in the example I provided. <facepalm>

Closed by commit rGf6f8cbda8efc: kern_reboot(9): describe event handlers (authored by mhorne). · Explain WhyMar 20 2023, 8:13 PM

This revision was automatically updated to reflect the committed changes.

mhorne added a commit: rGf6f8cbda8efc: kern_reboot(9): describe event handlers.

Revision Contents
Changeset List

Path

Size

share/

man/

man9/

kern_reboot.9

111 lines

sys/

eventhandler.h

9 lines

Diff 119129

View Options

share/man/man9/kern_reboot.9

	Show First 20 Lines • Show All 276 Lines • ▼ Show 20 Lines
	__DEFAULT_DEPENDENT_OPTIONS+= LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL			__DEFAULT_DEPENDENT_OPTIONS+= LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL
	.endif			.endif
	.endfor			.endfor

	__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS			__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS

	.include <bsd.compiler.mk>			.include <bsd.compiler.mk>

	.if ${__T} == "aarch64" \|\| ${__T} == "amd64" \|\| ${__T} == "i386"			.if ${__T} == "aarch64" \|\| ${__T} == "amd64" \|\| ${__T} == "i386" \|\| ${__T:Mpowerpc*}
				impUnsubmitted Not Done Inline Actions so only armv and riscv are broken? Maybe it's time to reverse the sense of this conditional? imp: so only armv and riscv are broken? Maybe it's time to reverse the sense of this conditional?
				emasteUnsubmitted Not Done Inline Actions I suspect that 32-bit arm is fine, so it could probably be just != riscv. In any case though I think we can do it as a separate change. emaste: I suspect that 32-bit arm is fine, so it could probably be just != riscv. In any case though I…
	__DEFAULT_YES_OPTIONS+=LLDB			__DEFAULT_YES_OPTIONS+=LLDB
	.else			.else
	__DEFAULT_NO_OPTIONS+=LLDB			__DEFAULT_NO_OPTIONS+=LLDB
	.endif			.endif
	# LIB32 is supported on amd64 and powerpc64			# LIB32 is supported on amd64 and powerpc64
	.if (${__T} == "amd64" \|\| ${__T} == "powerpc64")			.if (${__T} == "amd64" \|\| ${__T} == "powerpc64")
	__DEFAULT_YES_OPTIONS+=LIB32			__DEFAULT_YES_OPTIONS+=LIB32
	.else			.else
	▲ Show 20 Lines • Show All 206 Lines • Show Last 20 Lines