Page MenuHomeFreeBSD

snd_hda.4: Improve HARDWARE for HW Relnotes
Needs ReviewPublic

Authored by ziaee on Fri, Jan 17, 3:15 PM.

Details

Reviewers
carlavilla
christos
mhorne
Group Reviewers
manpages
Summary

Rewrite the HARDWARE section to improve hardware release notes. Add a
path to the complete list in src like we did in u3g.4, and move it after
DESCRIPTION like we did in all Wi-Fi drivers. Hopefully, we can
improve the HW Relnotes generation to add a cgit link when it sees a
path macro. While here, tag SPDX and remove document description quotes.

MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 61786
Build 58670: arc lint + arc unit

Event Timeline

ziaee requested review of this revision.Fri, Jan 17, 3:15 PM

While I guess u3g.4 might indeed include the full list of supported devices, simply because IIRC many of them require some quirks to attach and operate, the snd_hda was written with a goal to work on unknown hardware. The list of devices in the code in most cases is just for cosmetics and user convenience. That is why I would not like it to be listed as more than examples. We've actually had a list in the man page before, but I axed it out at some point.

Seconding @mav's comment. Looking at the defined codecs in sys/dev/sound/pci/hda/hdac.c can be helpful, but also misleading.

Thanks! This is great info. I'll reflect on proper wording to reflect that it's designed to work on potentially unknown hardware.