From owner-freebsd-arch@freebsd.org Fri Feb 12 20:14:02 2021 Return-Path: Delivered-To: freebsd-arch@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 7321052F945 for ; Fri, 12 Feb 2021 20:14:02 +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 "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Dcl7t2szVz3s5H for ; Fri, 12 Feb 2021 20:14:02 +0000 (UTC) (envelope-from jhb@FreeBSD.org) Received: from John-Baldwins-MacBook-Pro.local (unknown [IPv6:2601:648:8681:1cb0:f49a:fe25:79c8:c3ed]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client did not present a certificate) (Authenticated sender: jhb) by smtp.freebsd.org (Postfix) with ESMTPSA id 280485A1F for ; Fri, 12 Feb 2021 20:14:02 +0000 (UTC) (envelope-from jhb@FreeBSD.org) To: freebsd-arch@freebsd.org References: <20210211001505.GF31099@funkthat.com> From: John Baldwin Subject: Re: adding a sysctl man section Message-ID: <936bc860-c61d-ecc3-8e3f-496684bad68a@FreeBSD.org> Date: Fri, 12 Feb 2021 12:14:00 -0800 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:78.0) Gecko/20100101 Thunderbird/78.7.0 MIME-Version: 1.0 In-Reply-To: <20210211001505.GF31099@funkthat.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 8bit X-BeenThere: freebsd-arch@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Discussion related to FreeBSD architecture List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 12 Feb 2021 20:14:02 -0000 On 2/10/21 4:15 PM, John-Mark Gurney wrote: > Inspired by: https://twitter.com/michaeldexter/status/1359614809365311490 > > I realized that we could/should create a new sysctl section. My initial > thought was section s, but I'd be open for other recommendations. > > Then, any page that describes a sysctl, would add an MLINK to it: > MLINK+= xhci.4 hw.usb.xhci.debug.s > > This section would be added to the default search, and then users > would simply be able to type: man and get directed to the > page that has information about it. > > Any objections? I think since they are MLINKs, just have them live in the section of the thing they are linking to. That is, if it is for foo.4, have it live in section 4. If it's a sysctl that's documented as part of a syscall (bar.2), have that MLINK live in section 2. This is how all the other MLINKs work rather than needing a new section. Does this meaning adding sysctl nodes as .Nm entries in the NAME section? I'm also a bit curious how to name per-instance sysctls vs global sysctls (hw.cxgbe.* vs dev.cxgbe.N.*) as Warner mentioned. The global ones are easy, the per-instance ones would warrant some sort of consistent pattern. -- John Baldwin