Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 19 Feb 2025 17:37:09 +0200
From:      Christos Margiolis <christos@freebsd.org>
To:        Alexander Ziaee <adziaee@runbox.com>
Cc:        freebsd-doc <freebsd-doc@freebsd.org>
Subject:   Re: Sound manuals
Message-ID:  <ie3fnem2g7cy7o4nxa2v7klu7f36lc5sjpigyiuryolyrxtloj@7kscs2nzwyng>
In-Reply-To: <E1tkm34-0005SA-PB@rmmprod06.runbox>
References:  <zqzqr5mrovf43zb6yx3iwv5wqvxii4qfyfdj5vnfvn37dpdmei@u2uaxxdqis7z> <E1tkm34-0005SA-PB@rmmprod06.runbox>

next in thread | previous in thread | raw e-mail | index | archive | help
Alexander Ziaee wrote:
> 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.

Alright, sounds reasonable.

> 
> > 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.

I don't really have any strong opinions on that. What you suggest seems
reasonable. We can discuss more in the actual reviews.

Christos



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?ie3fnem2g7cy7o4nxa2v7klu7f36lc5sjpigyiuryolyrxtloj>