Thread: pg_controldata usage

pg_controldata usage

From
Dennis Bjorklund
Date:
Today "pg_controldata --help" gives this usage info:

| Usage:
|   pg_controldata [OPTION]
|
| Options:
|   DATADIR        show cluster control information for DATADIR
|   --help         show this help, then exit
|   --version      output version information, then exit
|
| If no data directory is specified, the environment variable PGDATA
| is used.

I think that the DATADIR part being treated as an option is confusing and
would like to change it to:

| Usage:
|   pg_controldata [OPTION] [DATADIR]
|
| Options:
|   --help         show this help, then exit
|   --version      output version information, then exit
|
| If no data directory (DATADIR) is specified, the environment variable
| PGDATA is used.

Any opinions?

The patch in itself is trivial, but since this is -patches, here it is:

--- pg_controldata.c    29 Aug 2004 05:06:53 -0000      1.19
+++ pg_controldata.c    18 Sep 2004 15:35:40 -0000
@@ -30,15 +30,14 @@
                (
                 _(
                   "Usage:\n"
-                  "  %s [OPTION]\n\n"
+                  "  %s [OPTION] [DATADIR]\n\n"
                   "Options:\n"
-               "  DATADIR        show cluster control information for DATADIR\n"
                   "  --help         show this help, then exit\n"
                   "  --version      output version information, then exit\n"
                   ),
                 progname
                );
-       printf(_("\nIf no data directory is specified, the environment variable PGDATA\nis used.\n\n"));
+       printf(_("\nIf no data directory (DATADIR) is specified, the environment variable\nPGDATA is used.\n\n"));
        printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
 }

--
/Dennis Björklund


Re: pg_controldata usage

From
Neil Conway
Date:
On Sun, 2004-09-19 at 01:39, Dennis Bjorklund wrote:
> I think that the DATADIR part being treated as an option is confusing

I agree. Barring any objections I'll apply this patch to HEAD within 24
hours.

-Neil



Re: pg_controldata usage

From
Neil Conway
Date:
On Sun, 2004-09-19 at 01:39, Dennis Bjorklund wrote:
> I think that the DATADIR part being treated as an option is confusing

Patch applied -- thanks!

-Neil