Page MenuHomeFreeBSD

ipfirewall.4: restructure new line starts and remove .Tn
AcceptedPublic

Authored by driesm.michiels_gmail.com on May 22 2020, 9:35 AM.

Details

Reviewers
bcr
rgrimes
0mp
Group Reviewers
manpages
Summary

This diff restructures some of the enters used in sentences as well as remove the .Tn's as discussed.

MFC with r361355

Test Plan

mandoc ipfirewall.4

Diff Detail

Repository
rS FreeBSD src repository
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 31237
Build 28886: arc lint + arc unit

Event Timeline

rgrimes requested changes to this revision.May 22 2020, 2:06 PM

Just a couple nits, and I can be ignore on my line breaking issues.

share/man/man4/ipfirewall.4
18

I usually leave sentences line broken and points like and/or/which/when/.... there is actual a very old groff style guide that recommends this.

65–66

as a NAT facility reads slight clearer for me, start a new line at "the kernel option"

This revision now requires changes to proceed.May 22 2020, 2:06 PM

Just for my understanding before I start making changes

share/man/man4/ipfirewall.4
18

So would that be:

..... which \n
or

... \n
which

share/man/man4/ipfirewall.4
18

Just put it back how it was, as in no change needed here.

Yea NP, there are a lot of other “which”s that dont start on a new line, I could move those to get consitency?

No, the point was to reduce the amount of change

Looks good to me now, thanks!

As I am not a committer, could someone take care of the commit for me? Thanks!

@rgrimes, I guess you'd like to take of this one as it is related to r361355, right?

Reflowing sentences and removal of .Tn seems like busy work to me. Much easier to just make mandoc ignore .Tn and igor silent on its usage. These macros DO make the groff man pages output look different, and IMHO, nicer.

This revision is now accepted and ready to land.Jul 31 2020, 4:11 PM