Re: [PATCH]: nl: deprecate --page-increment in favour of --line-increment

[Giuseppe Scrivano]

Hello,

Jim Meyering <address@hidden> writes:

>> +  nl --page-increment: deprecated in favour of --line-increment, the new 
>> option
>> +  maintains the previous semantic and the same short option, -i.
>
> s/semantic/semantics/
>
> ...

> Please don't use "I".
> Use something like PAGE_INCREMENT_OPTION_DEPRECATED, as
> is done in install.c for PRESERVE_CONTEXT_OPTION_DEPRECATED.
>
> I.e., define this,
>
>     enum
>     {
>       PAGE_INCREMENT_OPTION_DEPRECATED = CHAR_MAX + 1,
>     };
>
> Then handle it in the same way install.c handles its deprecated
> long option:
>
>       case PRESERVE_CONTEXT_OPTION_DEPRECATED:
>         error (0, 0, _("WARNING: --preserve_context is deprecated; "
>                        "use --preserve-context instead"));
>         /* fall through */
>       case PRESERVE_CONTEXT_OPTION:
>           ...

thanks for the comments.  This is the cleaned version of the patch.

Cheers,
Giuseppe



>From 8dc27341e8ed57e790a71d4b61df44e908bc73cd Mon Sep 17 00:00:00 2001
From: Giuseppe Scrivano <address@hidden>
Date: Tue, 18 Aug 2009 12:22:37 +0200
Subject: [PATCH] nl: deprecate --page-increment in favour of --line-increment

* NEWS: Mention the change.
* doc/coreutils.texi: Document the --line-increment option.
* src/nl.c (struct option): Add --line-increment,
(usage): Describe it,
(main): Use it.
---
 NEWS               |    5 +++++
 doc/coreutils.texi |    4 ++--
 src/nl.c           |   15 +++++++++++++--
 3 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/NEWS b/NEWS
index 85cc82b..679576f 100644
--- a/NEWS
+++ b/NEWS
@@ -40,6 +40,11 @@ GNU coreutils NEWS                                    -*- 
outline -*-
   were renamed from 'HARDLINK' and 'hl' which were available since
   coreutils-7.1 when this feature was introduced.
 
+** Deprecated options
+
+  nl --page-increment: deprecated in favour of --line-increment, the new option
+  maintains the previous semantics and the same short option, -i.
+
 ** New features
 
   chroot now accepts the options --userspec and --groups.
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index bb1d87a..8e1b73d 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -1688,9 +1688,9 @@ Analogous to @option{--body-numbering}.
 Analogous to @option{--body-numbering}.
 
 @item -i @var{number}
address@hidden address@hidden
address@hidden address@hidden
 @opindex -i
address@hidden --page-increment
address@hidden --line-increment
 Increment line numbers by @var{number} (default 1).
 
 @item -l @var{number}
diff --git a/src/nl.c b/src/nl.c
index 2deb314..67b79d9 100644
--- a/src/nl.c
+++ b/src/nl.c
@@ -144,13 +144,20 @@ static intmax_t line_no;
 /* True if we have ever read standard input.  */
 static bool have_read_stdin;
 
+enum
+{
+  PAGE_INCREMENT_OPTION_DEPRECATED = CHAR_MAX + 1
+};
+
 static struct option const longopts[] =
 {
   {"header-numbering", required_argument, NULL, 'h'},
   {"body-numbering", required_argument, NULL, 'b'},
   {"footer-numbering", required_argument, NULL, 'f'},
   {"starting-line-number", required_argument, NULL, 'v'},
-  {"page-increment", required_argument, NULL, 'i'},
+  {"line-increment", required_argument, NULL, 'i'},
+  /* FIXME: page-increment is deprecated, remove in dec-2011.  */
+  {"page-increment", required_argument, NULL, 
PAGE_INCREMENT_OPTION_DEPRECATED},
   {"no-renumber", no_argument, NULL, 'p'},
   {"join-blank-lines", required_argument, NULL, 'l'},
   {"number-separator", required_argument, NULL, 's'},
@@ -191,7 +198,7 @@ Mandatory arguments to long options are mandatory for short 
options too.\n\
 "), stdout);
       fputs (_("\
   -h, --header-numbering=STYLE    use STYLE for numbering header lines\n\
-  -i, --page-increment=NUMBER     line number increment at each line\n\
+  -i, --line-increment=NUMBER     line number increment at each line\n\
   -l, --join-blank-lines=NUMBER   group of NUMBER empty lines counted as one\n\
   -n, --number-format=FORMAT      insert line numbers according to FORMAT\n\
   -p, --no-renumber               do not reset line numbers at logical pages\n\
@@ -504,6 +511,10 @@ main (int argc, char **argv)
              ok = false;
            }
          break;
+  case PAGE_INCREMENT_OPTION_DEPRECATED:
+    error (0, 0, _("WARNING: --preserve_context is deprecated; "
+                   "use --preserve-context instead"));
+    /* fall through */
        case 'i':
          if (! (xstrtoimax (optarg, NULL, 10, &page_incr, "") == LONGINT_OK
                 && 0 < page_incr))
-- 
1.6.3.3