From nobody Fri Oct 10 15:08:03 2025 X-Original-To: dev-commits-src-all@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 4cjqqp0r7fz6BQLj; Fri, 10 Oct 2025 15:08:06 +0000 (UTC) (envelope-from kevans@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 "R13" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4cjqqp0Lx7z3RlM; Fri, 10 Oct 2025 15:08:06 +0000 (UTC) (envelope-from kevans@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1760108886; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sFPFHsb3FlT1+UVPtzvZmbQAQVJQnmlKysJXrtnCaxI=; b=aXgouog35VpRk3m5pc274gmxfdHj8EGJWoQI043k3i8iiPzqtfmvk6B7WrdjhLBZ5hoDOh bdquEArdVNU+eyz/zYUMhEwzyHkw3JmWhN74Hqc4mxAMzx7rbPll5pQk+JZItwertylebo XcYb4k/Hh3BVucL1P5dKl+ZweNY5P+8WcwBlznan5Z1ldliufpePgIKg/Z12G3qmEZWuWe 6LsK2U0wYDZJpSJPH3u61bxJyHhSBkzwpUxz5vLqacc/v87j0ZxLQXRr2l+G04+B7UCPkS dXdhORmBgJI5FJEbMWeLw1N2yqcCJoLJ35BZe9heNcWivjkJ0uQ7ZF9w526snA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1760108886; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sFPFHsb3FlT1+UVPtzvZmbQAQVJQnmlKysJXrtnCaxI=; b=DPVHuz+qHWxWxRKch1KkozwvJPlGEHA8Roj/hWeqQXQGKMLdIv4KHMUXKcou3astvyKIYZ OhrDHwGDGmZY5e9pQqWqBUEkGM734NO7W8lSxap/jQPAovES13ho6watnK3iVtfCqngOAV D6MbrXbTdPprI3OM5Iv+x/5Hm1mNdmvCqKGL+B8ROHoBEQ5+p4Vbp+02W7HSih9Qbd5GFt jCWbzcn6aM7lcMt7umbrcc0t5iYtGjsKs2nblsQW98I9/7z97s2buem1nMBJ+4d+Vl83me 70N+nQFcNi+4dYcxjlO+eaxwkPd/4Ln5wjKYh5qs3RqVeKZ2E1HTR4+JV81O8w== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1760108886; a=rsa-sha256; cv=none; b=yOeja3lcmjKPdtyTy66gBh89DwUzzNAm60jEoG7gaZfnqdMwBsPqAJh7a3vdkl/3IX6Hjw /UOcjlK7iYmgZswzi7TjZPUp7oPdIyiPNoiS1wfWbolBBlKuqUPLcioNDYKQEzEQ6XC6h7 l7vH2SuvBDid9XbgfHskUIp9s2BqyuTdCziNGm4YNsixpJE3WzvLzGXxFa4pgmf6biWq4u 2CnKvGerOIUQcEE4TGi4Fo3cdnycXGEC3mZk3EBqhY24LvJ9dChoZgg0bTdHvavM6V0hu+ A0nO5naZ4yTzeq4kYMpPgOb+85Glzi2lgrRryrynyEwPLPklsBsCywczQN+J3w== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from [10.9.4.95] (unknown [209.182.120.176]) (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: kevans/mail) by smtp.freebsd.org (Postfix) with ESMTPSA id 4cjqqn3nK7z128n; Fri, 10 Oct 2025 15:08:05 +0000 (UTC) (envelope-from kevans@FreeBSD.org) Message-ID: <022f86c5-7d0d-4f87-8c2a-d2cf7f514563@FreeBSD.org> Date: Fri, 10 Oct 2025 10:08:03 -0500 List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: git: d8a4843cb76e - main - umass.4: Modernize driver loading instructions To: Alexander Ziaee , cyric , src-committers , dev-commits-src-all , dev-commits-src-main References: Content-Language: en-US From: Kyle Evans In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit On 10/10/25 09:29, Alexander Ziaee wrote: > > On 2025-10-10 09:37 -04:00 EDT, cyric@mm.st wrote: >> Alexander Ziaee wrote: >>> The branch main has been updated by ziaee: >>> >>> URL: https://cgit.FreeBSD.org/src/commit/?id=d8a4843cb76ec1b7da8d5defafb7eef9a6cc1c21 >>> >>> commit d8a4843cb76ec1b7da8d5defafb7eef9a6cc1c21 >>> Author: Alexander Ziaee >>> AuthorDate: 2025-10-09 14:55:14 +0000 >>> Commit: Alexander Ziaee >>> CommitDate: 2025-10-09 21:06:50 +0000 >>> >>> umass.4: Modernize driver loading instructions >>> >>> + consolidate kernel configuration in SYNOPSIS >>> + explain driver autoloading in DESCRIPTION >>> + s/port/interface/ because of internal USBs >>> + fix flow of remaining example >>> >>> MFC after: 1 day >>> --- >>> share/man/man4/umass.4 | 56 +++++++++++++++++++++----------------------------- >>> 1 file changed, 23 insertions(+), 33 deletions(-) >>> >>> diff --git a/share/man/man4/umass.4 b/share/man/man4/umass.4 >>> index db4e6f0890f2..8c6b03a3afea 100644 >>> --- a/share/man/man4/umass.4 >>> +++ b/share/man/man4/umass.4 >>> @@ -25,44 +25,44 @@ >>> .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF >>> .\" SUCH DAMAGE. >>> .\" >>> -.Dd October 2, 2025 >>> +.Dd October 9, 2025 >>> .Dt UMASS 4 >>> .Os >>> .Sh NAME >>> .Nm umass >>> .Nd USB Mass Storage Devices driver >>> .Sh SYNOPSIS >>> -To compile this driver into the kernel, >>> -place the following line in your >>> -kernel configuration file: >>> -.Bd -ragged -offset indent >>> +.Cd "device da" >>> .Cd "device scbus" >>> +.Cd "device pass" >>> .Cd "device usb" >>> .Cd "device umass" >>> -.Ed >>> .Pp >>> -Alternatively, to load the driver as a >>> -module at boot time, place the following line in >>> +In >>> .Xr loader.conf 5 : >>> -.Bd -literal -offset indent >>> -umass_load="YES" >>> -.Ed >>> +.Cd umass_load >> >> This now renders as the following - expected? >> >> In loader.conf(5): >> umass_load >> >> I checked your previous similar changes and it seems to be inconsistent, >> some include ="YES" (e.g. 52eb7e394a7) and some do not. > > It's been requested that we don't include the operand. Overall throughout the manual pages using this syntax (which are many more than I've touched actually), there is a mix. I don't think the operand helps it, and it's difficult sometimes when the operand isn't straightforward. > > Suggestions are welcome. > >> Also I don't think .Cd is applicable here, shouldn't it rather be .Va >> (seems more appropriate) or even literal text? > > From mdoc(7): > > Cd line > Kernel configuration declaration. > > Va [type] identifier ... > A variable name. > > The line is telling the loader to load the kernel module into the kernel. Thus it is a kernel configuration declaration. This lets people search the manual by kernel configuration, like so: > Your interpretation doesn't line up with the rest of Cd's description: "This denotes strings accepted by config(8)." That's further supported by the OpenBSD-ish example. Cd here would be something like: .Cd device umass Because that is the config(8) description that you would put into a kernel config(5). What we put in loader.conf is more akin to an environment variable, and loader itself loads the module. Thanks, Kyle Evans