From nobody@FreeBSD.org  Sat Dec 31 19:10:18 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id DA80A106564A
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 31 Dec 2011 19:10:18 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id C577D8FC16
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 31 Dec 2011 19:10:18 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id pBVJAIYp094309
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 31 Dec 2011 19:10:18 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id pBVJAI70094308;
	Sat, 31 Dec 2011 19:10:18 GMT
	(envelope-from nobody)
Message-Id: <201112311910.pBVJAI70094308@red.freebsd.org>
Date: Sat, 31 Dec 2011 19:10:18 GMT
From: Garrett Cooper <yaneurabeya@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] document failok mount(8) option
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         163742
>Category:       docs
>Synopsis:       [patch] document failok mount(8) option
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    eadler
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Dec 31 19:20:11 UTC 2011
>Closed-Date:    Sun Sep 02 18:28:18 UTC 2012
>Last-Modified:  Sun Feb 03 22:29:56 UTC 2013
>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@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:

From: Benjamin Kaduk <kaduk@MIT.EDU>
To: Garrett Cooper <yaneurabeya@gmail.com>
Cc: freebsd-gnats-submit@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

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

   This message is in MIME format.  The first part should be readable text,
   while the remaining parts are likely unreadable without MIME-aware tools.
 
 ---559023410-854845245-1325489805=:882
 Content-Type: TEXT/PLAIN; charset=ISO-8859-1; format=flowed
 Content-Transfer-Encoding: QUOTED-PRINTABLE
 
 On Sun, 1 Jan 2012, Garrett Cooper wrote:
 
 > On Sun, Jan 1, 2012 at 10:27 PM, Benjamin Kaduk <kaduk@mit.edu> wrote:
 >> 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 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 } else if (strcmp(p=
 , "failok") =3D=3D 0) {
 >>> 731 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 /*
 >>> 732 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 * "failok" is used to prevent certain
 >>> file
 >>> 733 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 * systems from being causing the
 >>> system to
 >>> 734 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 * drop into single user mode in the
 >>> boot
 >>> 735 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 * cycle, and is not a real mount
 >>> option.
 >>> 736 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0=
 */
 >>> 737 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 con=
 tinue;
 >>>
 >>
 >>
 >> 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?
 >
 > I look at mount*(8) before I look at fstab(5) as fstab(5) is far from
 > complete. I'm sure I'm not the only one.
 >
 > That and I can actually use it via mount -o on the commandline makes
 > more sense for it to be in mount(8) than fstab(5).
 >
 >>> The attached patch documents the missing option.
 >
 > ...
 >
 >> 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. =A0This is in contrast to the normal behavior wher=
 e a
 >> mount error will cause the system to drop into single-user mode."
 >
 > I didn't really wordsmith the original text too much, as you noticed
 > above -- and quite frankly I wasn't happy with the text anyhow.
 >
 > The proposed sentences above get the meaning across, but in a bit
 > roundabout manner. What about this instead?
 >
 > 'In the event that mounting a filesystem via rc fails, standard
 > behavior is that the user is dropped into the 'administrative shell'
 > to diagnose the mount failure. The failok option allows mount failures
 > to pass.
 >
 > This option should be used on non-boot/-runtime critical filesystems.'
 
 No major objections.  The "non-boot/-runtime" is a bit awkward, so I might=
 =20
 prefer "should be used on file systems which are not critical for boot or=
 =20
 runtime usage."
 
 Thanks,
 
 Ben
 ---559023410-854845245-1325489805=:882--

From: Garrett Cooper <yaneurabeya@gmail.com>
To: Benjamin Kaduk <kaduk@mit.edu>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/163742: [patch] document failok mount(8) option
Date: Sun, 1 Jan 2012 23:22:23 -0800

 On Sun, Jan 1, 2012 at 10:27 PM, Benjamin Kaduk <kaduk@mit.edu> wrote:
 > 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 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 } else if (strcmp(p,=
  "failok") =3D=3D 0) {
 >> 731 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 /*
 >> 732 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0*=
  "failok" is used to prevent certain
 >> file
 >> 733 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0*=
  systems from being causing the
 >> system to
 >> 734 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0*=
  drop into single user mode in the
 >> boot
 >> 735 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0*=
  cycle, and is not a real mount
 >> option.
 >> 736 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0*=
 /
 >> 737 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 cont=
 inue;
 >>
 >
 >
 > r222832 also introduced (some) documentation of failok in fstab.5 -- do y=
 ou
 > feel that this is insufficient and it also needs to be documented in
 > mount.8?
 
 I look at mount*(8) before I look at fstab(5) as fstab(5) is far from
 complete. I'm sure I'm not the only one.
 
 That and I can actually use it via mount -o on the commandline makes
 more sense for it to be in mount(8) than fstab(5).
 
 >> The attached patch documents the missing option.
 
 ...
 
 > 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. =A0This is in contrast to the normal behavior where=
  a
 > mount error will cause the system to drop into single-user mode."
 
 I didn't really wordsmith the original text too much, as you noticed
 above -- and quite frankly I wasn't happy with the text anyhow.
 
 The proposed sentences above get the meaning across, but in a bit
 roundabout manner. What about this instead?
 
 'In the event that mounting a filesystem via rc fails, standard
 behavior is that the user is dropped into the 'administrative shell'
 to diagnose the mount failure. The failok option allows mount failures
 to pass.
 
 This option should be used on non-boot/-runtime critical filesystems.'
 
 Thanks!
 -Garrett

From: Garrett Cooper <yaneurabeya@gmail.com>
To: Benjamin Kaduk <kaduk@mit.edu>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/163742: [patch] document failok mount(8) option
Date: Sun, 1 Jan 2012 23:50:35 -0800

 On Sun, Jan 1, 2012 at 11:36 PM, Benjamin Kaduk <kaduk@mit.edu> wrote:
 > On Sun, 1 Jan 2012, Garrett Cooper wrote:
 >
 >> On Sun, Jan 1, 2012 at 10:27 PM, Benjamin Kaduk <kaduk@mit.edu> wrote:
 >>>
 >>> 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 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 } else if (strcmp(=
 p, "failok") =3D=3D 0) {
 >>>> 731 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 /*
 >>>> 732 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =
 =A0* "failok" is used to prevent
 >>>> certain
 >>>> file
 >>>> 733 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =
 =A0* systems from being causing the
 >>>> system to
 >>>> 734 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =
 =A0* drop into single user mode in the
 >>>> boot
 >>>> 735 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =
 =A0* cycle, and is not a real mount
 >>>> option.
 >>>> 736 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =
 =A0*/
 >>>> 737 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 co=
 ntinue;
 >>>>
 >>>
 >>>
 >>> 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?
 >>
 >>
 >> I look at mount*(8) before I look at fstab(5) as fstab(5) is far from
 >> complete. I'm sure I'm not the only one.
 >>
 >> That and I can actually use it via mount -o on the commandline makes
 >> more sense for it to be in mount(8) than fstab(5).
 >>
 >>>> The attached patch documents the missing option.
 >>
 >>
 >> ...
 >>
 >>> 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. =A0This is in contrast to the normal behavior whe=
 re a
 >>> mount error will cause the system to drop into single-user mode."
 >>
 >>
 >> I didn't really wordsmith the original text too much, as you noticed
 >> above -- and quite frankly I wasn't happy with the text anyhow.
 >>
 >> The proposed sentences above get the meaning across, but in a bit
 >> roundabout manner. What about this instead?
 >>
 >> 'In the event that mounting a filesystem via rc fails, standard
 >> behavior is that the user is dropped into the 'administrative shell'
 >> to diagnose the mount failure. The failok option allows mount failures
 >> to pass.
 >>
 >> This option should be used on non-boot/-runtime critical filesystems.'
 >
 >
 > No major objections. =A0The "non-boot/-runtime" is a bit awkward, so I mi=
 ght
 > prefer "should be used on file systems which are not critical for boot or
 > runtime usage."
 
 Ok. I'll whip up a new patch and submit it via reply-to with alpine.
 -Garrett
Responsible-Changed-From-To: freebsd-doc->eadler 
Responsible-Changed-By: eadler 
Responsible-Changed-When: Sun May 13 22:22:24 UTC 2012 
Responsible-Changed-Why:  
I'll take it. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=163742 
State-Changed-From-To: open->analyzed 
State-Changed-By: eadler 
State-Changed-When: Mon Jul 9 00:03:13 UTC 2012 
State-Changed-Why:  
awaiting approval 

http://www.freebsd.org/cgi/query-pr.cgi?pr=163742 
State-Changed-From-To: analyzed->patched 
State-Changed-By: eadler 
State-Changed-When: Thu Jul 12 15:24:02 UTC 2012 
State-Changed-Why:  
committed in r238399 

http://www.freebsd.org/cgi/query-pr.cgi?pr=163742 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163742: commit references a PR
Date: Thu, 12 Jul 2012 15:20:29 +0000 (UTC)

 Author: eadler
 Date: Thu Jul 12 15:20:20 2012
 New Revision: 238399
 URL: http://svn.freebsd.org/changeset/base/238399
 
 Log:
   Document the behavior of mount with failok specified.
   
   PR:		docs/163742
   Submitted by:	gcooper
   Discussion by:	gcooper
   Discussion by:	bjk
   Approved by:	gabor
   MFC after:	3 days
 
 Modified:
   head/sbin/mount/mount.8
 
 Modified: head/sbin/mount/mount.8
 ==============================================================================
 --- head/sbin/mount/mount.8	Thu Jul 12 13:54:24 2012	(r238398)
 +++ head/sbin/mount/mount.8	Thu Jul 12 15:20:20 2012	(r238399)
 @@ -28,7 +28,7 @@
  .\"     @(#)mount.8	8.8 (Berkeley) 6/16/94
  .\" $FreeBSD$
  .\"
 -.Dd June 6, 2011
 +.Dd July 12, 2012
  .Dt MOUNT 8
  .Os
  .Sh NAME
 @@ -145,6 +145,11 @@ When used with the
  .Fl u
  flag, this is the same as specifying the options currently in effect for
  the mounted file system.
 +.It Cm failok
 +If this option is specified,
 +.Nm
 +will return 0 even if an error occurs
 +during the mount of the filesystem.
  .It Cm force
  The same as
  .Fl f ;
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163742: commit references a PR
Date: Sun,  2 Sep 2012 18:09:02 +0000 (UTC)

 Author: eadler
 Date: Sun Sep  2 18:08:41 2012
 New Revision: 240033
 URL: http://svn.freebsd.org/changeset/base/240033
 
 Log:
   MFC r238399:
   	Document the behavior of mount with failok specified.
   
   PR:		docs/163742
   Approved by:	cperciva (implicit)
 
 Modified:
   stable/9/sbin/mount/mount.8
 Directory Properties:
   stable/9/sbin/mount/   (props changed)
 
 Modified: stable/9/sbin/mount/mount.8
 ==============================================================================
 --- stable/9/sbin/mount/mount.8	Sun Sep  2 18:04:50 2012	(r240032)
 +++ stable/9/sbin/mount/mount.8	Sun Sep  2 18:08:41 2012	(r240033)
 @@ -28,7 +28,7 @@
  .\"     @(#)mount.8	8.8 (Berkeley) 6/16/94
  .\" $FreeBSD$
  .\"
 -.Dd June 6, 2011
 +.Dd July 12, 2012
  .Dt MOUNT 8
  .Os
  .Sh NAME
 @@ -145,6 +145,11 @@ When used with the
  .Fl u
  flag, this is the same as specifying the options currently in effect for
  the mounted file system.
 +.It Cm failok
 +If this option is specified,
 +.Nm
 +will return 0 even if an error occurs
 +during the mount of the filesystem.
  .It Cm force
  The same as
  .Fl f ;
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163742: commit references a PR
Date: Sun,  2 Sep 2012 18:09:10 +0000 (UTC)

 Author: eadler
 Date: Sun Sep  2 18:08:46 2012
 New Revision: 240034
 URL: http://svn.freebsd.org/changeset/base/240034
 
 Log:
   MFC r238399:
   	Document the behavior of mount with failok specified.
   
   PR:		docs/163742
   Approved by:	cperciva (implicit)
 
 Modified:
   stable/8/sbin/mount/mount.8
 Directory Properties:
   stable/8/sbin/mount/   (props changed)
 
 Modified: stable/8/sbin/mount/mount.8
 ==============================================================================
 --- stable/8/sbin/mount/mount.8	Sun Sep  2 18:08:41 2012	(r240033)
 +++ stable/8/sbin/mount/mount.8	Sun Sep  2 18:08:46 2012	(r240034)
 @@ -28,7 +28,7 @@
  .\"     @(#)mount.8	8.8 (Berkeley) 6/16/94
  .\" $FreeBSD$
  .\"
 -.Dd June 6, 2011
 +.Dd July 12, 2012
  .Dt MOUNT 8
  .Os
  .Sh NAME
 @@ -145,6 +145,11 @@ When used with the
  .Fl u
  flag, this is the same as specifying the options currently in effect for
  the mounted file system.
 +.It Cm failok
 +If this option is specified,
 +.Nm
 +will return 0 even if an error occurs
 +during the mount of the filesystem.
  .It Cm force
  The same as
  .Fl f ;
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: eadler 
State-Changed-When: Sun Sep 2 18:28:16 UTC 2012 
State-Changed-Why:  
Committed. Thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=163742 
>Unformatted:
