pg_restore --clean text

Started by Erik Rijkersabout 17 years ago4 messages
#1Erik Rijkers
er@xs4all.nl

The help text for the pg_restore --clean option in the documentation is IMHO more precise than the
text that the pg_restore binary gives:

documentation:
-c
--clean
Clean (drop) database objects before recreating them.

pg_restore binary:
-c, --clean clean (drop) schema prior to create

So I think it would be an improvement to channge the pg_restore --help text:

*** src/bin/pg_dump/pg_restore.c.orig   2008-12-27 01:16:23.000000000 +0100
--- src/bin/pg_dump/pg_restore.c        2008-12-27 01:29:53.000000000 +0100
***************
*** 385,391 ****
        printf(_("\nOptions controlling the restore:\n"));
        printf(_("  -a, --data-only          restore only the data, no schema\n"));
!       printf(_("  -c, --clean              clean (drop) schema prior to create\n"));
        printf(_("  -C, --create             create the target database\n"));
        printf(_("  -I, --index=NAME         restore named index\n"));
        printf(_("  -L, --use-list=FILENAME  use specified table of contents for ordering\n"
--- 385,391 ----

printf(_("\nOptions controlling the restore:\n"));
printf(_(" -a, --data-only restore only the data, no schema\n"));
! printf(_(" -c, --clean clean (drop) database objects prior to creating
them\n"));
printf(_(" -C, --create create the target database\n"));
printf(_(" -I, --index=NAME restore named index\n"));
printf(_(" -L, --use-list=FILENAME use specified table of contents for ordering\n"

thanks,

Erik Rijkers

#2Bruce Momjian
bruce@momjian.us
In reply to: Erik Rijkers (#1)
1 attachment(s)
Re: pg_restore --clean text

Erik Rijkers wrote:

The help text for the pg_restore --clean option in the documentation is IMHO more precise than the
text that the pg_restore binary gives:

documentation:
-c
--clean
Clean (drop) database objects before recreating them.

pg_restore binary:
-c, --clean clean (drop) schema prior to create

So I think it would be an improvement to channge the pg_restore --help text:

I used the wording from the pg_restore SGML manual page in the --help
text, to be more consistent. Thanks for the report.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ If your life is a hard drive, Christ can be your backup. +

Attachments:

/rtmp/difftext/x-diffDownload
Index: src/bin/pg_dump/pg_restore.c
===================================================================
RCS file: /cvsroot/pgsql/src/bin/pg_dump/pg_restore.c,v
retrieving revision 1.90
diff -c -c -r1.90 pg_restore.c
*** src/bin/pg_dump/pg_restore.c	5 Jan 2009 16:54:37 -0000	1.90
--- src/bin/pg_dump/pg_restore.c	6 Jan 2009 17:17:10 -0000
***************
*** 391,397 ****
  
  	printf(_("\nOptions controlling the restore:\n"));
  	printf(_("  -a, --data-only          restore only the data, no schema\n"));
! 	printf(_("  -c, --clean              clean (drop) schema prior to create\n"));
  	printf(_("  -C, --create             create the target database\n"));
  	printf(_("  -I, --index=NAME         restore named index\n"));
  	printf(_("  -L, --use-list=FILENAME  use specified table of contents for ordering\n"
--- 391,397 ----
  
  	printf(_("\nOptions controlling the restore:\n"));
  	printf(_("  -a, --data-only          restore only the data, no schema\n"));
! 	printf(_("  -c, --clean              clean (drop) database objects before recreating\n"));
  	printf(_("  -C, --create             create the target database\n"));
  	printf(_("  -I, --index=NAME         restore named index\n"));
  	printf(_("  -L, --use-list=FILENAME  use specified table of contents for ordering\n"
#3Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#2)
Re: pg_restore --clean text

Bruce Momjian <bruce@momjian.us> writes:

I used the wording from the pg_restore SGML manual page in the --help
text, to be more consistent. Thanks for the report.

pg_dump has the same wording. pg_dumpall might need adjustment too,
though I'm not sure (note its --clean acts on DBs not individual
objects)

regards, tom lane

#4Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#3)
1 attachment(s)
Re: pg_restore --clean text

Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

I used the wording from the pg_restore SGML manual page in the --help
text, to be more consistent. Thanks for the report.

pg_dump has the same wording. pg_dumpall might need adjustment too,
though I'm not sure (note its --clean acts on DBs not individual
objects)

OK, done with attached patch.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ If your life is a hard drive, Christ can be your backup. +

Attachments:

/rtmp/difftext/x-diffDownload
Index: src/bin/pg_dump/pg_dump.c
===================================================================
RCS file: /cvsroot/pgsql/src/bin/pg_dump/pg_dump.c,v
retrieving revision 1.512
diff -c -c -r1.512 pg_dump.c
*** src/bin/pg_dump/pg_dump.c	5 Jan 2009 16:54:37 -0000	1.512
--- src/bin/pg_dump/pg_dump.c	6 Jan 2009 18:01:06 -0000
***************
*** 803,809 ****
  	printf(_("\nOptions controlling the output content:\n"));
  	printf(_("  -a, --data-only             dump only the data, not the schema\n"));
  	printf(_("  -b, --blobs                 include large objects in dump\n"));
! 	printf(_("  -c, --clean                 clean (drop) schema prior to create\n"));
  	printf(_("  -C, --create                include commands to create database in dump\n"));
  	printf(_("  -d, --inserts               dump data as INSERT commands, rather than COPY\n"));
  	printf(_("  -D, --column-inserts        dump data as INSERT commands with column names\n"));
--- 803,809 ----
  	printf(_("\nOptions controlling the output content:\n"));
  	printf(_("  -a, --data-only             dump only the data, not the schema\n"));
  	printf(_("  -b, --blobs                 include large objects in dump\n"));
! 	printf(_("  -c, --clean                 clean (drop) database objects before recreating\n"));
  	printf(_("  -C, --create                include commands to create database in dump\n"));
  	printf(_("  -d, --inserts               dump data as INSERT commands, rather than COPY\n"));
  	printf(_("  -D, --column-inserts        dump data as INSERT commands with column names\n"));
Index: src/bin/pg_dump/pg_dumpall.c
===================================================================
RCS file: /cvsroot/pgsql/src/bin/pg_dump/pg_dumpall.c,v
retrieving revision 1.111
diff -c -c -r1.111 pg_dumpall.c
*** src/bin/pg_dump/pg_dumpall.c	5 Jan 2009 16:54:37 -0000	1.111
--- src/bin/pg_dump/pg_dumpall.c	6 Jan 2009 18:01:07 -0000
***************
*** 500,506 ****
  			 "                           fail after waiting TIMEOUT for a table lock\n"));
  	printf(_("\nOptions controlling the output content:\n"));
  	printf(_("  -a, --data-only          dump only the data, not the schema\n"));
! 	printf(_("  -c, --clean              clean (drop) databases prior to create\n"));
  	printf(_("  -d, --inserts            dump data as INSERT, rather than COPY, commands\n"));
  	printf(_("  -D, --column-inserts     dump data as INSERT commands with column names\n"));
  	printf(_("  -g, --globals-only       dump only global objects, no databases\n"));
--- 500,506 ----
  			 "                           fail after waiting TIMEOUT for a table lock\n"));
  	printf(_("\nOptions controlling the output content:\n"));
  	printf(_("  -a, --data-only          dump only the data, not the schema\n"));
! 	printf(_("  -c, --clean              clean (drop) databases before recreating\n"));
  	printf(_("  -d, --inserts            dump data as INSERT, rather than COPY, commands\n"));
  	printf(_("  -D, --column-inserts     dump data as INSERT commands with column names\n"));
  	printf(_("  -g, --globals-only       dump only global objects, no databases\n"));