netmap: add man page for the bridge program
ClosedPublic
Actions

Authored by vmaffione on Oct 23 2018, 9:25 AM.

Details

Reviewers

gnn
hrs
bcr
0mp

Group Reviewers

manpages

Commits

rS341431: MFC r339659
rS339659: netmap: add man page for the bridge program

Summary

Added bridge(8).
Also, minor fixes to the netmap "bridge" application:

indentation fixes and code cleanup
better usage description
better processing of netmap flags

Test Plan

Man page tested with igor and mandoc -Tlint.
The bridge program has been tested on multiple environments, and on multiple netmap ports (software and hardware).

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

vmaffione created this revision.Oct 23 2018, 9:25 AM

Herald added a reviewer: manpages. · View Herald TranscriptOct 23 2018, 9:25 AM

Herald added a subscriber: imp. · View Herald Transcript

0mp requested changes to this revision.Oct 23 2018, 9:46 AM

0mp added a subscriber: 0mp.

0mp added inline comments.

tools/tools/netmap/bridge.8
2 ↗	(On Diff #49495)	All rights reserved may be dropped.
28 ↗	(On Diff #49495)	BRIDGE 8
32 ↗	(On Diff #49495)	I think that the leading A can be dropped.
70 ↗	(On Diff #49495)	(This is not my filed of expertise so my question might be out of place, sorry.) Shouldn't this flag be described a little bit more? What is a zero-copy mode?
71 ↗	(On Diff #49495)	There's no SEE ALSO section. Do you think that it would be nice to reference some related manuals from here? Also, it would be great to actually reference this manual from the existing ones for better discoverability.

This revision now requires changes to proceed.Oct 23 2018, 9:46 AM

Done changes requested by 0mp.

Excellent!

Just two more things:

Make sure to bump the date (.Dd) of the last modification in all those manpages you are modifying.
You may want to check out https://www.freshports.org/devel/arcanist/ for submitting patches to Phabricator. This way we can see the context of your changes as well. ;)

This revision is now accepted and ready to land.Oct 23 2018, 10:23 AM

Thanks for the suggestions! I'm new to the process.
Updated .Dd lines in related man pages.

This revision now requires review to proceed.Oct 23 2018, 10:28 AM

LGTM. Please add the Approved by: gnn@ line to your commit.

This revision is now accepted and ready to land.Oct 23 2018, 3:08 PM

Closed by commit rS339659: netmap: add man page for the bridge program (authored by vmaffione). · Explain WhyOct 23 2018, 3:34 PM

This revision was automatically updated to reflect the committed changes.

Thanks!