Re: Sound manuals

On 2025-02-19 09:32 -05:00 EST, "Christos Margiolis" <christos@freebsd.org> wrote:
> Alexander Ziaee wrote:
>> I want to do the sound manuals like we do wifi manuals. My snd_uaudio
>> device shows up as uaudio0, like if_re shows up as re0, and the manual
>> is called re, which is shadow mlinked to if_re. To do this nicely, I'd
>> like to pick a consistent pattern for the manual document description.
>>
>> Thus:
>>
>> "audio driver" or "sound driver"?
>>

> If I understand correctly, you want to create mlinks so that we can
> access, say, "snd_uaudio" as "uaudio"?

I want to rename snd_uaudio.4 to uaudio.4, and mlink to snd_uaudio.4, to increase consistency with how we do other types of interface manuals, because I think enhance predictably with increase the quality of information discovery in the manual subsystem. Also HW Relnotes.

> I am not sure I understand the second part of the email about "sound" vs
> "audio". Isn't mlinking enough?

I want to do the document descriptions for sound driver manuals with a consistent suffix, e.g. "uaudio - USB audio and MIDI audio driver" or " uaudio - USB audio and MIDI sound driver", or possibly something else if you suggest that.

Thanks,
Alex