GNU bug report logs - #11858
df -m undocumented, why no df -g

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 11858 in the body.
You can then email your comments to 11858 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Andreas Jaeger <aj <at> suse.com>
To: bug-coreutils <at> gnu.org
Subject: df -m undocumented, why no df -g
Date: Wed, 04 Jul 2012 10:11:25 +0200

df -k and df -m both work but only df -k is mentioned as part of df --
help. So, the omission to document -m is IMO a bug.

A second issue:
Since df supports -k and -m, shouldn't if support -g (as synoym for --
block-size=1M as well?

Btw. df --version outputs:
df (GNU coreutils) 8.16

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126

Message #8 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: Andreas Jaeger <aj <at> suse.com>
Cc: 11858 <at> debbugs.gnu.org
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Wed, 04 Jul 2012 12:38:32 -0700

On 07/04/2012 01:11 AM, Andreas Jaeger wrote:
> df -k and df -m both work but only df -k is mentioned as part of df --
> help. So, the omission to document -m is IMO a bug.

I think the general idea is that -k was a mistake, but
it's standardized, and that we don't want to have
options -m, -g, -t, -p, -e, -z, -y for the other sizes
(among other things -t is already taken).  -m is there
only for BSD compatibility but we don't want to publicize
it and we may want to take it back at some point.

Message #11 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Bernhard Voelker <mail <at> bernhard-voelker.de>
To: Paul Eggert <eggert <at> cs.ucla.edu>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 08:48:19 +0200

On 07/04/2012 09:38 PM, Paul Eggert wrote:
> On 07/04/2012 01:11 AM, Andreas Jaeger wrote:
>> df -k and df -m both work but only df -k is mentioned as part of df --
>> help. So, the omission to document -m is IMO a bug.
> 
> I think the general idea is that -k was a mistake, but
> it's standardized, and that we don't want to have
> options -m, -g, -t, -p, -e, -z, -y for the other sizes
> (among other things -t is already taken).  -m is there
> only for BSD compatibility but we don't want to publicize
> it and we may want to take it back at some point.

Wouldn't it then be consequent to remove the long option --megabyte?
(It's sister --kilobyte has been removed by v6.9-151-g1e07a21
in 2007.)

Have a nice day,
Berny


From 664bf8a103585915896f3be9f3a01f11ce17ddc6 Mon Sep 17 00:00:00 2001
From: Bernhard Voelker <mail <at> bernhard-voelker.de>
Date: Thu, 5 Jul 2012 08:44:22 +0200
Subject: [PATCH] df: Remove long-obsolescent --megabyte option.

* src/df.c (long_options): Remove --megabyte option.
---
 src/df.c |    1 -
 1 files changed, 0 insertions(+), 1 deletions(-)

diff --git a/src/df.c b/src/df.c
index e99fedf..8520424 100644
--- a/src/df.c
+++ b/src/df.c
@@ -178,7 +178,6 @@ static struct option const long_options[] =
   {"human-readable", no_argument, NULL, 'h'},
   {"si", no_argument, NULL, 'H'},
   {"local", no_argument, NULL, 'l'},
-  {"megabytes", no_argument, NULL, 'm'}, /* obsolescent */
   {"portability", no_argument, NULL, 'P'},
   {"print-type", no_argument, NULL, 'T'},
   {"sync", no_argument, NULL, SYNC_OPTION},
-- 
1.7.7

Message #14 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: Bernhard Voelker <mail <at> bernhard-voelker.de>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 00:06:23 -0700

On 07/04/2012 11:48 PM, Bernhard Voelker wrote:
> Wouldn't it then be consequent to remove the long option --megabyte?

Yes, that does make sense.

Message #17 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Eric Blake <eblake <at> redhat.com>
To: Bernhard Voelker <mail <at> bernhard-voelker.de>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 05:21:36 -0600

[Message part 1 (text/plain, inline)]

On 07/05/2012 12:48 AM, Bernhard Voelker wrote:

>> I think the general idea is that -k was a mistake, but
>> it's standardized, and that we don't want to have
>> options -m, -g, -t, -p, -e, -z, -y for the other sizes
>> (among other things -t is already taken).  -m is there
>> only for BSD compatibility but we don't want to publicize
>> it and we may want to take it back at some point.
> 
> Wouldn't it then be consequent to remove the long option --megabyte?
> (It's sister --kilobyte has been removed by v6.9-151-g1e07a21
> in 2007.)

In fact, the reason we removed --kilobyte was that it is a misnomer; -k
works on kibibytes, not kilobytes.  Similarly, -m works on mebibytes,
not megabytes.  So whether or not we keep -m but leave it undocumented,
removing the long form --megabyte makes complete sense.

> 
>>From 664bf8a103585915896f3be9f3a01f11ce17ddc6 Mon Sep 17 00:00:00 2001
> From: Bernhard Voelker <mail <at> bernhard-voelker.de>
> Date: Thu, 5 Jul 2012 08:44:22 +0200
> Subject: [PATCH] df: Remove long-obsolescent --megabyte option.
> 
> * src/df.c (long_options): Remove --megabyte option.

I like this patch, but I'll let Jim decide whether to apply it.

-- 
Eric Blake   eblake <at> redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

[signature.asc (application/pgp-signature, attachment)]

Message #20 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Jim Meyering <jim <at> meyering.net>
To: Bernhard Voelker <mail <at> bernhard-voelker.de>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 14:35:32 +0200

Bernhard Voelker wrote:
> On 07/04/2012 09:38 PM, Paul Eggert wrote:
>> On 07/04/2012 01:11 AM, Andreas Jaeger wrote:
>>> df -k and df -m both work but only df -k is mentioned as part of df --
>>> help. So, the omission to document -m is IMO a bug.
>>
>> I think the general idea is that -k was a mistake, but
>> it's standardized, and that we don't want to have
>> options -m, -g, -t, -p, -e, -z, -y for the other sizes
>> (among other things -t is already taken).  -m is there
>> only for BSD compatibility but we don't want to publicize
>> it and we may want to take it back at some point.
>
> Wouldn't it then be consequent to remove the long option --megabyte?
> (It's sister --kilobyte has been removed by v6.9-151-g1e07a21
> in 2007.)
...
> Subject: [PATCH] df: Remove long-obsolescent --megabyte option.
>
> * src/df.c (long_options): Remove --megabyte option.
> ---
>  src/df.c |    1 -
>  1 files changed, 0 insertions(+), 1 deletions(-)
>
> diff --git a/src/df.c b/src/df.c
> index e99fedf..8520424 100644
> --- a/src/df.c
> +++ b/src/df.c
> @@ -178,7 +178,6 @@ static struct option const long_options[] =
>    {"human-readable", no_argument, NULL, 'h'},
>    {"si", no_argument, NULL, 'H'},
>    {"local", no_argument, NULL, 'l'},
> -  {"megabytes", no_argument, NULL, 'm'}, /* obsolescent */
>    {"portability", no_argument, NULL, 'P'},
>    {"print-type", no_argument, NULL, 'T'},
>    {"sync", no_argument, NULL, SYNC_OPTION},

Hi Berny,

I like the idea, but wonder if an abrupt removal would break old scripts.
For du, we made its --megabytes option issue a warning first, and removed
it altogether a year or two later.

However, I'm tempted to remove it directly this time, since it's been
undocumented for a while:

  5 years in df.1 and df --help: COREUTILS-6_9-151-g1e07a21
  11 years in coreutils.texi: FILEUTILS-4_1_4-28-gf5bf6fe

What do you think?

Message #23 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Bernhard Voelker <mail <at> bernhard-voelker.de>
To: Jim Meyering <jim <at> meyering.net>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 16:43:56 +0200

On 07/05/2012 02:35 PM, Jim Meyering wrote:
> However, I'm tempted to remove it directly this time, since it's been
> undocumented for a while:
> 
>   5 years in df.1 and df --help: COREUTILS-6_9-151-g1e07a21
>   11 years in coreutils.texi: FILEUTILS-4_1_4-28-gf5bf6fe
> 
> What do you think?

I agree, the option has been added to df in 1996, and declared
obsolescent in 2001, so the period since the latter is twice as
long as the active use.

And it's very easy to s/--megabytes/-BM/ ...

Have a nice day,
Berny

Message #26 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Jim Meyering <jim <at> meyering.net>
To: Bernhard Voelker <mail <at> bernhard-voelker.de>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Thu, 05 Jul 2012 17:08:47 +0200

Bernhard Voelker wrote:
> On 07/05/2012 02:35 PM, Jim Meyering wrote:
>> However, I'm tempted to remove it directly this time, since it's been
>> undocumented for a while:
>>
>>   5 years in df.1 and df --help: COREUTILS-6_9-151-g1e07a21
>>   11 years in coreutils.texi: FILEUTILS-4_1_4-28-gf5bf6fe
>>
>> What do you think?
>
> I agree, the option has been added to df in 1996, and declared
> obsolescent in 2001, so the period since the latter is twice as
> long as the active use.
>
> And it's very easy to s/--megabytes/-BM/ ...

More important than 2001 is the year in which we removed
the reference from the man page and from --help: 2007

Message #29 received at 11858 <at> debbugs.gnu.org (full text, mbox):

From: Bernhard Voelker <mail <at> bernhard-voelker.de>
To: Jim Meyering <jim <at> meyering.net>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858 <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Wed, 11 Jul 2012 17:35:36 +0200

On 07/05/2012 05:08 PM, Jim Meyering wrote:
> Bernhard Voelker wrote:
>> On 07/05/2012 02:35 PM, Jim Meyering wrote:
>>> However, I'm tempted to remove it directly this time, since it's been
>>> undocumented for a while:
>>>
>>>   5 years in df.1 and df --help: COREUTILS-6_9-151-g1e07a21
>>>   11 years in coreutils.texi: FILEUTILS-4_1_4-28-gf5bf6fe
>>>
>>> What do you think?
>>
>> I agree, the option has been added to df in 1996, and declared
>> obsolescent in 2001, so the period since the latter is twice as
>> long as the active use.
>>
>> And it's very easy to s/--megabytes/-BM/ ...
> 
> More important than 2001 is the year in which we removed
> the reference from the man page and from --help: 2007

You're right. Then what about a deprecation warning and removing
the long option in 2013?

P.S. Make "syntax-check" doesn't find the offender against
sc_error_message_uppercase for the "Warning:" message when
(mount_list == NULL) in df.c

Have a nice day,
Berny


From 750cd181cf87160b11556f92bd098ba535780ffc Mon Sep 17 00:00:00 2001
From: Bernhard Voelker <mail <at> bernhard-voelker.de>
Date: Wed, 11 Jul 2012 17:27:20 +0200
Subject: [PATCH] df: Warn if soon-to-be-removed --megabyte option is used

* src/df.c: MEGABYTES_OPTION: Add new enum and mark it to be removed
in August 2013.
* src/df.c (long_options): Use MEGABYTES_OPTION for --megabytes option.
* src/df.c (main): Add case for MEGABYTES_OPTION and issue a deprecation
warning if the long form is being used. Document the short -m option to
exist only for BSD compatibility.
---
 src/df.c |   14 +++++++++++---
 1 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/df.c b/src/df.c
index e99fedf..7e30d57 100644
--- a/src/df.c
+++ b/src/df.c
@@ -167,7 +167,8 @@ static size_t nrows;
 enum
 {
   NO_SYNC_OPTION = CHAR_MAX + 1,
-  SYNC_OPTION
+  SYNC_OPTION,
+  MEGABYTES_OPTION  /* FIXME: remove long opt in Aug 2013 */
 };

 static struct option const long_options[] =
@@ -178,7 +179,7 @@ static struct option const long_options[] =
   {"human-readable", no_argument, NULL, 'h'},
   {"si", no_argument, NULL, 'H'},
   {"local", no_argument, NULL, 'l'},
-  {"megabytes", no_argument, NULL, 'm'}, /* obsolescent */
+  {"megabytes", no_argument, NULL, MEGABYTES_OPTION}, /* obsolescent,  */
   {"portability", no_argument, NULL, 'P'},
   {"print-type", no_argument, NULL, 'T'},
   {"sync", no_argument, NULL, SYNC_OPTION},
@@ -951,7 +952,14 @@ main (int argc, char **argv)
         case 'l':
           show_local_fs = true;
           break;
-        case 'm': /* obsolescent */
+        case MEGABYTES_OPTION:
+          /* Distinguish between the long and the short option.
+             As we want to remove the long option soon,
+             give a warning when the long form is used.  */
+          error (0, 0, "%s%s", _("warning: "),
+            _("long option '--megabytes' is deprecated"
+              " and will soon be removed"));
+        case 'm': /* obsolescent, exists for BSD compatibility */
           human_output_opts = 0;
           output_block_size = 1024 * 1024;
           break;
-- 
1.7.7

Message #34 received at 11858-done <at> debbugs.gnu.org (full text, mbox):

From: Jim Meyering <jim <at> meyering.net>
To: Bernhard Voelker <mail <at> bernhard-voelker.de>
Cc: Andreas Jaeger <aj <at> suse.com>, 11858-done <at> debbugs.gnu.org,
	Paul Eggert <eggert <at> cs.ucla.edu>
Subject: Re: bug#11858: df -m undocumented, why no df -g
Date: Wed, 11 Jul 2012 17:50:06 +0200

Bernhard Voelker wrote:
> Subject: [PATCH] df: Warn if soon-to-be-removed --megabyte option is used
>
> * src/df.c: MEGABYTES_OPTION: Add new enum and mark it to be removed
> in August 2013.
> * src/df.c (long_options): Use MEGABYTES_OPTION for --megabytes option.
> * src/df.c (main): Add case for MEGABYTES_OPTION and issue a deprecation
> warning if the long form is being used. Document the short -m option to
> exist only for BSD compatibility.

Thanks.  Applied with log tweaks (e.g., s/W/w/ in summary, removed
each "* src/df.c" after the first -- "*" introduces a new file).

From 5e78bbd163dbc739e168fc2bff6273a2b6e5e5de Mon Sep 17 00:00:00 2001
From: Bernhard Voelker <mail <at> bernhard-voelker.de>
Date: Wed, 11 Jul 2012 17:27:20 +0200
Subject: [PATCH] df: warn if soon-to-be-removed --megabyte option is used

* src/df.c (MEGABYTES_OPTION): Add enum and mark it for removal
in August 2013.
(long_options): Use MEGABYTES_OPTION for --megabytes option.
(main): Add a case for it and issue a deprecation warning if
the long form is used.  Document the short -m option to
exist only for BSD compatibility.
---
 src/df.c | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/df.c b/src/df.c
index e99fedf..7e30d57 100644
--- a/src/df.c
+++ b/src/df.c
@@ -167,7 +167,8 @@ static size_t nrows;
 enum
 {
   NO_SYNC_OPTION = CHAR_MAX + 1,
-  SYNC_OPTION
+  SYNC_OPTION,
+  MEGABYTES_OPTION  /* FIXME: remove long opt in Aug 2013 */
 };

 static struct option const long_options[] =
@@ -178,7 +179,7 @@ static struct option const long_options[] =
   {"human-readable", no_argument, NULL, 'h'},
   {"si", no_argument, NULL, 'H'},
   {"local", no_argument, NULL, 'l'},
-  {"megabytes", no_argument, NULL, 'm'}, /* obsolescent */
+  {"megabytes", no_argument, NULL, MEGABYTES_OPTION}, /* obsolescent,  */
   {"portability", no_argument, NULL, 'P'},
   {"print-type", no_argument, NULL, 'T'},
   {"sync", no_argument, NULL, SYNC_OPTION},
@@ -951,7 +952,14 @@ main (int argc, char **argv)
         case 'l':
           show_local_fs = true;
           break;
-        case 'm': /* obsolescent */
+        case MEGABYTES_OPTION:
+          /* Distinguish between the long and the short option.
+             As we want to remove the long option soon,
+             give a warning when the long form is used.  */
+          error (0, 0, "%s%s", _("warning: "),
+            _("long option '--megabytes' is deprecated"
+              " and will soon be removed"));
+        case 'm': /* obsolescent, exists for BSD compatibility */
           human_output_opts = 0;
           output_block_size = 1024 * 1024;
           break;
--
1.7.11.1.165.g299666c

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.