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

[Garrett Cooper]

>Number:         163742
>Category:       docs
>Synopsis:       [patch] document failok mount(8) option
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Dec 31 19:20:11 UTC 2011
>Closed-Date:
>Last-Modified:
>Originator:     Garrett Cooper
>Release:        9.0-RC2
>Organization:
n/a
>Environment:
FreeBSD bayonetta.local 9.0-RC2 FreeBSD 9.0-RC2 #0: Sun Nov 13 21:17:31 PST 2011     gcooper at bayonetta.local:/usr/obj/store/freebsd/stable/9/sys/BAYONETTA  amd64
>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;

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 Cm force
 The same as
 .Fl f ;


>Release-Note:
>Audit-Trail:
>Unformatted: