Re: adding a sysctl man section
John Baldwin <[email protected]>
| Newsgroups | gmane.os.freebsd.architechture |
|---|---|
| Message-ID | <[email protected]> |
On 2/10/21 4:15 PM, John-Mark Gurney wrote: > Inspired by: https://twitter.com/michaeldexter/status/1359614809365311490 > > I realized that we could/should create a new sysctl section. My initial > thought was section s, but I'd be open for other recommendations. > > Then, any page that describes a sysctl, would add an MLINK to it: > MLINK+= xhci.4 hw.usb.xhci.debug.s > > This section would be added to the default search, and then users > would simply be able to type: man <sysctl> and get directed to the > page that has information about it. > > Any objections? I think since they are MLINKs, just have them live in the section of the thing they are linking to. That is, if it is for foo.4, have it live in section 4. If it's a sysctl that's documented as part of a syscall (bar.2), have that MLINK live in section 2. This is how all the other MLINKs work rather than needing a new section. Does this meaning adding sysctl nodes as .Nm entries in the NAME section? I'm also a bit curious how to name per-instance sysctls vs global sysctls (hw.cxgbe.* vs dev.cxgbe.N.*) as Warner mentioned. The global ones are easy, the per-instance ones would warrant some sort of consistent pattern. -- John Baldwin _______________________________________________ [email protected] mailing list https://lists.freebsd.org/mailman/listinfo/freebsd-arch To unsubscribe, send any mail to "[email protected]"