diff mbox series

[1/3] xfs_quota: document how the default quota is stored

Message ID 2e9b1d0f-7ad8-b42a-ac2b-b1fdd9a9fb45@redhat.com (mailing list archive)
State Superseded
Headers show
Series xfs_quota: man page fixups | expand

Commit Message

Eric Sandeen Dec. 3, 2020, 8 p.m. UTC
Nowhere in the man page is the default quota described; what it
does or where it is stored.  Add some brief information about this.

Signed-off-by: Eric Sandeen <sandeen@redhat.com>
---
 man/man8/xfs_quota.8 | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Darrick J. Wong Dec. 3, 2020, 8:07 p.m. UTC | #1
On Thu, Dec 03, 2020 at 02:00:01PM -0600, Eric Sandeen wrote:
> Nowhere in the man page is the default quota described; what it
> does or where it is stored.  Add some brief information about this.
> 
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> ---
>  man/man8/xfs_quota.8 | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
> index dd0479cd..b3c4108e 100644
> --- a/man/man8/xfs_quota.8
> +++ b/man/man8/xfs_quota.8
> @@ -178,6 +178,11 @@ to a file on
>  where the user's quota has not been exceeded.
>  Then after rectifying the quota situation, the file can be moved back to the
>  filesystem it belongs on.
> +.SS Default Quotas
> +The XFS quota subsystem allows a default quota to be enforced for any user which

"user"?  Does this not apply to group or project quotas? ;)

> +does not have a quota limit explicitly set. These limits are stored in and

Usual complaint about starting sentences in column zero in manpage
source. :)

--D

> +displayed as the "root" user's limits, although they do not actually limit the
> +root user.
>  .SH USER COMMANDS
>  .TP
>  .B print
> -- 
> 2.17.0
> 
>
Eric Sandeen Dec. 3, 2020, 8:12 p.m. UTC | #2
On 12/3/20 2:07 PM, Darrick J. Wong wrote:
> On Thu, Dec 03, 2020 at 02:00:01PM -0600, Eric Sandeen wrote:
>> Nowhere in the man page is the default quota described; what it
>> does or where it is stored.  Add some brief information about this.
>>
>> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
>> ---
>>  man/man8/xfs_quota.8 | 5 +++++
>>  1 file changed, 5 insertions(+)
>>
>> diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
>> index dd0479cd..b3c4108e 100644
>> --- a/man/man8/xfs_quota.8
>> +++ b/man/man8/xfs_quota.8
>> @@ -178,6 +178,11 @@ to a file on
>>  where the user's quota has not been exceeded.
>>  Then after rectifying the quota situation, the file can be moved back to the
>>  filesystem it belongs on.
>> +.SS Default Quotas
>> +The XFS quota subsystem allows a default quota to be enforced for any user which
> 
> "user"?  Does this not apply to group or project quotas? ;)

I thought about that, but the overview section already refers to "users" as a
generic idea, i.e. "Quotas can be set for each individual user on any/all of the
local filesystems."

I mean, I guess I could s/user/ID/ to be more clear or rewrite the whole overview...

>> +does not have a quota limit explicitly set. These limits are stored in and
> 
> Usual complaint about starting sentences in column zero in manpage
> source. :)

grumble grumble random nonobvious rules grumble ok

-Eric

> --D
> 
>> +displayed as the "root" user's limits, although they do not actually limit the
>> +root user.
>>  .SH USER COMMANDS
>>  .TP
>>  .B print
>> -- 
>> 2.17.0
>>
>>
>
Darrick J. Wong Dec. 3, 2020, 8:38 p.m. UTC | #3
On Thu, Dec 03, 2020 at 02:12:58PM -0600, Eric Sandeen wrote:
> On 12/3/20 2:07 PM, Darrick J. Wong wrote:
> > On Thu, Dec 03, 2020 at 02:00:01PM -0600, Eric Sandeen wrote:
> >> Nowhere in the man page is the default quota described; what it
> >> does or where it is stored.  Add some brief information about this.
> >>
> >> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> >> ---
> >>  man/man8/xfs_quota.8 | 5 +++++
> >>  1 file changed, 5 insertions(+)
> >>
> >> diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
> >> index dd0479cd..b3c4108e 100644
> >> --- a/man/man8/xfs_quota.8
> >> +++ b/man/man8/xfs_quota.8
> >> @@ -178,6 +178,11 @@ to a file on
> >>  where the user's quota has not been exceeded.
> >>  Then after rectifying the quota situation, the file can be moved back to the
> >>  filesystem it belongs on.
> >> +.SS Default Quotas
> >> +The XFS quota subsystem allows a default quota to be enforced for any user which
> > 
> > "user"?  Does this not apply to group or project quotas? ;)
> 
> I thought about that, but the overview section already refers to "users" as a
> generic idea, i.e. "Quotas can be set for each individual user on any/all of the
> local filesystems."
> 
> I mean, I guess I could s/user/ID/ to be more clear or rewrite the whole overview...

<shrug> "The XFS quota subsystem allows a default quota to be enforced
for any user, group or project which does not have a quota limit
explicitly set."

> >> +does not have a quota limit explicitly set. These limits are stored in and

"These limits are stored in and displayed as ID 0's limits."

since id==0 doesn't necessarily map to "root" unless
/etc/{passwd,group,projid} explicitly defines that.

--D

> > 
> > Usual complaint about starting sentences in column zero in manpage
> > source. :)
> 
> grumble grumble random nonobvious rules grumble ok
> 
> -Eric
> 
> > --D
> > 
> >> +displayed as the "root" user's limits, although they do not actually limit the
> >> +root user.
> >>  .SH USER COMMANDS
> >>  .TP
> >>  .B print
> >> -- 
> >> 2.17.0
> >>
> >>
> > 
>
diff mbox series

Patch

diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
index dd0479cd..b3c4108e 100644
--- a/man/man8/xfs_quota.8
+++ b/man/man8/xfs_quota.8
@@ -178,6 +178,11 @@  to a file on
 where the user's quota has not been exceeded.
 Then after rectifying the quota situation, the file can be moved back to the
 filesystem it belongs on.
+.SS Default Quotas
+The XFS quota subsystem allows a default quota to be enforced for any user which
+does not have a quota limit explicitly set. These limits are stored in and
+displayed as the "root" user's limits, although they do not actually limit the
+root user.
 .SH USER COMMANDS
 .TP
 .B print