Page MenuHomeFreeBSD

ice.4: Improve SYNOPSIS
ClosedPublic

Authored by ziaee on Oct 4 2025, 11:23 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Sep 10, 8:53 PM
Unknown Object (File)
Wed, Sep 9, 3:37 PM
Unknown Object (File)
Tue, Sep 8, 11:56 AM
Unknown Object (File)
Sat, Sep 5, 5:50 PM
Unknown Object (File)
Thu, Sep 3, 1:07 PM
Unknown Object (File)
Tue, Sep 1, 11:47 AM
Unknown Object (File)
Sun, Aug 30, 7:06 AM
Unknown Object (File)
Thu, Aug 27, 9:09 PM
Subscribers

Details

Summary

Remove prose from synopsis, adding sysctls and tunables. I would like
to use something standard across the manual for "substitute a number
here". We used to, and OtherBSDs do, just use ?, which is a standard
UNIX notation for a substitutable character. Our manual uses a mix of
Ns, ?s, and #s.

MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Oct 4 2025, 11:23 PM

We also need to fix the HARDWARE section. Supported hardware, and really only supported hardware, needs to be in there. Then, the entire section appears in the hardware compatibility list:

https://www.freebsd.org/releases/15.0R/hardware/

So, supported adapters needs to move from DESCRIPTION into HARDWARE, and information about configuring optics needs to go from HARDWARE to DESCRIPTION.

kbowling added a subscriber: kbowling.

The deletions seem fine. The convention is probably up to you if you are changing to this.

This revision is now accepted and ready to land.Oct 4 2025, 11:53 PM
This revision was automatically updated to reflect the committed changes.