Date: Mon, 26 Oct 2020 17:56:17 +0100 From: Mateusz Piotrowski <0mp@FreeBSD.org> To: Gordon Bergling <gbe@freebsd.org> Cc: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r366725 - head/lib/geom/eli Message-ID: <8297cdb3-dcb6-2907-e1c7-b3d629e7001e@FreeBSD.org> In-Reply-To: <20201015144735.GA33346@lion.0xfce3.net> References: <202010151417.09FEHjjq080474@repo.freebsd.org> <20201015144735.GA33346@lion.0xfce3.net>
next in thread | previous in thread | raw e-mail | index | archive | help
Hi Gordon! On 10/15/20 4:47 PM, Gordon Bergling wrote: > Hi Mateusz, > > On Thu, Oct 15, 2020 at 02:17:45PM +0000, Mateusz Piotrowski wrote: >> Author: 0mp (doc,ports committer) >> Date: Thu Oct 15 14:17:45 2020 >> New Revision: 366725 >> URL: https://svnweb.freebsd.org/changeset/base/366725 >> >> Log: >> Fix formatting of SYNOPSIS >> >> There was an unnecessary newline being added before Nm. >> >> MFC after: 3 days >> >> Modified: >> head/lib/geom/eli/geli.8 >> >> Modified: head/lib/geom/eli/geli.8 >> ============================================================================== >> --- head/lib/geom/eli/geli.8 Thu Oct 15 13:47:52 2020 (r366724) >> +++ head/lib/geom/eli/geli.8 Thu Oct 15 14:17:45 2020 (r366725) >> @@ -24,7 +24,7 @@ >> .\" >> .\" $FreeBSD$ >> .\" >> -.Dd July 22, 2020 >> +.Dd October 15, 2020 >> .Dt GELI 8 >> .Os >> .Sh NAME >> @@ -45,8 +45,7 @@ to your >> geom_eli_load="YES" >> .Ed >> .Pp >> -Usage of the >> -.Nm >> +.No Usage of the Nm >> utility: >> .Pp >> .Nm > The formatting of the SYNOPSIS was correct before this change. It's a common practice > in man pages to use > > The > .Nm > utility > ... Hmm, I think that you are missing one detail here: in SYNOPSIS, the Nm macro is automatically printed on a newline, so the fold manual page rendered like this: ``` Usage of the geli utility: ``` while after the update it's like so: ``` Usage of the geli utility: ``` I think it looks better even though ".No Usage of the Nm" looks quite ugly. > Your change is looking somewhat strange, since ".No Usage of the Nm" reads like the > man page would renders "Nm", since it is not used as macro. After a dot at the beginning of the line, everything that looks like a macro is rendered as a macro, so Nm is rendered correctly here. It could be that I've totally missed the point of your concerns, in which case I'd grateful if you could explain the issue once more. Thanks! > > A .Dd bump is also not necessary since no user visible changes were made to the man page. I wasn't sure about bumping but then I thought that an improvement to readability justifies a Dd bump. Cheers, Mateusz
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?8297cdb3-dcb6-2907-e1c7-b3d629e7001e>