Page MenuHomeFreeBSD

Update multiple driver manual pages to use sysrc(8) instead of rc.conf(5)
AbandonedPublic

Authored by felix.the.red_gmail.com on Sat, Jun 28, 4:05 AM.
Tags
None
Referenced Files
F122431071: D51080.id157718.diff
Sat, Jul 5, 7:29 AM
F122379806: D51080.id.diff
Fri, Jul 4, 8:08 PM
Unknown Object (File)
Thu, Jul 3, 12:23 PM
Subscribers

Details

Reviewers
gnn
ziaee
Group Reviewers
manpages
Summary

The preferred style to load kernel modules is to use sysrc(8)
instead of editing rc.conf(5).
Multiple manual pages were updated to include this preference.
Also, references to sysrc(8) were added.
mountd.8: Remove Tn references.

From the original PR:
Network-related manual pages: promote use of sysrc(8) to safely edit system rc files
I extended this by updating uses of kld_list I found.

PR:268827

Test Plan

$ find . -type f -regex '.*\.[1-9]$' -print0 | xargs -0 grep -n "kld_list"

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

I almost think the kld_load lines (and the kldload now mentioned in some but not others) need to go from all of them and the manual procedure should be documented in one place elsewhere?
That would likely also give us a single version.
@ziaee any idea for a good man page to do so?

Lastly there's other stuff in the diff which is not relevant for this change and should be another review?

Also please upload a diff using -U10000 wen doing manually so there is context.

ziaee requested changes to this revision.EditedTue, Jul 1, 4:54 PM

Nack. The synopsis sections for drivers show lines of configuration, as it says and has said in intro.4 since the beginning. Consistency is what makes manpages strong. We should not mix commands in there. I presented at BSDCan, and everyone seemed very happy with it, what I have been doing and intend to continue to do. You can see this in vt(4), uftdi(4), iwx(4), and many others.

This revision now requires changes to proceed.Tue, Jul 1, 4:54 PM

Intro(8), or rc(8), or rc.conf(5) should explain that you can use service(8) or sysrc(8) to edit rc.conf.

The uftdi(4) in current is the best example of what I want to do. How to use things needs to be described in DESCRIPTION, for consistency with the entire body of every section of manual pages. SYNOPSIS needs to list the possible ways to use it, like the entire body of every section of manual pages.

pf(4) is another great example.

Based on review from @ziaee, I think we should abandon this revision and close the PR.

Based on feedback from @ziaee, this revision is not needed.