Date: Sat, 21 Feb 2026 12:40:18 -0800 From: Adrian Chadd <adrian@freebsd.org> To: ziaee@freebsd.org Cc: arch@freebsd.org, doc@freebsd.org, ivy@freebsd.org, kib@freebsd.org Subject: Re: man: Merging LIBRARY and SYNOPSIS Message-ID: <CAJ-VmokvjEyWoPBA1M8Z41D8jb6-qCFRgwjExm6tyuevsMoEGg@mail.gmail.com> In-Reply-To: <699a0480.48403.1557781e@baud>
index | next in thread | previous in thread | raw e-mail
On Sat, 21 Feb 2026 at 11:16, <ziaee@freebsd.org> wrote: > > hello, > > i want to merge the library section into the synopsis section in the > rest of our manuals, following changes to the mdoc language upstream > in mandoc and groff that shipped in 15.0-R and the upcoming 14.4-R. > this represents the cross-platform evolution of the over half-century > old tradition of unix manual pages in 21st century q2. > > i want to switch the rest of them over all at once; with this change: > + how to link the library is still shown on the same line > + duplicate info and an empty line is freed for information > + synopsis is strengthened as the "just how to use it" section > + description is strengthened as "describe what it is" section > + doing what everyone else is doing lowers the load on everyone > + we're cleanly implementing the absolute cutting-edge technology > > i sent a mail to doc@ last july when i imported the change to mandoc. > no one responded, and we shipped a few manuals this way in 15.0/14.4. > so far kib and ivy said they didn't really like it but neither objected. > > here is a draft attempting to do this for the c library as an example: > https://reviews.freebsd.org/D55411.diff > What's this buy us vs cost us? Like, having a LIBRARY section means we can build an index on all pages that have a library section in common? -adrianhome | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAJ-VmokvjEyWoPBA1M8Z41D8jb6-qCFRgwjExm6tyuevsMoEGg>