diff mbox series

[3/6] nfsd(7): Clarify description of

Message ID 167138170181.1584402.14449106893754326594.stgit@morisot.1015granger.net (mailing list archive)
State New, archived
Headers show
Series [1/6] nfsd(7): Use "backslash" consistently | expand

Commit Message

Chuck Lever Dec. 18, 2022, 4:41 p.m. UTC 
From: Chuck Lever <chuck.lever@oracle.com>

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 <debian@helgefjell.de>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 utils/exportfs/nfsd.man |   24 +++++++++---------------
 1 file changed, 9 insertions(+), 15 deletions(-)
diff mbox series

Patch

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/