All of lore.kernel.org
 help / color / mirror / Atom feed
From: cel@kernel.org
To: SteveD@redhat.com
Cc: linux-nfs@vger.kernel.org, debian@helgefjell.de
Subject: [PATCH 3/6] nfsd(7): Clarify description of
Date: Sun, 18 Dec 2022 11:41:41 -0500	[thread overview]
Message-ID: <167138170181.1584402.14449106893754326594.stgit@morisot.1015granger.net> (raw)
In-Reply-To: <167138168903.1584402.12231405451604036910.stgit@morisot.1015granger.net>

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 --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/



  parent reply	other threads:[~2022-12-18 17:37 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-18 16:41 [PATCH 1/6] nfsd(7): Use "backslash" consistently cel
2022-12-18 16:41 ` [PATCH 2/6] nfsd(7): Correct grammatical usage of "threads" cel
2022-12-18 16:41 ` cel [this message]
2022-12-18 16:41 ` [PATCH 4/6] nfsd(7): Correct grammatical usage of "can be displayed" cel
2022-12-18 16:41 ` [PATCH 5/6] nfsd(7): Correct formatting of "select or poll" cel
2022-12-18 16:42 ` [PATCH 6/6] nfsd(7): Correct misspelling of "an" cel
2022-12-18 17:38   ` Helge Kreutzmann

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=167138170181.1584402.14449106893754326594.stgit@morisot.1015granger.net \
    --to=cel@kernel.org \
    --cc=SteveD@redhat.com \
    --cc=debian@helgefjell.de \
    --cc=linux-nfs@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.