From nobody Thu Mar 6 23:47:31 2025 X-Original-To: dev-commits-src-main@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 4Z85gs2bwlz5qK3S for ; Thu, 06 Mar 2025 23:47:37 +0000 (UTC) (envelope-from adziaee@runbox.com) Received: from mailtransmit05.runbox.com (mailtransmit05.runbox.com [IPv6:2a0c:5a00:149::26]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (prime256v1) server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z85gq1VV4z3wPd; Thu, 06 Mar 2025 23:47:35 +0000 (UTC) (envelope-from adziaee@runbox.com) Authentication-Results: mx1.freebsd.org; dkim=pass header.d=runbox.com header.s=selector1 header.b=TW+YebdQ; dmarc=pass (policy=quarantine) header.from=runbox.com; spf=pass (mx1.freebsd.org: domain of adziaee@runbox.com designates 2a0c:5a00:149::26 as permitted sender) smtp.mailfrom=adziaee@runbox.com Received: from mailtransmit03.runbox ([10.9.9.163] helo=aibo.runbox.com) by mailtransmit05.runbox.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (Exim 4.93) (envelope-from ) id 1tqKw8-001tP9-8m; Fri, 07 Mar 2025 00:47:32 +0100 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=runbox.com; s=selector1; h=Message-Id:In-Reply-To:Date:Subject:CC:To:From:MIME-Version: Content-Transfer-Encoding:Content-Type; bh=g2KtfiruVobUA0jmzRgRjGvg2bEFuydMNG3nCPwbSZU=; b=TW+YebdQeen8zBhQ3km5n2cbJr ac86gXmKTqz37CwMuyACTRP9/knd/5raen3eu4ro5sJbUgFHwRbkoYq3KsojfGkk3tnxLGDIfJSL6 X9B0WgkodrPqfvphaWUFiRCUbIsdQoEj1kHmtcsP0K+htKxKpiqKyal2GjYgm4WVApxxaem+g09g3 aHjGcSOVyy94yrPxuF4m9RUoNI13TshY/jM9NBQtiPY3/ssZQwh+pxrQLk8YWE1CX4LjNlOTiAQwK 7xMfwCyu/eBuym90SZcOlJPXzxkakBtCmJuTxcw4ymLcPX0DsjXtxsz2naXZCaPY6YxMFWWTZb1L9 qGAM0BMw==; Received: from [10.9.9.127] (helo=rmmprod05.runbox) by mailtransmit03.runbox with esmtp (Exim 4.86_2) (envelope-from ) id 1tqKw7-0008U5-Du; Fri, 07 Mar 2025 00:47:31 +0100 Received: from mail by rmmprod05.runbox with local (Exim 4.86_2) (envelope-from ) id 1tqKw7-0006H0-Ae; Fri, 07 Mar 2025 00:47:31 +0100 Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: quoted-printable List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Received: from [Authenticated alias (1070552)] by runbox.com with http (RMM6); Thu, 06 Mar 2025 23:47:31 GMT From: "Alexander Ziaee" To: "Warner Losh" , "John Baldwin" CC: "Bjoern A. Zeeb" , "Herbert J. Skuhra" , "Alexander Ziaee" , "Adrian Chadd" , "src-committers" , "dev-commits-src-all" , "dev-commits-src-main" , "Christos Margiolis" Subject: Re: git: 4262dbc57982 - main - wifi manuals: Mlink + document description consistency Date: Thu, 06 Mar 2025 23:47:31 +0000 (UTC) X-RMM-Aliasid: 1070552 X-Mailer: RMM6 In-Reply-To: Message-Id: X-Spamd-Result: default: False [-4.17 / 15.00]; DWL_DNSWL_LOW(-1.00)[runbox.com:dkim]; NEURAL_HAM_LONG(-0.98)[-0.975]; NEURAL_HAM_MEDIUM(-0.94)[-0.940]; DMARC_POLICY_ALLOW(-0.50)[runbox.com,quarantine]; R_DKIM_ALLOW(-0.20)[runbox.com:s=selector1]; R_SPF_ALLOW(-0.20)[+ip6:2a0c:5a00:149::26]; NEURAL_HAM_SHORT(-0.15)[-0.153]; RCVD_IN_DNSWL_LOW(-0.10)[2a0c:5a00:149::26:from]; MIME_GOOD(-0.10)[text/plain]; MIME_TRACE(0.00)[0:+]; FREEMAIL_ENVFROM(0.00)[runbox.com]; ARC_NA(0.00)[]; FREEMAIL_FROM(0.00)[runbox.com]; ASN(0.00)[asn:50304, ipnet:2a0c:5a00::/29, country:NO]; RCPT_COUNT_SEVEN(0.00)[10]; RCVD_COUNT_THREE(0.00)[4]; FROM_EQ_ENVFROM(0.00)[]; FROM_HAS_DN(0.00)[]; MLMMJ_DEST(0.00)[dev-commits-src-main@freebsd.org]; TO_MATCH_ENVRCPT_SOME(0.00)[]; RCVD_TLS_LAST(0.00)[]; TO_DN_ALL(0.00)[]; DKIM_TRACE(0.00)[runbox.com:+] X-Rspamd-Queue-Id: 4Z85gq1VV4z3wPd X-Spamd-Bar: ---- On 2025-03-04 12:07 -05:00 EST, "Warner Losh" wrote: > On Tue, Mar 4, 2025 at 8:23=E2=80=AFAM John Baldwin wro= te: >=20 >> On 3/4/25 09:25, Bjoern A. Zeeb wrote: >> > On Tue, 4 Mar 2025, Herbert J. Skuhra wrote: >> > >> >> On Thu, 27 Feb 2025 23:22:00 +0100, Alexander Ziaee wrote: >> >>> >> >>> The branch main has been updated by ziaee: >> >>> >> >>> URL: >> https://cgit.FreeBSD.org/src/commit/?id=3D4262dbc57982383eb61a8b7806de6d= d4b7802da8 >> >>> >> >>> commit 4262dbc57982383eb61a8b7806de6dd4b7802da8 >> >>> Author: Alexander Ziaee >> >>> AuthorDate: 2025-02-19 15:54:27 +0000 >> >>> Commit: Alexander Ziaee >> >>> CommitDate: 2025-02-27 22:20:22 +0000 >> >>> >> >>> wifi manuals: Mlink + document description consistency >> >>> >> >>> Interfaces all have an mlink to if_$foo. Add these for the >> missing ones >> >>> and remove an incorrect one from rtwn_pci. Wireless network >> drivers are >> >>> all accessible via `apropos -s4 "wireless network driver", exce= pt >> two >> >>> which are "wireless network device". I actually prefer the >> latter, but >> >>> make them all consistent upon the more common parlance. Tag SPDX >> on one >> >>> of the files I touched, while here. >> >>> >> >>> MFC after: 3 days >> >>> Reviewed by: bz, carlavilla, mhorne >> >>> Approved by: carlavilla, mhorne (mentors) >> >>> Differential Revision: https://reviews.freebsd.org/D49063 >> >>> --- >> >>> share/man/man4/Makefile | 4 +++- >> >>> share/man/man4/uath.4 | 4 +++- >> >>> share/man/man4/upgt.4 | 2 +- >> >>> 3 files changed, 7 insertions(+), 3 deletions(-) >> >>> >> >>> diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile >> >>> index 13afc9b8d399..8e0af19eec3d 100644 >> >>> --- a/share/man/man4/Makefile >> >>> +++ b/share/man/man4/Makefile >> >>> @@ -764,7 +764,9 @@ MLINKS+=3Dptnet.4 if_ptnet.4 >> >>> MLINKS+=3Dral.4 if_ral.4 >> >>> MLINKS+=3Dre.4 if_re.4 >> >>> MLINKS+=3Drl.4 if_rl.4 >> >>> -MLINKS+=3Drtwn_pci.4 if_rtwn_pci.4 >> >>> +MLINKS+=3Drtw88.4 if_rtw89.4 >> >>> +MLINKS+=3Drtw89.4 if_rtw89.4 >> >>> +MLINKS+=3Drtwn.4 if_rtwn.4 >> >> ^^^^^^^^^ >> >> $ grep if_rtwn.4 ObsoleteFiles.inc >> >> OLD_FILES+=3Dusr/share/man/man4/if_rtwn.4.gz >> > >> > In fact that is probably correct but things are confusing. >> > >> > The modules are called if_rtwn_usb.ko and if_rtwn_pci.ko and those >> > should have the man page and links (so contrary to what was done). >> > rtwn.ko is just the common code if I am not mistaken (Adrian should kn= ow >> > better). >> > >> > But everyone is just referring to the driver as rtwn and I fear if the= re >> > is no man page to be found as man rtwn / man if_rtwn people will be >> > confused. >> > >> > I wanted to do the same with rtw88 but was told to keep it all together >> > as one so rtwn is an excemption. >> > >> > That all said, yes, it needs a further cleanup. >> >> The manpages should just be rtwn/if_rtwn. The bus attachment doesn't >> matter. >> We don't have separate manpages when a storage adapter has been supported >> on both PCI and ISA in the past, you just had the ahc(4) driver (for >> example). >> USB vs PCI is the same. It should just be a single manpage for the driv= er >> regardless of the attachment. If the driver has separate modules that c= an >> be documented in the one manpage, but the list of supported chipsets, et= c. >> is presumably shared hence the shared driver name and common code. In >> particular, the thing a user sees in dmesg is 'rtwn0', not 'rtwn_pci0' so >> the manpage needs to be tied to what a user sees as a device name in dme= sg. >> >=20 > Yea, the man page should mention the detail that we have separate .ko's, = but > otherwise I agree with John here. IIUC, all interfaces should be documented as $foo with an mlink (but no add= itional name macro) to if_$foo. I've also been pushing for sound to become represen= ted the same way for consistency, which christos said (paraphrased) no objectio= n.=