Re: [PATCH] doc: du - clarify default blocksize in usage/manpage

[Jim Meyering]

Pádraig Brady wrote:
> Eric Blake wrote:
>> According to OndYej Vaaík on 9/9/2009 2:19 AM:
>>> Hello,
>>> as requested via https://bugzilla.redhat.com/show_bug.cgi?id=511188 , it
>>> would be nice to clarify default blocksize used by du in manpage/--help
>>> output. Although I closed that bugzilla as notabug, further
>>> communication via private emails convinced me to propose that change to
>>> upstream.
>>> As it breaks translation strings, I guess it would be better to postpone
>>> commit after 7.6 (if accepted).
>>
>> The default block size depends on POSIXLY_CORRECT (which requires 512, not
>> 1024) and on BLOCK_SIZE (which the user can set to a different size).
>> Maybe a better thing to do would be adding a blurb about environment
>> variables that affect block size.
>>
>> Also, df and ls need the same treatment, whatever we decide to do.
>
> Sorry if you get this thrice, resending using a another smtp server...

First time I've seen it from you.

> Good point about df. I've updated the attached patch accordingly.
> ls doesn't need to mention it I think since it defaults to 1.
> There is a section in the info docs explaining the various ways
> of specifying block size for these programs.
>
> cheers,
> Pádraig.
>
>
> diff --git a/src/df.c b/src/df.c
> index 86fd0e3..a14a671 100644
> --- a/src/df.c
> +++ b/src/df.c
> @@ -810,13 +810,13 @@ or all file systems by default.\n\
>        fputs (_("\
>  Mandatory arguments to long options are mandatory for short options too.\n\
>  "), stdout);
> -      fputs (_("\
> +      printf (_("\
>    -a, --all             include dummy file systems\n\
> -  -B, --block-size=SIZE  use SIZE-byte blocks\n\
> +  -B, --block-size=SIZE use SIZE-byte blocks instead of %"PRIuMAX"\n\

Having two spaces there is important.
The sc_two_space_separator_in_usage syntax-check rule enforces it.
help2man requires at least two spaces for proper formatting.