missing description initdb manual

Started by Tatsuo Ishiiabout 14 years ago6 messageshackers
Jump to latest
#1Tatsuo Ishii
t-ishii@sra.co.jp

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 location for 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

#2Shigeru Hanada
shigeru.hanada@gmail.com
In reply to: Tatsuo Ishii (#1)
Re: missing description initdb manual

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

#3Tatsuo Ishii
t-ishii@sra.co.jp
In reply to: Shigeru Hanada (#2)
Re: missing description initdb manual

--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

#4Tatsuo Ishii
t-ishii@sra.co.jp
In reply to: Tatsuo Ishii (#3)
Re: missing description initdb manual

--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

Attachments:

pg_ctl.patchtext/x-patch; charset=us-asciiDownload+2-2
#5Tom Lane
tgl@sss.pgh.pa.us
In reply to: Tatsuo Ishii (#4)
Re: missing description initdb manual

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 be
MODE can be \"smart\", \"fast\", or \"immediate\"

regards, tom lane

#6Tatsuo Ishii
t-ishii@sra.co.jp
In reply to: Tom Lane (#5)
Re: missing description initdb manual

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