2024-01-04 08:26:18

by Gioele Barabucci

[permalink] [raw]
Subject: [PATCH v2 0/3] Typos and documentation fixes

Hi,

the following three patches fix a few typos detected by Debian's QA tool
lintian. The last patch also adds Documentation= options to various
service files.

--
v2: rebased on top of 2.7.1-rc3, added S-o-B trailers

Regards,

Gioele Barabucci (3):
Fix typos in error messages
Fix typos in manpages
systemd: Add Documentation= option to service units

support/export/export.c | 2 +-
support/export/v4root.c | 2 +-
systemd/nfs-blkmap.service | 1 +
systemd/nfs-idmapd.service | 1 +
systemd/nfs-mountd.service | 1 +
systemd/nfs-server.service | 1 +
systemd/nfsdcld.service | 1 +
systemd/rpc-gssd.service.in | 1 +
systemd/rpc-statd-notify.service | 1 +
systemd/rpc-statd.service | 1 +
systemd/rpc-svcgssd.service | 1 +
utils/exportfs/exports.man | 2 +-
utils/mount/mount_libmount.c | 2 +-
utils/mount/nfs.man | 4 ++--
utils/mount/nfsmount.conf.man | 2 +-
utils/nfsdcld/nfsdcld.man | 2 +-
utils/nfsdcltrack/nfsdcltrack.man | 2 +-
17 files changed, 18 insertions(+), 9 deletions(-)

--
2.43.0



2024-01-04 08:26:25

by Gioele Barabucci

[permalink] [raw]
Subject: [PATCH v2 1/3] Fix typos in error messages

Signed-off-by: Gioele Barabucci <[email protected]>
---
support/export/export.c | 2 +-
support/export/v4root.c | 2 +-
utils/mount/mount_libmount.c | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/support/export/export.c b/support/export/export.c
index 100912cb..2c8c3335 100644
--- a/support/export/export.c
+++ b/support/export/export.c
@@ -140,7 +140,7 @@ export_read(char *fname, int ignore_hosts)
continue;

if (exp->m_export.e_flags & NFSEXP_FSID) {
- xlog(L_ERROR, "When a reexport= option is present no manully assigned numerical fsid= options are allowed");
+ xlog(L_ERROR, "When a reexport= option is present no manually assigned numerical fsid= options are allowed");
return -1;
}
}
diff --git a/support/export/v4root.c b/support/export/v4root.c
index 03805dcb..c3b17a55 100644
--- a/support/export/v4root.c
+++ b/support/export/v4root.c
@@ -137,7 +137,7 @@ v4root_support(void)
if (!warned) {
xlog(L_WARNING, "Kernel does not have pseudo root support.");
xlog(L_WARNING, "NFS v4 mounts will be disabled unless fsid=0");
- xlog(L_WARNING, "is specfied in /etc/exports file.");
+ xlog(L_WARNING, "is specified in /etc/exports file.");
warned++;
}
return 0;
diff --git a/utils/mount/mount_libmount.c b/utils/mount/mount_libmount.c
index aa4ac5c3..fd6cb2cb 100644
--- a/utils/mount/mount_libmount.c
+++ b/utils/mount/mount_libmount.c
@@ -442,7 +442,7 @@ int main(int argc, char *argv[])
mnt_init_debug(0);
cxt = mnt_new_context();
if (!cxt) {
- nfs_error(_("Can't initilize libmount: %s"),
+ nfs_error(_("Can't initialize libmount: %s"),
strerror(errno));
rc = EX_FAIL;
goto done;
--
2.43.0


2024-01-04 08:26:29

by Gioele Barabucci

[permalink] [raw]
Subject: [PATCH v2 2/3] Fix typos in manpages

Signed-off-by: Gioele Barabucci <[email protected]>
---
utils/exportfs/exports.man | 2 +-
utils/mount/nfs.man | 4 ++--
utils/mount/nfsmount.conf.man | 2 +-
utils/nfsdcld/nfsdcld.man | 2 +-
utils/nfsdcltrack/nfsdcltrack.man | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/utils/exportfs/exports.man b/utils/exportfs/exports.man
index b7582776..58537a22 100644
--- a/utils/exportfs/exports.man
+++ b/utils/exportfs/exports.man
@@ -298,7 +298,7 @@ set.

The
.I nocrossmnt
-option can explictly disable
+option can explicitly disable
.I crossmnt
if it was previously set. This is rarely useful.
.TP
diff --git a/utils/mount/nfs.man b/utils/mount/nfs.man
index c0ba4d08..7103d28e 100644
--- a/utils/mount/nfs.man
+++ b/utils/mount/nfs.man
@@ -964,7 +964,7 @@ Some server features misbehave in the face of a migration-compatible
identification string.
The
.B nomigration
-option retains the use of a traditional client indentification string
+option retains the use of a traditional client identification string
which is compatible with legacy NFS servers.
This is also the behavior if neither option is specified.
A client's open and lock state cannot be migrated transparently
@@ -1832,7 +1832,7 @@ auxiliary services such as the NLM service can choose
any unused port number at random.
.P
Common firewall configurations block the well-known rpcbind port.
-In the absense of an rpcbind service,
+In the absence of an rpcbind service,
the server administrator fixes the port number
of NFS-related services so that the firewall
can allow access to specific NFS service ports.
diff --git a/utils/mount/nfsmount.conf.man b/utils/mount/nfsmount.conf.man
index 10287cdf..6419190c 100644
--- a/utils/mount/nfsmount.conf.man
+++ b/utils/mount/nfsmount.conf.man
@@ -43,7 +43,7 @@ and will be shifted to lower case before being passed to the filesystem.
.PP
Boolean mount options which do not need an equals sign must be given as
.RI \[dq] option =True".
-Instead of preceeding such an option with
+Instead of preceding such an option with
.RB \[dq] no \[dq]
its negation must be given as
.RI \[dq] option =False".
diff --git a/utils/nfsdcld/nfsdcld.man b/utils/nfsdcld/nfsdcld.man
index 861f1c49..ee6e9dcf 100644
--- a/utils/nfsdcld/nfsdcld.man
+++ b/utils/nfsdcld/nfsdcld.man
@@ -198,7 +198,7 @@ initialize client tracking in the following order: First, the \fBnfsdcld\fR upc
the \fBnfsdcltrack\fR usermodehelper upcall. Finally, the legacy client tracking.
.PP
This daemon should be run as root, as the pipe that it uses to communicate
-with the kernel is only accessable by root. The daemon however does drop all
+with the kernel is only accessible by root. The daemon however does drop all
superuser capabilities after starting. Because of this, the \fIstoragedir\fR
should be owned by root, and be readable and writable by owner.
.PP
diff --git a/utils/nfsdcltrack/nfsdcltrack.man b/utils/nfsdcltrack/nfsdcltrack.man
index cc24b7a2..3905ba46 100644
--- a/utils/nfsdcltrack/nfsdcltrack.man
+++ b/utils/nfsdcltrack/nfsdcltrack.man
@@ -80,7 +80,7 @@ section. For example:
.br
storagedir = /shared/nfs/nfsdcltrack
.in -5
-Debuging to syslog can also be enabled by setting "debug = 1" in this file.
+Debugging to syslog can also be enabled by setting "debug = 1" in this file.
.SH "LEGACY TRANSITION MECHANISM"
.IX Header "LEGACY TRANSITION MECHANISM"
The Linux kernel NFSv4 server has historically tracked this information
--
2.43.0


2024-01-04 08:26:30

by Gioele Barabucci

[permalink] [raw]
Subject: [PATCH v2 3/3] systemd: Add Documentation= option to service units

Signed-off-by: Gioele Barabucci <[email protected]>
---
systemd/nfs-blkmap.service | 1 +
systemd/nfs-idmapd.service | 1 +
systemd/nfs-mountd.service | 1 +
systemd/nfs-server.service | 1 +
systemd/nfsdcld.service | 1 +
systemd/rpc-gssd.service.in | 1 +
systemd/rpc-statd-notify.service | 1 +
systemd/rpc-statd.service | 1 +
systemd/rpc-svcgssd.service | 1 +
9 files changed, 9 insertions(+)

diff --git a/systemd/nfs-blkmap.service b/systemd/nfs-blkmap.service
index 6aa45ba1..57181632 100644
--- a/systemd/nfs-blkmap.service
+++ b/systemd/nfs-blkmap.service
@@ -1,5 +1,6 @@
[Unit]
Description=pNFS block layout mapping daemon
+Documentation=man:blkmapd(8)
DefaultDependencies=no
Conflicts=umount.target
After=rpc_pipefs.target
diff --git a/systemd/nfs-idmapd.service b/systemd/nfs-idmapd.service
index 198ca87c..d820f10c 100644
--- a/systemd/nfs-idmapd.service
+++ b/systemd/nfs-idmapd.service
@@ -1,5 +1,6 @@
[Unit]
Description=NFSv4 ID-name mapping service
+Documentation=man:idmapd(8)
DefaultDependencies=no
Requires=rpc_pipefs.target
After=rpc_pipefs.target local-fs.target network-online.target
diff --git a/systemd/nfs-mountd.service b/systemd/nfs-mountd.service
index e8ece533..4618fab1 100644
--- a/systemd/nfs-mountd.service
+++ b/systemd/nfs-mountd.service
@@ -1,5 +1,6 @@
[Unit]
Description=NFS Mount Daemon
+Documentation=man:rpc.mountd(8)
DefaultDependencies=no
Requires=proc-fs-nfsd.mount
Wants=network-online.target
diff --git a/systemd/nfs-server.service b/systemd/nfs-server.service
index 2cdd7868..ac17d528 100644
--- a/systemd/nfs-server.service
+++ b/systemd/nfs-server.service
@@ -1,5 +1,6 @@
[Unit]
Description=NFS server and services
+Documentation=man:rpc.nfsd(8) man:exportfs(8)
DefaultDependencies=no
Requires=network.target proc-fs-nfsd.mount
Requires=nfs-mountd.service
diff --git a/systemd/nfsdcld.service b/systemd/nfsdcld.service
index a32d2430..3ced5658 100644
--- a/systemd/nfsdcld.service
+++ b/systemd/nfsdcld.service
@@ -1,5 +1,6 @@
[Unit]
Description=NFSv4 Client Tracking Daemon
+Documentation=man:nfsdcld(8)
DefaultDependencies=no
Conflicts=umount.target
Requires=rpc_pipefs.target proc-fs-nfsd.mount
diff --git a/systemd/rpc-gssd.service.in b/systemd/rpc-gssd.service.in
index 6807db35..38382ed3 100644
--- a/systemd/rpc-gssd.service.in
+++ b/systemd/rpc-gssd.service.in
@@ -1,5 +1,6 @@
[Unit]
Description=RPC security service for NFS client and server
+Documentation=man:rpc.gssd(8)
DefaultDependencies=no
Conflicts=umount.target
Requires=rpc_pipefs.target
diff --git a/systemd/rpc-statd-notify.service b/systemd/rpc-statd-notify.service
index aad4c0d2..962f18b2 100644
--- a/systemd/rpc-statd-notify.service
+++ b/systemd/rpc-statd-notify.service
@@ -1,5 +1,6 @@
[Unit]
Description=Notify NFS peers of a restart
+Documentation=man:sm-notify(8) man:rpc.statd(8)
DefaultDependencies=no
Wants=network-online.target
After=local-fs.target network-online.target nss-lookup.target
diff --git a/systemd/rpc-statd.service b/systemd/rpc-statd.service
index 392750da..660ed861 100644
--- a/systemd/rpc-statd.service
+++ b/systemd/rpc-statd.service
@@ -1,5 +1,6 @@
[Unit]
Description=NFS status monitor for NFSv2/3 locking.
+Documentation=man:rpc.statd(8)
DefaultDependencies=no
Conflicts=umount.target
Requires=nss-lookup.target rpcbind.socket
diff --git a/systemd/rpc-svcgssd.service b/systemd/rpc-svcgssd.service
index cb2bcd4f..401fba11 100644
--- a/systemd/rpc-svcgssd.service
+++ b/systemd/rpc-svcgssd.service
@@ -1,5 +1,6 @@
[Unit]
Description=RPC security service for NFS server
+Documentation=man:rpc.svcgssd(8)
DefaultDependencies=no
After=local-fs.target
PartOf=nfs-server.service
--
2.43.0


2024-01-23 15:17:26

by Steve Dickson

[permalink] [raw]
Subject: Re: [PATCH v2 0/3] Typos and documentation fixes



On 1/4/24 3:25 AM, Gioele Barabucci wrote:
> Hi,
>
> the following three patches fix a few typos detected by Debian's QA tool
> lintian. The last patch also adds Documentation= options to various
> service files.
>
> --
> v2: rebased on top of 2.7.1-rc3, added S-o-B trailers
>
> Regards,
>
> Gioele Barabucci (3):
> Fix typos in error messages
> Fix typos in manpages
> systemd: Add Documentation= option to service units
>
> support/export/export.c | 2 +-
> support/export/v4root.c | 2 +-
> systemd/nfs-blkmap.service | 1 +
> systemd/nfs-idmapd.service | 1 +
> systemd/nfs-mountd.service | 1 +
> systemd/nfs-server.service | 1 +
> systemd/nfsdcld.service | 1 +
> systemd/rpc-gssd.service.in | 1 +
> systemd/rpc-statd-notify.service | 1 +
> systemd/rpc-statd.service | 1 +
> systemd/rpc-svcgssd.service | 1 +
> utils/exportfs/exports.man | 2 +-
> utils/mount/mount_libmount.c | 2 +-
> utils/mount/nfs.man | 4 ++--
> utils/mount/nfsmount.conf.man | 2 +-
> utils/nfsdcld/nfsdcld.man | 2 +-
> utils/nfsdcltrack/nfsdcltrack.man | 2 +-
> 17 files changed, 18 insertions(+), 9 deletions(-)
>
Thanks for doing this... sorry it too so long.

Committed... (tag: nfs-utils-2-7-1-rc4)

steved.