Details

Reviewers

carlavilla
mhorne
ivy
manu
kevans

Group Reviewers

manpages
Loader

Commits

rGd84de55c1501: loader.8: Document module commands
rG513b9db1a829: loader.8: Document module commands
rG6fb0d67819f7: loader.8: Document module commands

Summary

Begin documenting module loader commands in loader(8), where the reader would look for them. Segregate them by their availability in individual loader implementations, like build(7) targets. These details were graciously donated by kevans.

MFC after: 3 days
Co-authored-by: Kyle Evans <kevans@freebsd.org>

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 67672
Build 64555: arc lint + arc unit

Event Timeline

ziaee created this revision.Jun 6 2025, 5:47 PM

Herald added a reviewer: manu. · View Herald TranscriptJun 6 2025, 5:47 PM

Herald added subscribers: dab, imp. · View Herald Transcript

ziaee requested review of this revision.Jun 6 2025, 5:47 PM

Harbormaster completed remote builds in B64686: Diff 156647.Jun 6 2025, 5:47 PM

I think this one is even more misplaced than the others because it's not available in the simp flavor at all. There are also other module commands that might be good to document: toggle-module, enable-module at least

ziaee retitled this revision from loader_simp.8: Document disable-module to loader.8: Document module commands.Jun 11 2025, 10:16 PM

Attempt documenting all of them together in loader.8.

Harbormaster completed remote builds in B64771: Diff 156848.Jun 11 2025, 10:21 PM

Let's also talk about these ones, similarly constrained in availability:

boot-conf: loads the loader config and commence the autoboot sequence
read-conf $file: load the specified configuration file
reload-conf: reload configuration (as if we had just entered loader)

One more module option one:

show-module-options: describe all of the modules that loader is currently aware of and whether they are enabled or not

Device option specfic to lua:

disable-device $device: sets a newbus hint to disable the device; e.g., disable-device pci0 will set hint.pci.0.disabled=1)

stand/man/loader.8
92

pauamma_gundo.com added a subscriber: pauamma_gundo.com.Jun 12 2025, 1:08 AM

pauamma_gundo.com added inline comments.

stand/man/loader.8
97	Alternatively, split it into one explanation per command.

if ok, co-authored-by: kevans? i dont want to steal the credit

Harbormaster completed remote builds in B64784: Diff 156862.Jun 12 2025, 2:37 AM

ziaee marked 2 inline comments as done.Jul 15 2025, 8:26 PM

imp added inline comments.Jul 15 2025, 8:29 PM

stand/man/loader.8
109	Does this undo all the enable/disable/toggle-module commands, etc? Is that what 'as if freshly entering the loader' means. Also 'entering loader' -> 'entering the loader' no?

ziaee added inline comments.Jul 15 2025, 8:33 PM

stand/man/loader.8
109	Does this undo all the enable/disable/toggle-module commands, etc? That's my understanding but I don't actually know. Also 'entering loader' -> 'entering the loader' no? Yes.

Hopefully fix @imp's concerns

Harbormaster completed remote builds in B67294: Diff 162786.Sep 25 2025, 2:55 AM

Do I need to do anything else here?

kevans added inline comments.Oct 1 2025, 5:48 PM

stand/man/loader.8
109	It wipes out any module commands and reverts the environment as best as it can to a pre-loader state. It doesn't enumerate all env vars, but if a loader.conf sets a var `foo`, we recorded the state of `foo` and restore that value upon reload. So if you manually set another var, bar, that wasn't in any loader.conf: that stays, but if you overwrote the aforementioned foo and loader.conf had set it, that'll get lost.