From nobody@nwww.freebsd.org  Tue May  7 10:44:58 2002
Return-Path: <nobody@nwww.freebsd.org>
Received: from nwww.freebsd.org (nwww.FreeBSD.org [216.136.204.117])
	by hub.freebsd.org (Postfix) with ESMTP id 83E8F37B427
	for <freebsd-gnats-submit@FreeBSD.org>; Tue,  7 May 2002 10:44:50 -0700 (PDT)
Received: from nwww.freebsd.org (localhost [127.0.0.1])
	by nwww.freebsd.org (8.12.2/8.12.2) with ESMTP id g47HkKhG045588
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 7 May 2002 10:46:20 -0700 (PDT)
	(envelope-from nobody@nwww.freebsd.org)
Received: (from nobody@localhost)
	by nwww.freebsd.org (8.12.2/8.12.2/Submit) id g47HkKNp045587;
	Tue, 7 May 2002 10:46:20 -0700 (PDT)
Message-Id: <200205071746.g47HkKNp045587@nwww.freebsd.org>
Date: Tue, 7 May 2002 10:46:20 -0700 (PDT)
From: "Michael R. Wayne" <wayne@staff.msen.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: Improve man page for quotactl(2)
X-Send-Pr-Version: www-1.0

>Number:         37839
>Category:       docs
>Synopsis:       Improve man page for quotactl(2)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue May 07 10:50:03 PDT 2002
>Closed-Date:    Mon May 20 02:18:17 PDT 2002
>Last-Modified:  Mon May 20 02:18:17 PDT 2002
>Originator:     Michael R. Wayne
>Release:        4.5-RELEASE-p4
>Organization:
Msen, Inc.
>Environment:
4.5-RELEASE-p4 FreeBSD 4.5-RELEASE-p4 #6: Mon Apr 22 18:03:58 EDT 2002 
>Description:
The documentation for quotactl is not specific enough to avoid confusion.
This became clear when quotas inadvertently became disabled on a filesystem
and quotactl failed with EINVAL.  Several people on -hackers had speculations,
none were accurate.
The current man page states
   Cmd or the command type is invalid
But this does not accurately reflect the code.
>How-To-Repeat:
See above.
>Fix:
Apply the following 1 line patch:

*** /usr/src/lib/libc/sysquotactl.2.ORIG     Tue May  7 13:41:19 2002
--- /usr/src/lib/libc/sysquotactl.2  Tue May  7 13:41:39 2002
***************
*** 166,171 ****
--- 166,172 ----
  .It Bq Er EINVAL
  .Fa Cmd
  or the command type is invalid.
+ Q_GETQUOTA returns EINVAL if quotas are not currently enabled for this filesystem.
  .It Bq Er EACCES
  In
  .Dv Q_QUOTAON ,
>Release-Note:
>Audit-Trail:

From: Peter Pentchev <roam@ringlet.net>
To: "Michael R. Wayne" <wayne@staff.msen.com>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/37839: Improve man page for quotactl(2)
Date: Wed, 8 May 2002 13:21:04 +0300

 On Tue, May 07, 2002 at 10:46:20AM -0700, Michael R. Wayne wrote:
 > 
 > >Number:         37839
 > >Category:       docs
 > >Synopsis:       Improve man page for quotactl(2)
 > >Originator:     Michael R. Wayne
 > >Description:
 > The documentation for quotactl is not specific enough to avoid confusion.
 > This became clear when quotas inadvertently became disabled on a filesystem
 > and quotactl failed with EINVAL.  Several people on -hackers had speculations,
 > none were accurate.
 > The current man page states
 >    Cmd or the command type is invalid
 > But this does not accurately reflect the code.
 > >How-To-Repeat:
 > See above.
 > >Fix:
 > Apply the following 1 line patch:
 > 
 > *** /usr/src/lib/libc/sysquotactl.2.ORIG     Tue May  7 13:41:19 2002
 > --- /usr/src/lib/libc/sysquotactl.2  Tue May  7 13:41:39 2002
 > ***************
 > *** 166,171 ****
 > --- 166,172 ----
 >   .It Bq Er EINVAL
 >   .Fa Cmd
 >   or the command type is invalid.
 > + Q_GETQUOTA returns EINVAL if quotas are not currently enabled for this filesystem.
 >   .It Bq Er EACCES
 >   In
 >   .Dv Q_QUOTAON ,
 
 How about the attached little improvement to the mark-up?
 Other than that, your wording sounds right to me.
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 The rest of this sentence is written in Thailand, on
 
 Index: src/lib/libc/sys/quotactl.2
 ===================================================================
 RCS file: /home/ncvs/src/lib/libc/sys/quotactl.2,v
 retrieving revision 1.17
 diff -u -r1.17 quotactl.2
 --- src/lib/libc/sys/quotactl.2	1 Oct 2001 16:09:02 -0000	1.17
 +++ src/lib/libc/sys/quotactl.2	8 May 2002 10:17:23 -0000
 @@ -166,6 +166,10 @@
  .It Bq Er EINVAL
  .Fa Cmd
  or the command type is invalid.
 +.Dv Q_GETQUOTA
 +returns
 +.Er EINVAL
 +if quotas are not currently enabled for this filesystem.
  .It Bq Er EACCES
  In
  .Dv Q_QUOTAON ,

From: "Michael R. Wayne" <wayne@staff.msen.com>
To: Peter Pentchev <roam@ringlet.net>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/37839: Improve man page for quotactl(2)
Date: Wed, 8 May 2002 13:39:59 -0400

 On Wed, May 08, 2002 at 01:21:04PM +0300, Peter Pentchev wrote:
 > How about the attached little improvement to the mark-up?
 > Other than that, your wording sounds right to me.
 
 Sounds good, I was not thinking about the formatting.  Any hope to
 get this into 4.6?
 
 /\/\ \/\/

From: Peter Pentchev <roam@ringlet.net>
To: "Michael R. Wayne" <wayne@staff.msen.com>
Cc: Ruslan Ermilov <ru@FreeBSD.ORG>, bug-followup@FreeBSD.org
Subject: Re: docs/37839: Improve man page for quotactl(2)
Date: Wed, 8 May 2002 19:58:58 +0300

 On Wed, May 08, 2002 at 01:39:59PM -0400, Michael R. Wayne wrote:
 > On Wed, May 08, 2002 at 01:21:04PM +0300, Peter Pentchev wrote:
 > > How about the attached little improvement to the mark-up?
 > > Other than that, your wording sounds right to me.
 > 
 > Sounds good, I was not thinking about the formatting.  Any hope to
 > get this into 4.6?
 
 I'm not exactly sure about the policy concerning manual pages
 during a release code slush.  ISTR Ruslan (CC'd) committing lots
 of stuff under a blanket approval from the release engineers.
 Ruslan, if that is right, could you take a look at the trivial
 single-sentence addition in this PR, and see if it could indeed
 make its way into 4.6? :)
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 This inert sentence is my body, but my soul is alive, dancing in the sparks of your brain.
State-Changed-From-To: open->patched 
State-Changed-By: roam 
State-Changed-When: Tue May 14 00:28:40 PDT 2002 
State-Changed-Why:  
Committed to -current, will merge to -stable in three days, pending 
approval from the release engineers. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=37839 
State-Changed-From-To: patched->closed 
State-Changed-By: roam 
State-Changed-When: Mon May 20 02:17:24 PDT 2002 
State-Changed-Why:  
Merged into the 4.x -STABLE branch. 
Thank you for the problem report! 

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