From nobody Tue Mar 4 16:23:50 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 4Z6gwl4D6fz5qKPR; Tue, 04 Mar 2025 16:23:51 +0000 (UTC) (envelope-from jhb@FreeBSD.org) Received: from smtp.freebsd.org (smtp.freebsd.org [IPv6:2610:1c1:1:606c::24b:4]) (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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z6gwl3Z0Lz3S6Q; Tue, 04 Mar 2025 16:23:51 +0000 (UTC) (envelope-from jhb@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1741105431; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=91otFGb4OcAEX1OgzppYTkOQKphw9FXfBRzl/Y5UeGI=; b=S5v/w/PZXAUmWDR7QObjzoG9XkkZiSWgoFM0zKq+GBDKZwIERacreMYr3bVE9Q61eBiNHV RpAvuimzHQ1e6mJUlgqyyVAVeI6lvfWFTU7uK00uFK+kRC9CbMYkDQp7nZXlCG6WdUNXbZ lrLZw4q/S04HRrpYa+VsfvS5PavU2U2GjE/DESSdC1JsjUMKXwiyFIlv8I2EZaeFccPQzS 9a9UoIFdMLaNDP5lABpgzdhzgKqga9jbqtj3CMjtWPsNKnhyh42z/CMZnP2VS/pmUXAhtL zZ+GP7oxcMI2O4R4rt/dnahkVlpHCps9nrKNhuCxspMeXXQ/f1kTPTEfqYvycA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1741105431; a=rsa-sha256; cv=none; b=qaL3JaSoUVAeLVx7Dn6x0ARN5TYa6hm87p/JnN8ba59nxGAWFQncZZ9MJF16Nh8QgF/ukQ Q3IWxP3JX4Z06BraJ95XgkoPvR99excRC+ec9NJxIL014s0css2w5c1szDYTTqLjbUqPPD RJJnOeRCZO6SqEfhsmDPwzNkIinUcfCg1BZKps/3p7NQvfJ6f3phW1+fka5kyofbEzTkEu dyi211UyE6Q/kzc8XN1s1k/U1K1LD0nKDR6/fHJUe8tkVOuT6afZlhe1CDUIkuqlAQUl85 ZvlNdeao8WHXYx7pA7xqteza9C201g2ZFq7ivjGN2WRFMzJVhAd8g/TQZMsPKQ== 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=1741105431; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=91otFGb4OcAEX1OgzppYTkOQKphw9FXfBRzl/Y5UeGI=; b=sicdSCAijyc4BCoAR0FxhK+kvmjdYY5j/mk7mkp1MReRYe5PpmvEsKI54f4bX+BZYRLTKE cKy9xR1OOmXDUoHuTiq8loGGm4lSs5HPsSOMPuQ4UM4+r0o7Qsdg5vghrkfR7IBMQMj5kh np+yMFMlryXjmcCcIA/jIhMWL4YMX/PUKclCvPCvDYY7ihLCkUbd/ersNCSnFb19hrfDts Lzr22YRUeXCJymTs2O/Hg2LJGQw1GaiwsYgohMh8MzInGw8JKuf3vTNZ/N9wsYcmV3Vp7Y vj1/0LN/ZNLul60VsJLoeUBrKZwjpZUW02XJPsNTM/nM9IHeFMkT5QLRnWA/AA== Received: from [IPV6:2601:5c0:4200:b830:540:c3c7:ff75:4b22] (unknown [IPv6:2601:5c0:4200:b830:540:c3c7:ff75:4b22]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) (Authenticated sender: jhb) by smtp.freebsd.org (Postfix) with ESMTPSA id 4Z6gwl0G89z19nh; Tue, 04 Mar 2025 16:23:50 +0000 (UTC) (envelope-from jhb@FreeBSD.org) Message-ID: Date: Tue, 4 Mar 2025 11:23:50 -0500 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 User-Agent: Mozilla Thunderbird Subject: Re: git: 4262dbc57982 - main - wifi manuals: Mlink + document description consistency Content-Language: en-US To: "Bjoern A. Zeeb" , "Herbert J. Skuhra" Cc: Alexander Ziaee , Adrian Chadd , src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org References: <202502272222.51RMM0fg033513@gitrepo.freebsd.org> <87bjugsx7t.wl-herbert@gojira.at> <95401978-p196-n4n8-4458-98qs07n2162n@SerrOFQ.bet> From: John Baldwin In-Reply-To: <95401978-p196-n4n8-4458-98qs07n2162n@SerrOFQ.bet> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit 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=4262dbc57982383eb61a8b7806de6dd4b7802da8 >>> >>> 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", except 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+=ptnet.4 if_ptnet.4 >>> MLINKS+=ral.4 if_ral.4 >>> MLINKS+=re.4 if_re.4 >>> MLINKS+=rl.4 if_rl.4 >>> -MLINKS+=rtwn_pci.4 if_rtwn_pci.4 >>> +MLINKS+=rtw88.4 if_rtw89.4 >>> +MLINKS+=rtw89.4 if_rtw89.4 >>> +MLINKS+=rtwn.4 if_rtwn.4 >> ^^^^^^^^^ >> $ grep if_rtwn.4 ObsoleteFiles.inc >> OLD_FILES+=usr/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 know > better). > > But everyone is just referring to the driver as rtwn and I fear if there > 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 driver regardless of the attachment. If the driver has separate modules that can be documented in the one manpage, but the list of supported chipsets, etc. 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 dmesg. -- John Baldwin