Page MenuHomeFreeBSD

style.mdoc.5: Document use of rc.conf, loader.conf, and sysctl.conf in SYNOPSIS
Needs ReviewPublic

Authored by 0mp on Fri, Oct 24, 7:45 PM.
Tags
None
Referenced Files
F134812417: D53340.diff
Tue, Nov 4, 6:23 PM
F134775230: D53340.id165000.diff
Tue, Nov 4, 1:37 PM
Unknown Object (File)
Mon, Nov 3, 5:14 PM
Unknown Object (File)
Tue, Oct 28, 6:14 AM
Unknown Object (File)
Tue, Oct 28, 5:08 AM
Unknown Object (File)
Sun, Oct 26, 1:29 AM
Unknown Object (File)
Sat, Oct 25, 7:02 PM
Unknown Object (File)
Sat, Oct 25, 12:45 PM
Subscribers

Details

Reviewers
ziaee
Summary

Suggested by: Alexander Ziaee

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 68102
Build 64985: arc lint + arc unit

Event Timeline

0mp requested review of this revision.Fri, Oct 24, 7:45 PM

Hey, thanks for doing this. Initial bikeshed:

share/man/man5/style.mdoc.5
230

This is very broad. According to mdoc(7), it's very specifically:

"Documents the utility invocation syntax, function call syntax, or *device configuration*."

So, OtherBSDs interpret "device configuration" to mean exclusively the config(8) declarations, but in FreeBSD for drivers only (afaik), we've seemingly always interpreted this to also include the files that configure devices at runtime.

236
share/man/man5/style.mdoc.5
230

Hey! I've read mdoc's take on this as well. I just thought that it would be nice to document what we already do. I couldn't think of a better phrase for now than "all kinds of relevant information". Perhaps we could just list what's allowed, which would be:

  • config(8)
  • loader.conf(5)
  • sysctl.conf(5)
  • rc.conf(5)
  • command-line syntax
  • function syntax

anything else?