From simon@arthur.nitro.dk  Sat Mar 15 07:36:11 2003
Return-Path: <simon@arthur.nitro.dk>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 377DA37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 15 Mar 2003 07:36:11 -0800 (PST)
Received: from arthur.nitro.dk (port324.ds1-khk.adsl.cybercity.dk [212.242.113.79])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 9B83E43FDD
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 15 Mar 2003 07:36:10 -0800 (PST)
	(envelope-from simon@arthur.nitro.dk)
Received: by arthur.nitro.dk (Postfix, from userid 1000)
	id DBDF210BF82; Sat, 15 Mar 2003 16:36:08 +0100 (CET)
Message-Id: <20030315153608.DBDF210BF82@arthur.nitro.dk>
Date: Sat, 15 Mar 2003 16:36:08 +0100 (CET)
From: Simon L.Nielsen <simon@nitro.dk>
Reply-To: Simon L.Nielsen <simon@nitro.dk>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] rc.conf(5) does not document mountd_flags
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         50023
>Category:       docs
>Synopsis:       [patch] rc.conf(5) does not document mountd_flags
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Mar 15 07:40:11 PST 2003
>Closed-Date:    Sat May 03 15:16:55 PDT 2003
>Last-Modified:  Sat May 03 15:16:55 PDT 2003
>Originator:     Simon L. Nielsen
>Release:        FreeBSD 4.8-RC i386
>Organization:
>Environment:
>Description:
The option mountd_flags is not documented in rc.conf(5).
>How-To-Repeat:
>Fix:
--- mountd-rcconf-man.patch begins here ---
Index: rc.conf.5
===================================================================
RCS file: /data/mirror/freebsd/ncvs/src/share/man/man5/rc.conf.5,v
retrieving revision 1.177
diff -u -d -r1.177 rc.conf.5
--- rc.conf.5	28 Feb 2003 22:07:19 -0000	1.177
+++ rc.conf.5	15 Mar 2003 15:27:22 -0000
@@ -1059,6 +1059,13 @@
 .Xr nfsd 8
 daemon.
 It is commonly needed to run CFS without real NFS used.
+.It Va mountd_flags
+.Pq Vt str
+If
+.Va mountd_enable
+is set to
+.Dq Li YES ,
+these are the flags to pass to it.
 .It Va weak_mountd_authentication
 .Pq Vt bool
 If set to
--- mountd-rcconf-man.patch ends here ---


>Release-Note:
>Audit-Trail:

From: Tom Rhodes <trhodes@FreeBSD.org>
To: "Simon L.Nielsen" <simon@nitro.dk>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/50023: [patch] rc.conf(5) does not document mountd_flags
Date: Sat, 15 Mar 2003 10:57:29 -0500

 On Sat, 15 Mar 2003 16:36:08 +0100 (CET)
 "Simon L.Nielsen" <simon@nitro.dk> wrote:
 
 > Index: rc.conf.5
 > ===================================================================
 > RCS file: /data/mirror/freebsd/ncvs/src/share/man/man5/rc.conf.5,v
 > retrieving revision 1.177
 > diff -u -d -r1.177 rc.conf.5
 > --- rc.conf.5	28 Feb 2003 22:07:19 -0000	1.177
 > +++ rc.conf.5	15 Mar 2003 15:27:22 -0000
 > @@ -1059,6 +1059,13 @@
 >  .Xr nfsd 8
 >  daemon.
 >  It is commonly needed to run CFS without real NFS used.
 > +.It Va mountd_flags
 > +.Pq Vt str
 > +If
 > +.Va mountd_enable
 > +is set to
 > +.Dq Li YES ,
 > +these are the flags to pass to it.
 >  .It Va weak_mountd_authentication
 >  .Pq Vt bool
 >  If set to
 
 These are the flags which will be passed to it, what flags are
 availible?  What exactly does this do for the user?  These are the
 questions that a new user would ask.  Is there any way we can
 explain this better?
 
 Thanks!
 
 --
 Tom Rhodes

From: "Simon L. Nielsen" <simon@nitro.dk>
To: Tom Rhodes <trhodes@FreeBSD.org>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/50023: [patch] rc.conf(5) does not document mountd_flags
Date: Sat, 15 Mar 2003 23:56:30 +0100

 --T4sUOijqQbZv57TR
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 Content-Transfer-Encoding: quoted-printable
 
 On 2003.03.15 10:57:29 -0500, Tom Rhodes wrote:
 
 > On Sat, 15 Mar 2003 16:36:08 +0100 (CET)
 > "Simon L.Nielsen" <simon@nitro.dk> wrote:
 >=20
 > > Index: rc.conf.5
 > > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
 > > RCS file: /data/mirror/freebsd/ncvs/src/share/man/man5/rc.conf.5,v
 > > retrieving revision 1.177
 > > diff -u -d -r1.177 rc.conf.5
 > > --- rc.conf.5	28 Feb 2003 22:07:19 -0000	1.177
 > > +++ rc.conf.5	15 Mar 2003 15:27:22 -0000
 > > @@ -1059,6 +1059,13 @@
 > >  .Xr nfsd 8
 > >  daemon.
 > >  It is commonly needed to run CFS without real NFS used.
 > > +.It Va mountd_flags
 > > +.Pq Vt str
 > > +If
 > > +.Va mountd_enable
 > > +is set to
 > > +.Dq Li YES ,
 > > +these are the flags to pass to it.
 > >  .It Va weak_mountd_authentication
 > >  .Pq Vt bool
 > >  If set to
 > These are the flags which will be passed to it, what flags are
 > availible?  What exactly does this do for the user?  These are the
 > questions that a new user would ask.  Is there any way we can
 > explain this better?
 I must admit I just did a copy/paste from one of the other _flags options
 =66rom the manpage (rwhod_flags i think).
 
 I don't really think that explaing anyting about which flags can be set
 to mountd would really help since it would just duplicate parts of
 mountd(8) and no options are really important to be specially
 emphasized.
 
 Thinking a bit more about it the "it" in the mountd_flags description
 should be replaced with "mountd(8)" to make it more clear where to find
 more information. I can quickly make a new patch with this included if
 you prefer that.
 
 Looking some more at the manpage it appears there the different _flags
 options which should basicaly do the same have rather different wording
 and level of detail. The way syslod_flags is described seems to bee most
 common.
 
      syslogd_flags
                  (str) If syslogd_enable is set to ``YES'', these are the
                  flags to pass to syslogd(8).
      rwhod_flags
                  (str) If rwhod_enable is set to ``YES'', these are the fla=
 gs
                  to pass to it.
      amd_flags   (str) If amd_enable is set to ``YES'', these are the flags=
  to
                  pass to it.  See the amd(8) manpage for more information.
      allscreens_flags
                  (str) If set, vidcontrol(1) is run with these options for
                  each of the virtual terminals (/dev/ttyv*).  For example,
                  ``-m on'' will enable the mouse pointer on all virtual ter=
 mi-
                  nals if moused_enable is set to ``YES''.
      ipmon_flags
                  (str) Set to ``-Ds'' by default.  This variable contains
                  flags passed to the ipmon(8) program.  Another typical exa=
 m-
                  ple would be ``-D /var/log/ipflog'' to have ipmon(8) log
                  directly to a file bypassing syslogd(8).  Make sure to adj=
 ust
                  /etc/newsyslog.conf in such case like this:
 
                  /var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
 
 As I looked through the rc.conf(5) i also noticed that some variabels
 document their default value where others don't and it does not seems
 to be done consistently.
 
 I think it would be a good idea to add the default value to all the
 variabels for rc.conf. I would be happy to do it if a consistent form
 (perhaps like all variabels document a type) can be found and other
 people think it would be a good idea.
 
 Doing a quick greping/diffing of defaults/rc.conf and rc.conf(5) several
 other variabels are not documented. I guess it would be preferable to
 have them documented also...?
 
 I just noticed the missing mountd_flags by chance since I was adding an
 option to mountd (to force binding to a specific port)...
 
 --=20
 Simon L. Nielsen
 
 --T4sUOijqQbZv57TR
 Content-Type: application/pgp-signature
 Content-Disposition: inline
 
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.2.1 (FreeBSD)
 
 iD8DBQE+c6+c8kocFXgPTRwRAqEFAKDNWH73KoeQvVeaz8GgecwjAWncYwCglBAX
 pwuA9jKigkpdiLySRZzeixs=
 =14XH
 -----END PGP SIGNATURE-----
 
 --T4sUOijqQbZv57TR--

From: Tom Rhodes <trhodes@FreeBSD.org>
To: "Simon L. Nielsen" <simon@nitro.dk>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/50023: [patch] rc.conf(5) does not document mountd_flags
Date: Sun, 16 Mar 2003 15:40:21 -0500

 On Sat, 15 Mar 2003 23:56:30 +0100
 "Simon L. Nielsen" <simon@nitro.dk> wrote:
 
 > On 2003.03.15 10:57:29 -0500, Tom Rhodes wrote:
 > 
 > > On Sat, 15 Mar 2003 16:36:08 +0100 (CET)
 > > "Simon L.Nielsen" <simon@nitro.dk> wrote:
 > > 
 > > > Index: rc.conf.5
 > > > =================================================================
 > > > == RCS file:
 > > > /data/mirror/freebsd/ncvs/src/share/man/man5/rc.conf.5,v
 > > > retrieving revision 1.177 diff -u -d -r1.177 rc.conf.5
 > > > --- rc.conf.5	28 Feb 2003 22:07:19 -0000	1.177
 > > > +++ rc.conf.5	15 Mar 2003 15:27:22 -0000
 > > > @@ -1059,6 +1059,13 @@
 > > >  .Xr nfsd 8
 > > >  daemon.
 > > >  It is commonly needed to run CFS without real NFS used.
 > > > +.It Va mountd_flags
 > > > +.Pq Vt str
 > > > +If
 > > > +.Va mountd_enable
 > > > +is set to
 > > > +.Dq Li YES ,
 > > > +these are the flags to pass to it.
 > > >  .It Va weak_mountd_authentication
 > > >  .Pq Vt bool
 > > >  If set to
 > > These are the flags which will be passed to it, what flags are
 > > availible?  What exactly does this do for the user?  These are the
 > > questions that a new user would ask.  Is there any way we can
 > > explain this better?
 > I must admit I just did a copy/paste from one of the other _flags
 > options from the manpage (rwhod_flags i think).
 > 
 > I don't really think that explaing anyting about which flags can be
 > set to mountd would really help since it would just duplicate parts of
 > mountd(8) and no options are really important to be specially
 > emphasized.
 
 Your correct, we should at least add:
 
 See
 .Xr mountd 8
 for more information.
 
 Or something similar to this.
 
 > 
 > Thinking a bit more about it the "it" in the mountd_flags description
 > should be replaced with "mountd(8)" to make it more clear where to
 > find more information. I can quickly make a new patch with this
 > included if you prefer that.
 > 
 > Looking some more at the manpage it appears there the different _flags
 > options which should basicaly do the same have rather different
 > wording and level of detail. The way syslod_flags is described seems
 > to bee most common.
 > 
 >      syslogd_flags
 >                  (str) If syslogd_enable is set to ``YES'', these are
 >                  the flags to pass to syslogd(8).
 >      rwhod_flags
 >                  (str) If rwhod_enable is set to ``YES'', these are
 >                  the flags to pass to it.
 >      amd_flags   (str) If amd_enable is set to ``YES'', these are the
 >      flags to
 >                  pass to it.  See the amd(8) manpage for more
 >                  information.
 >      allscreens_flags
 >                  (str) If set, vidcontrol(1) is run with these options
 >                  for each of the virtual terminals (/dev/ttyv*).  For
 >                  example,``-m on'' will enable the mouse pointer on
 >                  all virtual termi- nals if moused_enable is set to
 >                  ``YES''.
 >      ipmon_flags
 >                  (str) Set to ``-Ds'' by default.  This variable
 >                  contains flags passed to the ipmon(8) program. 
 >                  Another typical exam- ple would be ``-D
 >                  /var/log/ipflog'' to have ipmon(8) log directly to a
 >                  file bypassing syslogd(8).  Make sure to
 >                  adjust/etc/newsyslog.conf in such case like this:
 > 
 >                  /var/log/ipflog  640  10  100  *  Z 
 >                  /var/run/ipmon.pid
 > 
 > As I looked through the rc.conf(5) i also noticed that some variabels
 > document their default value where others don't and it does not seems
 > to be done consistently.
 > 
 > I think it would be a good idea to add the default value to all the
 > variabels for rc.conf. I would be happy to do it if a consistent form
 > (perhaps like all variabels document a type) can be found and other
 > people think it would be a good idea.
 > 
 > Doing a quick greping/diffing of defaults/rc.conf and rc.conf(5)
 > several other variabels are not documented. I guess it would be
 > preferable to have them documented also...?
 > 
 > I just noticed the missing mountd_flags by chance since I was adding
 > an option to mountd (to force binding to a specific port)...
 > 
 
 The unfortunate part about this is that my `tasklist' has grown enough
 (counting PRs) to keep me busy for weeks.  If you want to create a
 patch for me, I'd be happy to look it over!
 
 Thanks for all the help!
 
 --
 Tom Rhodes

From: "Simon L. Nielsen" <simon@nitro.dk>
To: Tom Rhodes <trhodes@FreeBSD.org>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/50023: [patch] rc.conf(5) does not document mountd_flags
Date: Tue, 18 Mar 2003 11:57:31 +0100

 --8GpibOaaTibBMecb
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 Content-Transfer-Encoding: quoted-printable
 
 
 On 2003.03.16 15:40:21 -0500, Tom Rhodes wrote:
 > On Sat, 15 Mar 2003 23:56:30 +0100
 > "Simon L. Nielsen" <simon@nitro.dk> wrote:
 > >=20
 > > I don't really think that explaing anyting about which flags can be
 > > set to mountd would really help since it would just duplicate parts of
 > > mountd(8) and no options are really important to be specially
 > > emphasized.
 >=20
 > Your correct, we should at least add:
 >=20
 > See
 > .Xr mountd 8
 > for more information.
 >=20
 > Or something similar to this.
 Yes. I will add that to the new patch (see below).
 
 > The unfortunate part about this is that my `tasklist' has grown enough
 > (counting PRs) to keep me busy for weeks.  If you want to create a
 > patch for me, I'd be happy to look it over!
 I will have a look at it sometime this week and send a patch.
 
 --=20
 Simon L. Nielsen
 
 --8GpibOaaTibBMecb
 Content-Type: application/pgp-signature
 Content-Disposition: inline
 
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.2.1 (FreeBSD)
 
 iD8DBQE+dvua8kocFXgPTRwRApKAAKDTECgdliWfpBRMKWXSUpZj6s0+jQCgyQaV
 HJ7gC0FL6NLTaeZi3BtP4Pk=
 =8PBC
 -----END PGP SIGNATURE-----
 
 --8GpibOaaTibBMecb--
State-Changed-From-To: open->patched 
State-Changed-By: keramida 
State-Changed-When: Tue Mar 25 17:39:41 PST 2003 
State-Changed-Why:  
Committed to current. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Mar 25 17:39:41 PST 2003 
Responsible-Changed-Why:  
I'll handle the MFC. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=50023 
State-Changed-From-To: patched->closed 
State-Changed-By: keramida 
State-Changed-When: Sat May 3 15:16:39 PDT 2003 
State-Changed-Why:  
Merged to RELENG_4. 

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