[PATCH] xfs_quota: Better describe quota verbose output

[Brian Foster]

On Wed, Jun 24, 2015 at 11:09:09AM -0300, Carlos Maiolino wrote:
> Due historical reasons, and to be compliant with the generic quota command,
> xfs_quota does not output any information when there is no used percentage of
> the available quota. Such behavior might make users confused, so, I believe it's
> better to have the reasons for such behavior better documented.
> 

Seems reasonable...

> Signed-off-by: Carlos Maiolino <cmaiolino at redhat.com>
> ---
>  man/man8/xfs_quota.8 | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
> index 9b555e9..ef90bfb 100644
> --- a/man/man8/xfs_quota.8
> +++ b/man/man8/xfs_quota.8
> @@ -197,7 +197,9 @@ option reports the numeric IDs rather than the name. The
>  .B \-N
>  option omits the header. The
>  .B \-v
> -option outputs verbose information. The
> +option outputs verbose information, displaying quota values even when there is
> +no used space. Such behavior was chosen to be compliant with the 'quota' command
> +and for historical reasons. The

... though this sounds a bit unclear to me. Specifically, it sounds like
it could be saying that the behavior of -v has some historical
justification, when in fact, it is the absense of output in the
non-verbose case that we're trying to document (assuming I understand
the commit log correctly).

As an example, something like the following sounds more clear to me:

"The -v option outputs verbose information and includes quota limits
with no consumption. By default, xfs_quota does not display limits with
no consumption to maintain compatibility with the 'quota' command."

... but I suspect it could still be worded better.

Brian

>  .B \-f
>  option sends the output to
>  .I file
> -- 
> 2.1.0
> 
> _______________________________________________
> xfs mailing list
> xfs at oss.sgi.com
> http://oss.sgi.com/mailman/listinfo/xfs