Bug 524138

Summary: man page for quotactl indicates wrong headers and structs
Product: [Fedora] Fedora Reporter: Elliott Forney <elliott.forney>
Component: quotaAssignee: Ondrej Vasik <ovasik>
Status: CLOSED ERRATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: low    
Version: 11CC: kdudka, ovasik
Target Milestone: ---Keywords: Reopened
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: 3.17-6.fc11 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2009-10-27 07:00:50 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
updated quotactl man page none

Description Elliott Forney 2009-09-18 03:44:21 UTC 
Description of problem:
The man page for quotactl has several inconsistencies,

1.  The man page indicates that the headers linux/quota.h linux/dqblk_v1.h and linux/dqblk_v2.h contain the interfaces for this function.  It is my understanding that these headers are for use by the kernel and that only sys/quota.h needs to be included.

Item 1 seems to have been addressed in RHEL 5 http://rhn.redhat.com/errata/RHBA-2008-0637.html but the fix has yet to make it into fedora (apologies if this is in the works).

2.  In several places the man page indicates that the if_dqblk or if_dqinfo structs should be passed to quotactl.  Again, it is my understanding that these are the structs used by the kernel.  The structs dqblk and dqinfo should be used instead (these are already defined in sys/quota.h)

3.  The man page indicates that a uid or gid can be passed to quotactl as a qid_t.  However, there is no qid_t defined in sys/quota.h  Instead, id is simply defined as an int.  The man page should either reflect this or qid_t should be typedefed in quota.h

Version-Release number of selected component (if applicable):
quota-3.17-4

How reproducible:
Always

Steps to Reproduce:
man quotactl

Additional info:

I have attached the man page as I believe it should read.
Comment 1 Elliott Forney 2009-09-18 03:46:55 UTC 
Created attachment 361586 [details]
updated quotactl man page
Comment 2 Ondrej Vasik 2009-09-18 07:49:26 UTC 
Thanks for report and updated manpage. "quota.h" header included in quota tarball declares quotactl as long quotactl __P((int, const char *, qid_t, caddr_t)); ... this corresponds with declaration in linux/quota.h . However - you are right that those headers are for kernel use and we changed linux/quota.h to sys/quota.h in RHEL-5 manpages. So fixed in rawhide... will think about F-11 update.

Maybe for consistency, even the declaration in internal quota.h should be changed - as qid_t is declared as u_int32_t - which is different type from int. Will see what's upstream opinion (although they seem to be a bit unactive in recent few months).
Comment 3 Fedora Update System 2009-10-20 11:24:52 UTC 
quota-3.17-5.fc11 has been submitted as an update for Fedora 11.
http://admin.fedoraproject.org/updates/quota-3.17-5.fc11
Comment 4 Fedora Update System 2009-10-21 00:51:10 UTC 
quota-3.17-5.fc11 has been pushed to the Fedora 11 stable repository.  If problems still persist, please make note of it in this bug report.
Comment 5 Elliott Forney 2009-10-21 23:30:07 UTC 
The above noted changes are still not present in quota-3.17-5.fc11

Perhaps forgot to include quotactl man page in update?
Comment 6 Ondrej Vasik 2009-10-22 06:19:39 UTC 
Yep, sorry, I added the patch to cvs, but accidently forgot to actually patch the sources. Hopefully fixed update fill follow soon...
Comment 7 Fedora Update System 2009-10-22 07:36:46 UTC 
quota-3.17-6.fc11 has been submitted as an update for Fedora 11.
http://admin.fedoraproject.org/updates/quota-3.17-6.fc11
Comment 8 Fedora Update System 2009-10-27 07:00:41 UTC 
quota-3.17-6.fc11 has been pushed to the Fedora 11 stable repository.  If problems still persist, please make note of it in this bug report.