svn commit: r221028 - stable/8/usr.sbin/nfsd

[Rick Macklem]

Author: rmacklem
Date: Mon Apr 25 21:14:13 2011
New Revision: 221028
URL: http://svn.freebsd.org/changeset/base/221028

Log:
  MFC: r210933,r211397,r220518
  Modify the man pages to reflect the addition of a backup
  stable restart file, as done by r220510. I also merged the
  typo fixes done in head as r210933, r211397 with joel@'s
  permission.
  This is a content change.

Modified:
  stable/8/usr.sbin/nfsd/nfsv4.4
  stable/8/usr.sbin/nfsd/stablerestart.5
Directory Properties:
  stable/8/usr.sbin/nfsd/   (props changed)

Modified: stable/8/usr.sbin/nfsd/nfsv4.4
==============================================================================
--- stable/8/usr.sbin/nfsd/nfsv4.4	Mon Apr 25 20:54:12 2011	(r221027)
+++ stable/8/usr.sbin/nfsd/nfsv4.4	Mon Apr 25 21:14:13 2011	(r221028)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 30, 2009
+.Dd April 10, 2011
 .Dt NFSV4 4
 .Os
 .Sh NAME
@@ -56,12 +56,13 @@ open/lock state changing operations.
 To provide for correct recovery semantics, a small file described by
 .Xr stablerestart 5
 is used by the server during the recovery phase.
-If this file is missing,
-the server will not start.
-If this file is lost, it should be recovered from backups, since creating
-an empty
-.Xr stablerestart 5
-file will result in the server starting without providing a Grace Period
+If this file is missing or empty, there is a backup copy maintained by
+.Xr nfsd 8
+that will be used. If either file is missing, they will be
+created by the
+.Xr nfsd 8 .
+If both the file and the backup copy are empty,
+it will result in the server starting without providing a grace period
 for recovery.
 Note that recovery only occurs when the server
 machine is rebooted, not when the
@@ -187,25 +188,9 @@ are set in
 .Pp
 You will also need to add at least one ``V4:'' line to the
 .Xr exports 5
-file and, before starting the server for the first time, create an empty
-.sp
-.Bd -literal -offset indent -compact
-/var/db/nfs-stablerestart
-.Ed
-.sp
-file.
-The command
-.sp
-.Bd -literal -offset indent -compact
-install -o root -g wheel -m 600 /dev/null /var/db/nfs-stablerestart
-.Ed
-.sp
-executed as ``su'' should suffice.
-This can only be done when the server is not running and there are no
+file for
 .Nm
-file system mounts against the server.
-If this file is lost during a crash, recovery from backups is
-recommended.
+to work.
 .Pp
 If the file systems you are exporting are only being accessed via
 .Nm
@@ -313,9 +298,11 @@ daemons at boot time via the ``nfsuserd_
 .Xr rc.conf 5
 variables.
 .Sh FILES
-.Bl -tag -width /var/db/nfs-stablerestart -compact
+.Bl -tag -width /var/db/nfs-stablerestart.bak -compact
 .It Pa /var/db/nfs-stablerestart
 NFS V4 stable restart file
+.It Pa /var/db/nfs-stablerestart.bak
+backup copy of the file
 .El
 .Sh SEE ALSO
 .Xr stablerestart 5
@@ -329,5 +316,5 @@ NFS V4 stable restart file
 At this time, there is no recall of delegations for local file system
 operations.
 As such, delegations should only be enabled for file systems
-that are being used soley as NFS export volumes and are not being accessed
+that are being used solely as NFS export volumes and are not being accessed
 via local system calls nor services such as Samba.

Modified: stable/8/usr.sbin/nfsd/stablerestart.5
==============================================================================
--- stable/8/usr.sbin/nfsd/stablerestart.5	Mon Apr 25 20:54:12 2011	(r221027)
+++ stable/8/usr.sbin/nfsd/stablerestart.5	Mon Apr 25 21:14:13 2011	(r221028)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd Sept 7, 2007
+.Dd April 10, 2011
 .Dt STABLERESTART 5
 .Os
 .Sh NAME
@@ -58,7 +58,7 @@ end of the Grace Period.
 The rest of the file are appended records, as defined by
 struct nfst_rec in /usr/include/fs/nfs/nfsrvstate.h and are used
 represent one of two things. There are records which indicate that a
-client successfully aquired state and records that indicate a client's state was revoked.
+client successfully acquired state and records that indicate a client's state was revoked.
 State revoke records indicate that state information
 for a client was discarded, due to lease expiry and an otherwise
 conflicting open or lock request being made by a different client.
@@ -75,9 +75,11 @@ is written to stable storage by the time
 has returned. This might require hardware level caching to be disabled for
 a local disk drive that holds the file, or similar.
 .Sh FILES
-.Bl -tag -width /var/db/nfs-stablerestart -compact
+.Bl -tag -width /var/db/nfs-stablerestart.bak -compact
 .It Pa /var/db/nfs-stablerestart
 NFS V4 stable restart file
+.It Pa /var/db/nfs-stablerestart.bak
+backup copy of the file
 .El
 .Sh SEE ALSO
 .Xr nfsv4 4
@@ -86,8 +88,10 @@ NFS V4 stable restart file
 If the file is empty, the NFS V4 server has no choice but to return
 NFSERR_NOGRACE for all Reclaim requests. Although correct, this is
 a highly undesirable occurrence, so the file should not be lost if
-at all possible. Nfsd will not create the file if it does not
-exist and will simply log a failure to start, in the hopes that the
-file can be recovered from a backup. To move the file, you must edit
+at all possible. The backup copy of the file is maintained
+and used by the
+.Xr nfsd 8
+to minimize the risk of this occurring.
+To move the file, you must edit
 the nfsd sources and recompile it. This was done to discourage
 accidental relocation of the file.