From owner-svn-src-all@freebsd.org Mon Oct 26 16:56:18 2020 Return-Path: Delivered-To: svn-src-all@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 36417449752; Mon, 26 Oct 2020 16:56:18 +0000 (UTC) (envelope-from mpp302@gmail.com) Received: from mail-ed1-f41.google.com (mail-ed1-f41.google.com [209.85.208.41]) (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 4CKgw10nZnz4TND; Mon, 26 Oct 2020 16:56:16 +0000 (UTC) (envelope-from mpp302@gmail.com) Received: by mail-ed1-f41.google.com with SMTP id dn5so10132914edb.10; Mon, 26 Oct 2020 09:56:16 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-transfer-encoding :content-language; bh=1Xf0tG5YX342nSyazSmeQNWtj66nxURhugJ6Cf4vTBM=; b=EmcYdlZ+7Whtz3aIt5Ct3cuVa2wRZ8OekAgrnIuPVcEx9sOjv7HRj9SuMFuUlFYCXn 9j41c6ifWYTK7GV2plsUNSWlPRe/N2nK8KRqz2E6QS6OtF+CHWBRDREsCwOK1IPJVcEC +mdznihMZd64pHsSJlCy7ifyU+c81XyGildaYzK1HuLnDZCsm+4YZvOz3VY1K6FXkXR2 hXOP2QYTOCm+QVPxLI6m4wIX7bp50z4Ilo+W6rbYTqG02rmQcQHu/BTsSyZ4kYUea3JU a34dNqiVzTHmUsNJG7qOcT2W0lLHS+36TcK5+Pgwlj1SDbU9obSeFq82yt3TzU/Kq4qx oH+w== X-Gm-Message-State: AOAM533KMUJt19vxcB/IbMetZrDUrWKhUbEwh/d+kRFfQv3DT+pFdZg8 ijlh/uCsGgIxXTIJNysYwuIMF7opr9KaaQ== X-Google-Smtp-Source: ABdhPJz65g1AJ8MLvLiMt1WIeRU64LOYHfXUrRqMufk538mN6gXuJA+AhRocnD1Cn7W4OL1k9FEnaA== X-Received: by 2002:a05:6402:74f:: with SMTP id p15mr16981731edy.69.1603731375141; Mon, 26 Oct 2020 09:56:15 -0700 (PDT) Received: from ?IPv6:2a02:8109:98c0:1bc0:5e5f:67ff:fef4:ffd8? ([2a02:8109:98c0:1bc0:5e5f:67ff:fef4:ffd8]) by smtp.gmail.com with ESMTPSA id q19sm3040702ejx.118.2020.10.26.09.56.13 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 26 Oct 2020 09:56:14 -0700 (PDT) Subject: Re: svn commit: r366725 - head/lib/geom/eli To: Gordon Bergling Cc: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org References: <202010151417.09FEHjjq080474@repo.freebsd.org> <20201015144735.GA33346@lion.0xfce3.net> From: Mateusz Piotrowski <0mp@FreeBSD.org> Message-ID: <8297cdb3-dcb6-2907-e1c7-b3d629e7001e@FreeBSD.org> Date: Mon, 26 Oct 2020 17:56:17 +0100 User-Agent: Mozilla/5.0 (X11; FreeBSD amd64; rv:78.0) Gecko/20100101 Thunderbird/78.3.3 MIME-Version: 1.0 In-Reply-To: <20201015144735.GA33346@lion.0xfce3.net> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US X-Rspamd-Queue-Id: 4CKgw10nZnz4TND X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org; dkim=none; dmarc=none; spf=pass (mx1.freebsd.org: domain of mpp302@gmail.com designates 209.85.208.41 as permitted sender) smtp.mailfrom=mpp302@gmail.com X-Spamd-Result: default: False [-2.27 / 15.00]; RCVD_TLS_ALL(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; MID_RHS_MATCH_FROM(0.00)[]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[4]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; MIME_GOOD(-0.10)[text/plain]; R_SPF_ALLOW(-0.20)[+ip4:209.85.128.0/17]; ARC_NA(0.00)[]; DMARC_NA(0.00)[FreeBSD.org]; NEURAL_HAM_LONG(-0.95)[-0.950]; RCVD_COUNT_THREE(0.00)[3]; NEURAL_HAM_MEDIUM(-1.00)[-0.996]; NEURAL_HAM_SHORT(-0.32)[-0.322]; RCVD_IN_DNSWL_NONE(0.00)[209.85.208.41:from]; FORGED_SENDER(0.30)[0mp@FreeBSD.org,mpp302@gmail.com]; RWL_MAILSPIKE_POSSIBLE(0.00)[209.85.208.41:from]; R_DKIM_NA(0.00)[]; FREEMAIL_ENVFROM(0.00)[gmail.com]; ASN(0.00)[asn:15169, ipnet:209.85.128.0/17, country:US]; MIME_TRACE(0.00)[0:+]; FROM_NEQ_ENVFROM(0.00)[0mp@FreeBSD.org,mpp302@gmail.com]; MAILMAN_DEST(0.00)[svn-src-head,svn-src-all] X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.33 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 26 Oct 2020 16:56:18 -0000 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