BUG #18952: pg_restore --help and document have strange description: Dump something

On 2025/06/10 16:35, PG Bug reporting form wrote:

The following bug has been logged on the website:

Bug reference: 18952
Logged by: TAKATSUKA Haruka
Email address: harukat@sraoss.co.jp
PostgreSQL version: 18beta1
Operating system: any
Description:

pg_restore --help has strange description like "Dump .....":
[dbhost]$ LANG=C pg_restore --help
pg_restore restores PostgreSQL databases from archives created by pg_dump or
pg_dumpall.
Usage:
pg_restore [OPTION]... [FILE]
(snip)
--with-data dump the data
--with-schema dump the schema
--with-statistics dump the statistics
Connection options:
-h, --host=HOSTNAME database server host or socket directory
(snip)
https://www.postgresql.org/docs/18/app-pgrestore.html also have the
following description.
--with-data
Dump data. This is the default.
--with-schema
Dump schema (data definitions). This is the default.
--with-statistics
Dump statistics. This is the default.

Thanks for the report!

Are you suggesting that "dump" in the help message and docs should be "restore"?
If so, does the attached patch address that correctly?

Regards,

--
Fujii Masao
NTT DATA Japan Corporation

On Wed, 11 Jun 2025 10:04:24 +0900
Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

On 2025/06/10 16:35, PG Bug reporting form wrote:

The following bug has been logged on the website:

Bug reference: 18952
Logged by: TAKATSUKA Haruka
Email address: harukat@sraoss.co.jp
PostgreSQL version: 18beta1
Operating system: any
Description:

pg_restore --help has strange description like "Dump .....":
[dbhost]$ LANG=C pg_restore --help
pg_restore restores PostgreSQL databases from archives created by pg_dump or
pg_dumpall.
Usage:
pg_restore [OPTION]... [FILE]
(snip)
--with-data dump the data
--with-schema dump the schema
--with-statistics dump the statistics
Connection options:
-h, --host=HOSTNAME database server host or socket directory
(snip)
https://www.postgresql.org/docs/18/app-pgrestore.html also have the
following description.
--with-data
Dump data. This is the default.
--with-schema
Dump schema (data definitions). This is the default.
--with-statistics
Dump statistics. This is the default.

Thanks for the report!

Are you suggesting that "dump" in the help message and docs should be "restore"?
If so, does the attached patch address that correctly?

Yes.
IMHO, if we take the intent of the commit bde2fb797aae, your patch is correct.

On 2025/06/11 11:38, TAKATSUKA Haruka wrote:

On Wed, 11 Jun 2025 10:04:24 +0900
Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

On 2025/06/10 16:35, PG Bug reporting form wrote:

The following bug has been logged on the website:

Bug reference: 18952
Logged by: TAKATSUKA Haruka
Email address: harukat@sraoss.co.jp
PostgreSQL version: 18beta1
Operating system: any
Description:

pg_restore --help has strange description like "Dump .....":
[dbhost]$ LANG=C pg_restore --help
pg_restore restores PostgreSQL databases from archives created by pg_dump or
pg_dumpall.
Usage:
pg_restore [OPTION]... [FILE]
(snip)
--with-data dump the data
--with-schema dump the schema
--with-statistics dump the statistics
Connection options:
-h, --host=HOSTNAME database server host or socket directory
(snip)
https://www.postgresql.org/docs/18/app-pgrestore.html also have the
following description.
--with-data
Dump data. This is the default.
--with-schema
Dump schema (data definitions). This is the default.
--with-statistics
Dump statistics. This is the default.

Thanks for the report!

Are you suggesting that "dump" in the help message and docs should be "restore"?
If so, does the attached patch address that correctly?

Yes.
IMHO, if we take the intent of the commit bde2fb797aae, your patch is correct.

Okay, so if there are no objections, I'll go ahead and commit the patch.

Regards,

--
Fujii Masao
NTT DATA Japan Corporation

On 12 Jun 2025, at 14:20, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

Okay, so if there are no objections, I'll go ahead and commit the patch.

Nice catch, your patch looks correct.

--
Daniel Gustafsson

On 2025/06/12 21:28, Daniel Gustafsson wrote:

On 12 Jun 2025, at 14:20, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:

Okay, so if there are no objections, I'll go ahead and commit the patch.

Nice catch, your patch looks correct.

Thanks for the review! Pushed.

Regards,

--
Fujii Masao
NTT DATA Japan Corporation