Mention vendor driver for if_re

[jo_bruelltuete.com]

Summary

The in-src driver for if_re seems to have some problems, see https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=166724 and https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=208205.

The vendor driver, which exist as a port, seems to fix all/most of that.
Mention the vendor driver in the man page to increase the chance of someone like me finding it.

[debdrup]

Firstly, please see the Phabricator wiki article for information on how to create a full-context diff - it makes it easier for us to make in-line suggestions.

Secondly, you always want to ensure that .Dd is bumped when you're submitting a diff to manual pages, since that makes it easy to keep track of when it was modified (displayed at the bottom when rendered using mandoc | less which is the default in FreeBSD.

Thirdly, Rs implies a bibliographical reference, which this isn't - this is simply reference to a port, which can be accomplished using something along the lines of "The unmodified driver from the vendor can be found in net/realtek-re-kmod.", and then adding a .Xr if_re 4 Pq Pa ports/net/realtek-re-kmod macro in the SEE ALSO section.

[pauamma_gundo.com]

Zeroly, thanks for this. :-)

[jo_bruelltuete.com]

thanks for looking at the patch!

adding a note to the bugs section is prob the most appropriate as we are directing ppl to check out the vendor driver in case they have problems with the in-source one.

[debdrup]

In D33677#764161, @jo_bruelltuete.com wrote:

thanks for looking at the patch!

adding a note to the bugs section is prob the most appropriate as we are directing ppl to check out the vendor driver in case they have problems with the in-source one.

No worries :)

And you're absolutely right about it belonging in the BUGS section.
However, I still maintain that you need the cross-reference I mentioned in the SEE ALSO section as well.

[koobs]

LGTM ship and merge it!

share/man/man4/re.4

289–290

An unmodified driver supplied by Realtek is available in ports under net/realtek-re-kmod.

[debdrup]

Apologies for taking so long, life got in the way.

@koobs is right about the article, but that can be fixed when it's committed and pushed.

[emaste]

We should bring in improvements from the vendor driver, but we should certainly mention it. I probably would avoid the "unmodified driver" terminology though, which seems to imply we have the same driver in the tree but with broken modifications. I don't think this is the case. Maybe "updated vendor driver"?

[jo_bruelltuete.com]

Someone please click the merge button... thanks!