Postgres Pro
Downloads
Home   >   mailing lists

Thread: missing description initdb manual

missing description initdb manual

From
Tatsuo Ishii
Date:
Hi,

--no-locale option of initdb command is missing in the manual. The
option is in the code and even showed in the help message:

$ initdb --help
initdb initializes a PostgreSQL database cluster.

Usage: initdb [OPTION]... [DATADIR]

Options: -A, --auth=METHOD         default authentication method for local connections[-D, --pgdata=]DATADIR
locationfor this database cluster -E, --encoding=ENCODING   set default encoding for new databases     --locale=LOCALE
    set default locale for new databases     --lc-collate=, --lc-ctype=, --lc-messages=LOCALE     --lc-monetary=,
--lc-numeric=,--lc-time=LOCALE                           set default locale in the respective category for
            new databases (default taken from environment)     --no-locale           equivalent to --locale=C
 
:
:
:

So apparently the option is just missing in the manual. If there's no
objection, I will add it to the manual.
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese: http://www.sraoss.co.jp

Re: missing description initdb manual

From
Shigeru Hanada
Date:
2012/3/10 Tatsuo Ishii <ishii@postgresql.org>:
> --no-locale option of initdb command is missing in the manual. The
> option is in the code and even showed in the help message:

--text-search-config option is missing in document too.  Also pg_ctl's
long name options, such as --silent, are missing in document.

-- 
Shigeru Hanada

Re: missing description initdb manual

From
Tatsuo Ishii
Date:
> --text-search-config option is missing in document too.  Also pg_ctl's
> long name options, such as --silent, are missing in document.

Thanks for the info. I will add them as well unless someone beats me.
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese: http://www.sraoss.co.jp

Re: missing description initdb manual

From
Tatsuo Ishii
Date:
>> --text-search-config option is missing in document too.  Also pg_ctl's
>> long name options, such as --silent, are missing in document.
> 
> Thanks for the info. I will add them as well unless someone beats me.

Done.

BTW, while editing the document, I noticed that pg_ctl.c's help
message lacks some long options which are actually in the source code:
'--timeout' and '--mode'.  Included is the proposed patch to fix the
problem. If there's no objection, I would like to commit it. Comments?
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese: http://www.sraoss.co.jp
diff --git a/src/bin/pg_ctl/pg_ctl.c b/src/bin/pg_ctl/pg_ctl.c
index 8ac4fe8..99a1907 100644
--- a/src/bin/pg_ctl/pg_ctl.c
+++ b/src/bin/pg_ctl/pg_ctl.c
@@ -1764,7 +1764,7 @@ do_help(void)    printf(_("\nCommon options:\n"));    printf(_("  -D, --pgdata DATADIR   location
ofthe database storage area\n"));    printf(_("  -s, --silent           only print errors, no informational
messages\n"));
-    printf(_("  -t SECS                seconds to wait when using -w option\n"));
+    printf(_("  -t, --timeout SECS     seconds to wait when using -w option\n"));    printf(_("  -w
wait until operation completes\n"));    printf(_("  -W                     do not wait until operation completes\n"));
 printf(_("  --help                 show this help, then exit\n"));
 
@@ -1783,7 +1783,7 @@ do_help(void)     "                         (PostgreSQL server executable) or initdb\n"));
printf(_(" -p PATH-TO-POSTGRES    normally not necessary\n"));    printf(_("\nOptions for stop or restart:\n"));
 
-    printf(_("  -m SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));
+    printf(_("  -m, --mode SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));    printf(_("\nShutdown
modesare:\n"));    printf(_("  smart       quit after all clients have disconnected\n"));

Re: missing description initdb manual

From
Tom Lane
Date:
Tatsuo Ishii <ishii@postgresql.org> writes:
> BTW, while editing the document, I noticed that pg_ctl.c's help
> message lacks some long options which are actually in the source code:
> '--timeout' and '--mode'.  Included is the proposed patch to fix the
> problem. If there's no objection, I would like to commit it. Comments?

I think this line needs some more thought:

> -    printf(_("  -m SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));
> +    printf(_("  -m, --mode SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));

because it's not respecting the intended alignment of the explanation
column.  (It wasn't before, either, but that's not an excuse to not fix
it.)  I think you could make it read just "-m, --mode MODE" and then
there would be room to align this switch's explanation with the ones
above it.  I'm tempted to also say that the explanation should beMODE can be \"smart\", \"fast\", or \"immediate\"
        regards, tom lane

Re: missing description initdb manual

From
Tatsuo Ishii
Date:
> I think this line needs some more thought:
> 
>> -    printf(_("  -m SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));
>> +    printf(_("  -m, --mode SHUTDOWN-MODE   can be \"smart\", \"fast\", or \"immediate\"\n"));
> 
> because it's not respecting the intended alignment of the explanation
> column.  (It wasn't before, either, but that's not an excuse to not fix
> it.)  I think you could make it read just "-m, --mode MODE" and then
> there would be room to align this switch's explanation with the ones
> above it.  I'm tempted to also say that the explanation should be
>     MODE can be \"smart\", \"fast\", or \"immediate\"

Thanks for the suggestion. I modified the part as you suggested and
committed the changes.
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese: http://www.sraoss.co.jp