docs/163742: [patch] document failok mount(8) option

[Benjamin Kaduk]

The following reply was made to PR docs/163742; it has been noted by GNATS.

From: Benjamin Kaduk <kaduk at MIT.EDU>
To: Garrett Cooper <yanegomi at gmail.com>
Cc: freebsd-gnats-submit at freebsd.org
Subject: Re: docs/163742: [patch] document failok mount(8) option
Date: Mon, 2 Jan 2012 01:27:59 -0500 (EST)

 On Sat, 31 Dec 2011, Garrett Cooper wrote:
 
 >> Description:
 > The failok option isn't documented in mount(8). As noted in the sbin/mount/mount.c:
 >
 > 730                         } else if (strcmp(p, "failok") == 0) {
 > 731                                 /*
 > 732                                  * "failok" is used to prevent certain file
 > 733                                  * systems from being causing the system to
 > 734                                  * drop into single user mode in the boot
 > 735                                  * cycle, and is not a real mount option.
 > 736                                  */
 > 737                                 continue;
 >
 
 
 r222832 also introduced (some) documentation of failok in fstab.5 -- do 
 you feel that this is insufficient and it also needs to be documented in 
 mount.8?
 
 
 > The attached patch documents the missing option.
 >> How-To-Repeat:
 >
 >> Fix:
 >
 >
 > Patch attached with submission follows:
 >
 > Index: sbin/mount/mount.8
 > ===================================================================
 > --- sbin/mount/mount.8	(revision 228846)
 > +++ sbin/mount/mount.8	(working copy)
 > @@ -145,6 +145,13 @@
 > .Fl u
 > flag, this is the same as specifying the options currently in effect for
 > the mounted file system.
 > +.It Cm failok
 > +This option is used to prevent certain file systems from dropping into
 > +single-user mode when booting up; it is used internally in
 > +.Xr mount 8
 > +and thus is not a true
 > +.Xr mount 2
 > +flag.
 
 It seems hard to phrase this in an unconfusing manner.
 I would probably say "this option is used to indicate that if an error 
 occurs during the mounting of a file system, the boot process should 
 continue on normally.  This is in contrast to the normal behavior where a 
 mount error will cause the system to drop into single-user mode."
 
 -Ben