[Bug 231574] [IF_BRIDGE(4)] improvements

From: <bugzilla-noreply_at_freebsd.org>
Date: Sun, 17 Mar 2024 17:16:33 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=231574

--- Comment #2 from Chris Davidson <Christopher.davidson@gmail.com> ---
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?

-- 
You are receiving this mail because:
You are on the CC list for the bug.