From owner-freebsd-arch@freebsd.org Thu Feb 11 01:37:13 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 D5178531F7E for ; Thu, 11 Feb 2021 01:37:13 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: from mailman.nyi.freebsd.org (unknown [127.0.1.3]) by mx1.freebsd.org (Postfix) with ESMTP id 4DbfPj4YT7z4SfX for ; Thu, 11 Feb 2021 01:37:13 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: by mailman.nyi.freebsd.org (Postfix) id 9C5A5531F7D; Thu, 11 Feb 2021 01:37:13 +0000 (UTC) Delivered-To: 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 9C23D531F7C for ; Thu, 11 Feb 2021 01:37:13 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: from mail-qt1-x835.google.com (mail-qt1-x835.google.com [IPv6:2607:f8b0:4864:20::835]) (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-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "smtp.gmail.com", Issuer "GTS CA 1O1" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4DbfPh5P1vz4T2J for ; Thu, 11 Feb 2021 01:37:12 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: by mail-qt1-x835.google.com with SMTP id h16so3087038qth.11 for ; Wed, 10 Feb 2021 17:37:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bsdimp-com.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=AXIeM8ICuA67OgIhEc9rmekPyaHcr2whrdcqnhBTy08=; b=KX8bPgazWrZNU/ycI01F7y+hUos4D5uvINkII/IVHorOeiuZ8nwTGtAHaNZL+wjtSs cmcdvJ/vCQOSduGH5J2PEEcU8WBsKWLdO1WA5RjW3LmUfW+zIV+eoM3/AMhGXfPDeOzY yVyJTCFwSZEjc1lG03LX59ARoeeNShfG54myBDmGPv8ZPtVI7A0XSpvblMSNP78+pIBy XQS142pAN4u0Z5V41cpHuqMTK/lcm3fzBpCXm5qVn9ZCfiombEhKiBUYEZ8/3nQ+LMox hEzbQonCKPoxYy3mvE4XqbYVbqOaZ0kvpQFWQ/iSjNZLqdbAIYKQmU7wMgQl8rJw0oI0 kbYA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=AXIeM8ICuA67OgIhEc9rmekPyaHcr2whrdcqnhBTy08=; b=uTreJvJs7NlUH7UxpVm/k9D69dBJu4kw5cYhovkkhRsHihGGICacarT7vzBLDp76/a 7PR35CR6gitfdbdKVY+nUKg7dPc1zVAimd8FvTnOClG6j3cmUEFRCiUwJWl7GTqsHKH6 TSuLjUjEOikA5VxwnQ0xqNRZCtPg2KN58R0JDlQuVg0plonXccJTQO2n11ts9YZwLJo7 S753Ag2RYOhw9k9oZ8HrIQV3v5MXCfs/sPK+H7rUON+6svdUAIwYyZDq5Nh7C1hGppxs ULj5OMnxAzQlP/NSHuhuUdpYiC+Qfz6TKGK6urcOkBeGj7I7KGAkcqUNIVh625qFocPa eLRA== X-Gm-Message-State: AOAM530hbrue7Dm/B/2VTRcvDoBuSjhQ8dXN6PVN3pK/FEJbuEch7tCP 7sPsb4cbnrH0FSe9G7Ne3Gq16yd4p+DZwC35FEWztoAfEGBcCkAw X-Google-Smtp-Source: ABdhPJwEOo5eWmJfGyj4CzfVX4rcKdAdpqjkiQ67reDqid4pbsLcN+TJFRWS2etLJ36iL0aGS9y1FGUyJQhS3v1jAKU= X-Received: by 2002:ac8:6c48:: with SMTP id z8mr5566496qtu.73.1613007431235; Wed, 10 Feb 2021 17:37:11 -0800 (PST) MIME-Version: 1.0 References: <20210211001505.GF31099@funkthat.com> In-Reply-To: <20210211001505.GF31099@funkthat.com> From: Warner Losh Date: Wed, 10 Feb 2021 18:37:00 -0700 Message-ID: Subject: Re: adding a sysctl man section To: "freebsd-arch@freebsd.org" X-Rspamd-Queue-Id: 4DbfPh5P1vz4T2J X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org; dkim=pass header.d=bsdimp-com.20150623.gappssmtp.com header.s=20150623 header.b=KX8bPgaz; dmarc=none; spf=none (mx1.freebsd.org: domain of wlosh@bsdimp.com has no SPF policy when checking 2607:f8b0:4864:20::835) smtp.mailfrom=wlosh@bsdimp.com X-Spamd-Result: default: False [-3.00 / 15.00]; RCVD_TLS_ALL(0.00)[]; ARC_NA(0.00)[]; R_DKIM_ALLOW(-0.20)[bsdimp-com.20150623.gappssmtp.com:s=20150623]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; FROM_HAS_DN(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000]; MIME_GOOD(-0.10)[multipart/alternative,text/plain]; PREVIOUSLY_DELIVERED(0.00)[arch@freebsd.org]; DMARC_NA(0.00)[bsdimp.com]; RCPT_COUNT_ONE(0.00)[1]; SPAMHAUS_ZRD(0.00)[2607:f8b0:4864:20::835:from:127.0.2.255]; TO_DN_ALL(0.00)[]; DKIM_TRACE(0.00)[bsdimp-com.20150623.gappssmtp.com:+]; NEURAL_HAM_SHORT(-1.00)[-1.000]; RCVD_IN_DNSWL_NONE(0.00)[2607:f8b0:4864:20::835:from]; R_SPF_NA(0.00)[no SPF record]; FORGED_SENDER(0.30)[imp@bsdimp.com,wlosh@bsdimp.com]; MIME_TRACE(0.00)[0:+,1:+,2:~]; RBL_DBL_DONT_QUERY_IPS(0.00)[2607:f8b0:4864:20::835:from]; ASN(0.00)[asn:15169, ipnet:2607:f8b0::/32, country:US]; FROM_NEQ_ENVFROM(0.00)[imp@bsdimp.com,wlosh@bsdimp.com]; MAILMAN_DEST(0.00)[arch]; RCVD_COUNT_TWO(0.00)[2] Content-Type: text/plain; charset="UTF-8" X-Content-Filtered-By: Mailman/MimeDel 2.1.34 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: Thu, 11 Feb 2021 01:37:13 -0000 On Wed, Feb 10, 2021 at 5: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 adding the sysctl to the man page is great. However, I have a concern about the links: % sysctl -a | wc 38632 78349 1423715 This suggests a lot of links if this idea were to be fully populated (though maybe not 30k) Also, how do you document things like the dev hierarchy which has a unit number tossed into the middle? dev.uhub.1.%parent: usbus1 dev.uhub.1.%pnpinfo: dev.uhub.1.%location: dev.uhub.1.%driver: uhub dev.uhub.1.%desc: 0x1022 XHCI root HUB, class 9/0, rev 3.00/1.00, addr 1 dev.uhub.0.disable_port_power: 0 dev.uhub.0.disable_enumeration: 0 dev.uhub.0.%domain: 0 dev.uhub.0.%parent: usbus0 dev.uhub.0.%pnpinfo: dev.uhub.0.%location: dev.uhub.0.%driver: uhub Also, all the nodes have the %parent, %pnp, %location, %driver and %desc nodes. Those are provided by newbus, while everything else is dependent on the driver... Warner > -- > John-Mark Gurney Voice: +1 415 225 5579 > > "All that I will do, has been done, All that I have, has not." > _______________________________________________ > freebsd-arch@freebsd.org mailing list > https://lists.freebsd.org/mailman/listinfo/freebsd-arch > To unsubscribe, send any mail to "freebsd-arch-unsubscribe@freebsd.org" >