diff mbox series

nfs-utils: Fix man page syntax errors

Message ID 20220122194537.118609-1-carnil@debian.org (mailing list archive)
State New, archived
Headers show
Series nfs-utils: Fix man page syntax errors | expand

Commit Message

Salvatore Bonaccorso Jan. 22, 2022, 7:45 p.m. UTC 
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>
---
 support/nfsidmap/idmapd.conf.5 | 4 ++--
 utils/idmapd/idmapd.man        | 4 ++--
 utils/mount/nfsmount.conf.man  | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

Comments

Steve Dickson Jan. 31, 2022, 4:56 p.m. UTC | #1 
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
diff mbox series

Patch

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