Bug 37839

Summary: Improve man page for quotactl(2)
Product: Documentation Reporter: wayne <wayne>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description wayne 2002-05-07 18:50:03 UTC
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.

Fix: Apply the following 1 line patch:
How-To-Repeat: See above.
Comment 1 Peter Pentchev 2002-05-08 11:21:04 UTC
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 ,
Comment 2 Peter Pentchev 2002-05-08 17:58:58 UTC
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.
Comment 3 wayne 2002-05-08 18:39:59 UTC
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?

/\/\ \/\/
Comment 4 Peter Pentchev freebsd_committer freebsd_triage 2002-05-14 08:28:40 UTC
State Changed
From-To: open->patched

Committed to -current, will merge to -stable in three days, pending 
approval from the release engineers.
Comment 5 Peter Pentchev freebsd_committer freebsd_triage 2002-05-20 10:17:24 UTC
State Changed
From-To: patched->closed

Merged into the 4.x -STABLE branch. 
Thank you for the problem report!