2022-12-18 17:41:45

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 1/6] nfsd(7): Use "backslash" consistently

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: back-slash vs. backslash, should be consistent

"Each line of the file contains a path name, a client name, and a number of "
"options in parentheses. Any space, tab, newline or back-slash character in "
"the path name or client name will be replaced by a backslash followed by the "
"octal ASCII code for that character."

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 514153f024fa..2abb8933fb11 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -50,7 +50,7 @@ being treated identically.

Each line of the file contains a path name, a client name, and a
number of options in parentheses. Any space, tab, newline or
-back-slash character in the path name or client name will be replaced
+backslash character in the path name or client name will be replaced
by a backslash followed by the octal ASCII code for that character.

.TP



2022-12-18 17:50:14

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 4/6] nfsd(7): Correct grammatical usage of "can be displayed"

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: can be display → can be displayed

"The directory B</proc/net/rpc> in the B<procfs> filesystem contains a number "
"of files and directories. The files contain statistics that can be display "
"using the I<nfsstat> program. The directories contain information about "
"various caches that the NFS server maintains to keep track of access "
"permissions that different clients have for different filesystems. The "
"caches are:"

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index e1f3f65fb297..9481670f9ffc 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -91,7 +91,7 @@ The directory
in the
.B procfs
filesystem contains a number of files and directories.
-The files contain statistics that can be display using the
+The files contain statistics that can be displayed using the
.I nfsstat
program.
The directories contain information about various caches that the NFS


2022-12-18 17:54:48

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 2/6] nfsd(7): Correct grammatical usage of "threads"

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: thread currently → threads currently

"This file represents the number of B<nfsd> thread currently running. "
"Reading it will show the number of threads. Writing an ASCII decimal number "
"will cause the number of threads to be changed (increased or decreased as "
"necessary) to achieve that number."

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 2abb8933fb11..6992e10829e7 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -57,7 +57,7 @@ by a backslash followed by the octal ASCII code for that character.
.B threads
This file represents the number of
.B nfsd
-thread currently running. Reading it will show the number of
+threads currently running. Reading it will show the number of
threads. Writing an ASCII decimal number will cause the number of
threads to be changed (increased or decreased as necessary) to achieve
that number.


2022-12-18 17:58:40

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 5/6] nfsd(7): Correct formatting of "select or poll"

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: select(2) or poll(2) → B<select>(2) or B<poll>(2)

"If the program uses select(2) or poll(2) to discover if it can read from the "
"B<channel> then it will never see and end-of-file but when all requests have "
"been answered, it will block until another request appears."

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 9481670f9ffc..72fe5b1467eb 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -158,8 +158,11 @@ nfsd 127.0.0.1 1057206953 localhost
.br
to indicate that 127.0.0.1 should map to localhost, at least for now.

-If the program uses select(2) or poll(2) to discover if it can read
-from the
+If the program uses
+.BR select (2)
+or
+.BR poll (2)
+to discover if it can read from the
.B channel
then it will never see and end-of-file but when all requests have been
answered, it will block until another request appears.


2022-12-18 17:58:49

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 6/6] nfsd(7): Correct misspelling of "an"

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: and end-of-file → an end-of-file

"If the program uses select(2) or poll(2) to discover if it can read from the "
"B<channel> then it will never see and end-of-file but when all requests have "
"been answered, it will block until another request appears."

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 72fe5b1467eb..ba826af742c4 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -164,7 +164,7 @@ or
.BR poll (2)
to discover if it can read from the
.B channel
-then it will never see and end-of-file but when all requests have been
+then it will never see an end-of-file but when all requests have been
answered, it will block until another request appears.

.PP


2022-12-18 17:59:09

by Chuck Lever

[permalink] [raw]
Subject: [PATCH 3/6] nfsd(7): Clarify description of

From: Chuck Lever <[email protected]>

Man page: nfsd.7
Issue: The first sentence is somewhat logical, but is this really the speciality of this file?

"This is a somewhat unusual file in that what is read from it depends on what "
"was just written to it. It provides a transactional interface where a "
"program can open the file, write a request, and read a response. If two "
"separate programs open, write, and read at the same time, their requests "
"will not be mixed up."

Reported-by: Helge Kreutzmann <[email protected]>
Signed-off-by: Chuck Lever <[email protected]>
---
utils/exportfs/nfsd.man | 24 +++++++++---------------
1 file changed, 9 insertions(+), 15 deletions(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 6992e10829e7..e1f3f65fb297 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -64,23 +64,17 @@ that number.

.TP
.B filehandle
-This is a somewhat unusual file in that what is read from it depends
-on what was just written to it. It provides a transactional interface
-where a program can open the file, write a request, and read a
-response. If two separate programs open, write, and read at the same
-time, their requests will not be mixed up.
+This file provides a transactional interface where a program can
+read back a filehandle for a path as exported to a given client.

-The request written to
-.B filehandle
-should be a client name, a path name, and a number of bytes. This
-should be followed by a newline, with white-space separating the
-fields, and octal quoting of special characters.
-
-On writing this, the program will be able to read back a filehandle
-for that path as exported to the given client. The filehandle's length
-will be at most the number of bytes given.
+Each written request to
+.I filehandle
+should be a client name, a path name, and a number of bytes.
+This should be followed by a newline, with white-space separating
+the fields and octal quoting of special characters.

-The filehandle will be represented in hex with a leading '\ex'.
+The returned filehandle is represented in hex with a leading '\ex'.
+The filehandle's length will be at most the number of bytes given.

.TP
.B clients/


2022-12-18 18:30:30

by Helge Kreutzmann

[permalink] [raw]
Subject: Re: [PATCH 6/6] nfsd(7): Correct misspelling of "an"

Hello Chuck,
wow, that was *fast*.

Thanks for fixing!

Greetings

Helge
--
Dr. Helge Kreutzmann [email protected]
Dipl.-Phys. http://www.helgefjell.de/debian.php
64bit GNU powered gpg signed mail preferred
Help keep free software "libre": http://www.ffii.de/


Attachments:
(No filename) (380.00 B)
signature.asc (849.00 B)
Download all attachments