Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <6c39ba93-8c77-ed4f-5420-56732d582f30@redhat.com>
Date:   Mon, 31 Jan 2022 11:56:53 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.4.0
Subject: Re: [PATCH] nfs-utils: Fix man page syntax errors
Content-Language: en-US
To:     Salvatore Bonaccorso <carnil@debian.org>
Cc:     linux-nfs@vger.kernel.org, Stefan Walter <walteste@inf.ethz.ch>,
        Ben Hutchings <benh@debian.org>
References: <20220122194537.118609-1-carnil@debian.org>
From:   Steve Dickson <steved@redhat.com>
In-Reply-To: <20220122194537.118609-1-carnil@debian.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 1/22/22 14:45, Salvatore Bonaccorso wrote:
> From: Ben Hutchings <benh@debian.org>
> 
> In idmapd.conf.5, there is a line of what should be literal text
> beginning with ".", which makes it an (invalid) command.  It can be
> escaped, but then there will be a space before it.  Instead, Move it
> to the previous line and use the .BR macro so there's no space.
> 
> In idmapd.man, the .I (italic) macro is used.  However, this manual
> page uses the mdoc macro package that does not include it.  Use the
> .Em (emphasis) macro instead.
> 
> In nfsmount.conf.man, the first line should be a comment but it is
> actually an invalid command.  Fix it to be a comment.
> 
> Signed-off-by: Ben Hutchings <benh@debian.org>
> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
Committed... (tag: nfs-utils-2-6-2-rc1)

steved.

> ---
>   support/nfsidmap/idmapd.conf.5 | 4 ++--
>   utils/idmapd/idmapd.man        | 4 ++--
>   utils/mount/nfsmount.conf.man  | 2 +-
>   3 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/support/nfsidmap/idmapd.conf.5 b/support/nfsidmap/idmapd.conf.5
> index f5b181670ddb..87e39bb41ab1 100644
> --- a/support/nfsidmap/idmapd.conf.5
> +++ b/support/nfsidmap/idmapd.conf.5
> @@ -198,8 +198,8 @@ With this group names of a central directory can be shortened for an isolated or
>   .TP
>   .B Group-Name-No-Prefix-Regex
>   Case-insensitive regular expression to exclude groups from adding and removing the prefix set by
> -.B Group-Name-Prefix
> -. The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'.
> +.BR Group-Name-Prefix .
> +The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'.
>   (Default: none)
>   .\"
>   .\" -------------------------------------------------------------------
> diff --git a/utils/idmapd/idmapd.man b/utils/idmapd/idmapd.man
> index 5f34d2bff860..8215d2594bfa 100644
> --- a/utils/idmapd/idmapd.man
> +++ b/utils/idmapd/idmapd.man
> @@ -24,13 +24,13 @@ the NFSv4 kernel client and server, to which it communicates via
>   upcalls, by translating user and group IDs to names, and vice versa.
>   .Pp
>   The system derives the
> -.I user
> +.Em user
>   part of the string by performing a password or group lookup.
>   The lookup mechanism is configured in
>   .Pa /etc/idmapd.conf
>   .Pp
>   By default, the
> -.I domain
> +.Em domain
>   part of the string is the system's DNS domain name.
>   It can also be specified in
>   .Pa /etc/idmapd.conf
> diff --git a/utils/mount/nfsmount.conf.man b/utils/mount/nfsmount.conf.man
> index 73c3e1188541..34879c8d63c7 100644
> --- a/utils/mount/nfsmount.conf.man
> +++ b/utils/mount/nfsmount.conf.man
> @@ -1,4 +1,4 @@
> -."@(#)nfsmount.conf.5"
> +.\" @(#)nfsmount.conf.5"
>   .TH NFSMOUNT.CONF 5 "16 December 2020"
>   .SH NAME
>   nfsmount.conf - Configuration file for NFS mounts