New man page arswitch(4)
ClosedPublic
Actions

Authored by felix.the.red_gmail.com on Oct 13 2021, 2:21 AM.

Details

Reviewers

ygy
adrian

Group Reviewers

manpages

Commits

rG262717e270c3: arswitch(4): Add new manpage

Summary

Created a new man page for arswitch, for PR 211668.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

felix.the.red_gmail.com requested review of this revision.Oct 13 2021, 2:21 AM

felix.the.red_gmail.com created this revision.

ygy added a reviewer: manpages.Oct 13 2021, 2:38 AM

Thanks for moving this here... It's a lot easier to comment on something like this here than in bz.

share/man/man4/arswitch.4
38–39	I'd delete these, or document them.
85–86	I'd leave this whole section out.

Removed commented section for sysctl.
Removed BUGS section.

Here's a few things I noticed.

share/man/man4/arswitch.4
28	Remember to bump .Dd when this gets commited.
56	This sentence needs to be reworked a bit, as it's missing an article, has RAS Syndrome, and it's not entirely clear what the meaning of it is (so I'm having trouble coming up with suggestions).
59	Is this sentence connected to the above? If it is, the above one should probably end with a comma.
63
67

lwhsu added a reviewer: adrian.Oct 13 2021, 1:43 PM

Removed examples.
Clarified how arswitch configures the ethernet interface.
Added cross-reference to etherswitchcfg(8) and documented which tags arswitch supports.

adrian accepted this revision.Oct 16 2021, 5:44 PM

This revision is now accepted and ready to land.Oct 16 2021, 5:44 PM

ygy accepted this revision.Oct 19 2021, 12:46 AM

mandoc reported the following minor style issues, which I will fix when committing:

mandoc: share/man/man4/arswitch.4:62:42: STYLE: whitespace at end of input line
mandoc: share/man/man4/arswitch.4:72:14: STYLE: no blank before trailing delimiter: Dv doubletag.
mandoc: share/man/man4/arswitch.4:91:18: STYLE: no blank before trailing delimiter: An Felix Johnson.

Closed by commit rG262717e270c3: arswitch(4): Add new manpage (authored by felix.the.red_gmail.com, committed by ygy). · Explain WhyOct 20 2021, 3:35 AM

This revision was automatically updated to reflect the committed changes.

ygy added a commit: rG262717e270c3: arswitch(4): Add new manpage.