[PATCH 1/2] nfsd(7): minimal updates

[PATCH 1/2] nfsd(7): minimal updates

[J. Bruce Fields]

From: "J. Bruce Fields" <bfields@redhat.com>

The nfsd(7) man page has some useful documentation of the files under
/proc/fs/nfsd/ and proc/net/rpc, but it's many years out of date.

As a start, banish any discussion of the long-deprecated nfsctl
systemcall to a NOTES section at the end, and admit that there are more
than 3 files under /proc/fs/nfsd/.

Signed-off-by: J. Bruce Fields <bfields@redhat.com>
---
 utils/exportfs/nfsd.man | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 9efa29f9f01c..1392f3926053 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -13,14 +13,8 @@ nfsd \- special filesystem for controlling Linux NFS server
 The
 .B nfsd
 filesystem is a special filesystem which provides access to the Linux
-NFS server.  The filesystem consists of a single directory which
-contains a number of files.  These files are actually gateways into
-the NFS server.  Writing to them can affect the server.  Reading from
-them can provide information about the server.
-.P
-This file system is only available in Linux 2.6 and later series
-kernels (and in the later parts of the 2.5 development series leading
-up to 2.6).  This man page does not apply to 2.4 and earlier.
+NFS server.  Writing to files in this filesystem can affect the server.
+Reading from them can provide information about the server.
 .P
 As well as this filesystem, there are a collection of files in the
 .B procfs
@@ -38,13 +32,10 @@ filesystem mounted at
 .B /proc/fs/nfsd
 or
 .BR /proc/fs/nfs .
-If it is not mounted, they will fall-back on 2.4 style functionality.
-This involves accessing the NFS server via a systemcall.  This
-systemcall is scheduled to be removed after the 2.6 kernel series.
 .SH DETAILS
-The three files in the
+Files in the
 .B nfsd
-filesystem are:
+filesystem include:
 .TP
 .B exports
 This file contains a list of filesystems that are currently exported
@@ -191,6 +182,16 @@ number represents a bit-pattern where bits that are set cause certain
 classes of tracing to be enabled.  Consult the kernel header files to
 find out what number correspond to what tracing.
 
+.SH NOTES
+This file system is only available in Linux 2.6 and later series
+kernels (and in the later parts of the 2.5 development series leading
+up to 2.6).  This man page does not apply to 2.4 and earlier.
+.P
+Previously the nfsctl systemcall was used for communication between nfsd
+and user utilities.  That systemcall was removed in kernel version 3.1.
+Older nfs-utils versions were able to fall back to nfsctl if necessary;
+that was removed from nfs-utils 1.3.5.
+
 .SH SEE ALSO
 .BR nfsd (8),
 .BR rpc.nfsd (8),
-- 
2.25.1

[PATCH 2/2] nfsd(7): minimal /proc/fs/nfsd/clients/ documentation

[J. Bruce Fields]

From: "J. Bruce Fields" <bfields@redhat.com>

We should really say more, but this is at least a starting point.

Signed-off-by: J. Bruce Fields <bfields@redhat.com>
---
 utils/exportfs/nfsd.man | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
index 1392f3926053..514153f024fa 100644
--- a/utils/exportfs/nfsd.man
+++ b/utils/exportfs/nfsd.man
@@ -81,6 +81,16 @@ for that path as exported to the given client.  The filehandle's length
 will be at most the number of bytes given.
 
 The filehandle will be represented in hex with a leading '\ex'.
+
+.TP
+.B clients/
+This directory contains a subdirectory for each NFSv4 client.  Each file
+under that subdirectory gives some details about the client in YAML
+format.  In addition, writing "expire\\n" to the
+.B ctl
+file will force the server to immediately revoke all state held by that
+client.
+
 .PP
 The directory
 .B /proc/net/rpc
-- 
2.25.1

Re: [PATCH 2/2] nfsd(7): minimal /proc/fs/nfsd/clients/ documentation

[Steve Dickson]

On 3/19/20 3:16 PM, J. Bruce Fields wrote:
> From: "J. Bruce Fields" <bfields@redhat.com>
> 
> We should really say more, but this is at least a starting point.
> 
> Signed-off-by: J. Bruce Fields <bfields@redhat.com>
Committed... (tag: nfs-utils-2-4-4-rc2)

steved.
> ---
>  utils/exportfs/nfsd.man | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
> index 1392f3926053..514153f024fa 100644
> --- a/utils/exportfs/nfsd.man
> +++ b/utils/exportfs/nfsd.man
> @@ -81,6 +81,16 @@ for that path as exported to the given client.  The filehandle's length
>  will be at most the number of bytes given.
>  
>  The filehandle will be represented in hex with a leading '\ex'.
> +
> +.TP
> +.B clients/
> +This directory contains a subdirectory for each NFSv4 client.  Each file
> +under that subdirectory gives some details about the client in YAML
> +format.  In addition, writing "expire\\n" to the
> +.B ctl
> +file will force the server to immediately revoke all state held by that
> +client.
> +
>  .PP
>  The directory
>  .B /proc/net/rpc
> 

Re: [PATCH 1/2] nfsd(7): minimal updates

[Steve Dickson]

On 3/19/20 3:15 PM, J. Bruce Fields wrote:
> From: "J. Bruce Fields" <bfields@redhat.com>
> 
> The nfsd(7) man page has some useful documentation of the files under
> /proc/fs/nfsd/ and proc/net/rpc, but it's many years out of date.
> 
> As a start, banish any discussion of the long-deprecated nfsctl
> systemcall to a NOTES section at the end, and admit that there are more
> than 3 files under /proc/fs/nfsd/.
> 
> Signed-off-by: J. Bruce Fields <bfields@redhat.com>
Committed... (tag: nfs-utils-2-4-4-rc2)

steved.
> ---
>  utils/exportfs/nfsd.man | 27 ++++++++++++++-------------
>  1 file changed, 14 insertions(+), 13 deletions(-)
> 
> diff --git a/utils/exportfs/nfsd.man b/utils/exportfs/nfsd.man
> index 9efa29f9f01c..1392f3926053 100644
> --- a/utils/exportfs/nfsd.man
> +++ b/utils/exportfs/nfsd.man
> @@ -13,14 +13,8 @@ nfsd \- special filesystem for controlling Linux NFS server
>  The
>  .B nfsd
>  filesystem is a special filesystem which provides access to the Linux
> -NFS server.  The filesystem consists of a single directory which
> -contains a number of files.  These files are actually gateways into
> -the NFS server.  Writing to them can affect the server.  Reading from
> -them can provide information about the server.
> -.P
> -This file system is only available in Linux 2.6 and later series
> -kernels (and in the later parts of the 2.5 development series leading
> -up to 2.6).  This man page does not apply to 2.4 and earlier.
> +NFS server.  Writing to files in this filesystem can affect the server.
> +Reading from them can provide information about the server.
>  .P
>  As well as this filesystem, there are a collection of files in the
>  .B procfs
> @@ -38,13 +32,10 @@ filesystem mounted at
>  .B /proc/fs/nfsd
>  or
>  .BR /proc/fs/nfs .
> -If it is not mounted, they will fall-back on 2.4 style functionality.
> -This involves accessing the NFS server via a systemcall.  This
> -systemcall is scheduled to be removed after the 2.6 kernel series.
>  .SH DETAILS
> -The three files in the
> +Files in the
>  .B nfsd
> -filesystem are:
> +filesystem include:
>  .TP
>  .B exports
>  This file contains a list of filesystems that are currently exported
> @@ -191,6 +182,16 @@ number represents a bit-pattern where bits that are set cause certain
>  classes of tracing to be enabled.  Consult the kernel header files to
>  find out what number correspond to what tracing.
>  
> +.SH NOTES
> +This file system is only available in Linux 2.6 and later series
> +kernels (and in the later parts of the 2.5 development series leading
> +up to 2.6).  This man page does not apply to 2.4 and earlier.
> +.P
> +Previously the nfsctl systemcall was used for communication between nfsd
> +and user utilities.  That systemcall was removed in kernel version 3.1.
> +Older nfs-utils versions were able to fall back to nfsctl if necessary;
> +that was removed from nfs-utils 1.3.5.
> +
>  .SH SEE ALSO
>  .BR nfsd (8),
>  .BR rpc.nfsd (8),
>