From nobody Wed Feb 19 15:37:09 2025 X-Original-To: freebsd-doc@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4YygVy1lYtz5pWHh for ; Wed, 19 Feb 2025 15:37:14 +0000 (UTC) (envelope-from christos@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [96.47.72.83]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "smtp.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4YygVy1GnGz3Gw6; Wed, 19 Feb 2025 15:37:14 +0000 (UTC) (envelope-from christos@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1739979434; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=WsGFRhpbGQMdqMXIcrA4HpL6B8HGzKQtOh980sk4wB8=; b=WlTYHVKC2yLE8ECGJIN1/vFDn3m6LUL9zMpLhz+5ZT6cnAtAwl8S388GhFr/4dUcGHUPS+ Y3+73+JTHfQBaglUobV/SCekvVe8UGSmQUNQftUG42Fy/YmzaZ89MIbPtaoSddMrsv1JnG YRT0uCCnmLahAT63oORhMpyL4cyj6T29i4JHZrPaNzldW1j3WtbnrTPhr2VUjoxlMa17b9 nXupM6OmKrLTsuCvfrkmur3WIWtfzl7Z/jfS3bWAexk3FhLgnMY1UH3eSjEW4/LR0ukgWz 7K1XWgjTICjjDpBRyD+96KYzfjnZmP2WKfMc9zC/3C0m55NG1XLGg2JwQcP92A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1739979434; a=rsa-sha256; cv=none; b=OslA3UBSCayRayJLnRjPF8gPMvU0YSXEaDDbcapBUzBOFswRGRzID6DlEFq0JxSiPXESNE +jhgaZyYQMH97+MEpAwa6sfk7CD0mhvDRyPZ/eEeYd3fGx301g/rxiybzbDNFA6rOYTmkb 1PUp7niGGfuAGj+py87X6srxNFGCLb1BQKOWej2LlGOaB85EKEOyA0YNOBebIGKL5CKemm tDPafCLOkh9Eg6BauIXwcNG5rcV+z+YieS4AblNekrjqxFepOigLt4/2p6rpak4wfR44XF I1U3LFcP7ZHPdfipUhVkNg0+x0XzULwLRvTKlj3MTChBhRlD29d2m3t7RtdCQA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1739979434; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references:dkim-signature; bh=WsGFRhpbGQMdqMXIcrA4HpL6B8HGzKQtOh980sk4wB8=; b=LJIb/WOFrnNGhhXtJn20IkF+da4wwjlFKMupMkcHwwA3Ef5WoLzVtKgIZFucFacKc6VArn 0L8b/m7JTyiPr4ax//h5/kSIS3iaE02tHag4n5B7/yPOtvoNnPLjY1ctSt49ciXCJQw7Y3 ajuNrZxemiHTeCRd+9cQrBkvTBM5yFqCybmQkYtuV+0J46NzrdN++n1KaSSXF/zwO7fvV7 vZD6rwZnkeVA1Nd0V6zm7/ZVGbYA8bKlrHiV8IW0kYQs+NQ2HoyX+mDt9Y5QWNcVGyDXhM I2R15gjGdvCoIi7bIbp97Qg4bUlj8g0L6lg+Lp36VIN+8PPZKKsXPUQko6/dzg== Received: from margiolis.net (mail.margiolis.net [95.179.159.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA512) (Client did not present a certificate) (Authenticated sender: christos/mail) by smtp.freebsd.org (Postfix) with ESMTPSA id 4YygVx5V6Fz95K; Wed, 19 Feb 2025 15:37:13 +0000 (UTC) (envelope-from christos@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; s=mail; bh=XODHV/EUdrtjEls eUHU/aWm84ID07UGOfzp3/3mTUNg=; h=in-reply-to:references:subject:cc:to: from:date; d=margiolis.net; b=enO0yPNriM6Sd8JzOCO1zSdVvaNWqYBOFbHYweJN Lsyo/XdWlSI0wf0AR29oqq2jNYDg3XKNKC6gUANVnxMuN9qHz/IgCbivsrD2X89kD/zHJg zkJ43up6XNt7oLd3ekRDRmGWQA7vsURIQzf3vIXk3YE/79iKXZVcuZd+A4U3c= Received: from pleb (31-217-175-238.cgn.acro.cosmote.net [31.217.175.238]) by margiolis.net (OpenSMTPD) with ESMTPSA id 86ff7c4e (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Wed, 19 Feb 2025 15:37:11 +0000 (UTC) Date: Wed, 19 Feb 2025 17:37:09 +0200 From: Christos Margiolis To: Alexander Ziaee Cc: freebsd-doc Subject: Re: Sound manuals Message-ID: References: List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Alexander Ziaee wrote: > On 2025-02-19 09:32 -05:00 EST, "Christos Margiolis" 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