column: Deprecate --table-empty-lines in favor of --keep-empty-lines

`--table-empty-lines` gives the false impression that the option
only applies to table mode.

Signed-off-by: Lennard Hofmann <lennard.hofmann@web.de>

diff --git a/Documentation/deprecated.txt b/Documentation/deprecated.txt
index 08ba8b974af9c07c60a7761744ed385d0f26166f..4d4b309d657ec8566342296d1132bb2792b64ddd 100644 (file)
--- a/Documentation/deprecated.txt
+++ b/Documentation/deprecated.txt
@@ -2,6 +2,13 @@ The following is a list of commands or features that are deprecated.  All
 deprecated utils are in maintenance mode and we keep them in source tree for
 backward compatibility only.
 
+
+what:  column --table-empty-lines
+why:   renamed to --keep-empty-lines
+since: v2.37
+
+--------------------------
+
 what:  hwclock --debug
 why:   renamed to --verbose, and may be repurposed later.
 since: v2.32

diff --git a/bash-completion/column b/bash-completion/column
index 1f47aecc85d2ef56a97c93153d7b2d3bbb984ec9..5ce56e76fce36d35ea9f604e76e4318b53e048fb 100644 (file)
--- a/bash-completion/column
+++ b/bash-completion/column
@@ -40,7 +40,7 @@ _column_module()
                                --table-right
                                --table-truncate
                                --table-wrap
-                               --table-empty-lines
+                               --keep-empty-lines
                                --json
                                --tree
                                --tree-id

diff --git a/text-utils/column.1 b/text-utils/column.1
index 86886f3bf457bd904e408ee0ac01b046714d6b55..d10fc7efbb47a35873c19a44fbe422b9f953415a 100644 (file)
--- a/text-utils/column.1
+++ b/text-utils/column.1
@@ -110,9 +110,11 @@ hide all unnamed columns (see \-\-table-columns).
 Specify columns order on output.
 .IP "\fB\-n, \-\-table-name\fP \fIname\fP"
 Specify the table name used for JSON output. The default is "table".
-.IP "\fB\-L, \-\-table\-empty\-lines\fP"
-Insert empty line to the table for each empty line on input. The default
-is ignore empty lines at all.
+.IP "\fB\-L, \-\-keep\-empty\-lines\fP"
+Preserve whitespace-only lines in the input. The default is ignore empty lines
+at all. This option’s original name was \-\-table-empty-lines but is now
+deprecated because it gives the false impression that the option only applies
+to table mode.
 .IP "\fB\-r, \-\-tree\fP \fIcolumn\fP"
 Specify column to use tree-like output. Note that the circular dependencies and
 other anomalies in child and parent relation are silently ignored.

diff --git a/text-utils/column.c b/text-utils/column.c
index f01499dca7019119ef7b5aab7eb119b0d2aebb0e..d251a710e3b5600a6f1c0101071a2de78862c25e 100644 (file)
--- a/text-utils/column.c
+++ b/text-utils/column.c
@@ -96,7 +96,7 @@ struct column_control {
        unsigned int greedy :1,
                     json :1,
                     header_repeat :1,
-                    tab_empty_lines :1,        /* --table-empty-lines */
+                    keep_empty_lines :1,       /* --keep-empty-lines */
                     tab_noheadings :1;
 };
 
@@ -523,7 +523,7 @@ static int read_input(struct column_control *ctl, FILE *fp)
                                *p = '\0';
                }
                if (!str || !*str) {
-                       if (ctl->tab_empty_lines) {
+                       if (ctl->keep_empty_lines) {
                                if (ctl->mode == COLUMN_MODE_TABLE) {
                                        add_emptyline_to_table(ctl);
                                } else {
@@ -664,7 +664,7 @@ static void __attribute__((__noreturn__)) usage(void)
        fputs(_(" -R, --table-right <columns>      right align text in these columns\n"), out);
        fputs(_(" -T, --table-truncate <columns>   truncate text in the columns when necessary\n"), out);
        fputs(_(" -W, --table-wrap <columns>       wrap text in the columns when necessary\n"), out);
-       fputs(_(" -L, --table-empty-lines          don't ignore empty lines\n"), out);
+       fputs(_(" -L, --keep-empty-lines           don't ignore empty lines\n"), out);
        fputs(_(" -J, --json                       use JSON output format for table\n"), out);
 
        fputs(USAGE_SEPARATOR, out);
@@ -703,6 +703,7 @@ int main(int argc, char **argv)
                { "fillrows",            no_argument,       NULL, 'x' },
                { "help",                no_argument,       NULL, 'h' },
                { "json",                no_argument,       NULL, 'J' },
+               { "keep-empty-lines",    no_argument,       NULL, 'L' },
                { "output-separator",    required_argument, NULL, 'o' },
                { "output-width",        required_argument, NULL, 'c' },
                { "separator",           required_argument, NULL, 's' },
@@ -717,7 +718,7 @@ int main(int argc, char **argv)
                { "table-right",         required_argument, NULL, 'R' },
                { "table-truncate",      required_argument, NULL, 'T' },
                { "table-wrap",          required_argument, NULL, 'W' },
-               { "table-empty-lines",   no_argument,       NULL, 'L' },
+               { "table-empty-lines",   no_argument,       NULL, 'L' }, /* deprecated */
                { "table-header-repeat", no_argument,       NULL, 'e' },
                { "tree",                required_argument, NULL, 'r' },
                { "tree-id",             required_argument, NULL, 'i' },
@@ -768,7 +769,7 @@ int main(int argc, char **argv)
                        ctl.mode = COLUMN_MODE_TABLE;
                        break;
                case 'L':
-                       ctl.tab_empty_lines = 1;
+                       ctl.keep_empty_lines = 1;
                        break;
                case 'l':
                        ctl.maxncols = strtou32_or_err(optarg, _("invalid columns limit argument"));