Date: Thu, 11 Feb 2021 08:54:56 +0100 From: Lutz Donnerhacke <lutz@donnerhacke.de> To: Warner Losh <imp@bsdimp.com> Cc: "freebsd-arch@freebsd.org" <arch@freebsd.org> Subject: Re: adding a sysctl man section Message-ID: <20210211075456.GA7928@belenus.iks-jena.de> In-Reply-To: <CANCZdfrD3aUS9YQQkA9yZxvUDvBdbfmMcuteqPp8yeDHoA_grQ@mail.gmail.com> References: <20210211001505.GF31099@funkthat.com> <CANCZdfrD3aUS9YQQkA9yZxvUDvBdbfmMcuteqPp8yeDHoA_grQ@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, Feb 10, 2021 at 06:37:00PM -0700, Warner Losh wrote: > On Wed, Feb 10, 2021 at 5:15 PM John-Mark Gurney <jmg@funkthat.com> wrote: > > 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 <sysctl> and get directed to the > > page that has information about it. > > > > Any objections? I'd oppose, it will clutter the filesystem for a "man -k" (or similar) shortcut. > 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: Device driver man pages (like ixl) tend to document a # instead of the number. So this would be dev.uhub.#.%parent ... in the man page.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20210211075456.GA7928>