| Summary: | [IF_BRIDGE(4)] improvements | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Pekka Järvinen <pekka.jarvinen> |
| Component: | Manual Pages | Assignee: | freebsd-bugs (Nobody) <bugs> |
| Status: | New --- | ||
| Severity: | Affects Only Me | CC: | Christopher.davidson, doc |
| Priority: | --- | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
|
Description
Pekka Järvinen
2018-09-22 09:27:19 UTC
This looks to be correct and documented accordingly. The examples in question are for running an ifconfig(8) command to add the different interfaces in the configuration.
The ifconfig(8) is referenced and the ifconfig(8) does discuss how to use the addm option within the rc.conf(5) file.
ifconfig(8) snippet:
addm interface
Add the interface named by interface as a member of the bridge.
The interface is put into promiscuous mode so that it can receive
every packet sent on the network.
It would be my recommendation to CLOSE this bug.
After a little further pondering and some feedback, this may be something that can be defined to be more clear and concise. The examples section of a manual page is suppose to help guide the person, https://docs.freebsd.org/en/books/fdp-primer/manual-pages/ Snippet from above url --------- Manual pages, commonly shortened to man pages, were conceived as readily-available reminders for command syntax, device driver details, or configuration file formats. They have become an extremely valuable quick-reference from the command line for users, system administrators, and programmers. Although intended as reference material rather than tutorials, the EXAMPLES sections of manual pages often provide detailed use case. Manual pages are generally shown interactively by the man(1) command. When the user types man ls, a search is performed for a manual page matching ls. The first matching result is displayed. ----------- Maybe we can take this approach to refining the example section of this manual page? (In examples area for clarity) Bridge changes may be conducted with the .Dq Bridge Interface Parameters of .Xr ifconfig 8 Thoughts? |