Provide some proper minimal documentation for the pg_dump(all) --binary-upgrade

option.  We don't want to commit to what it does, but hiding it will only
cause confusion.
This commit is contained in:
Peter Eisentraut 2009-03-04 11:57:00 +00:00
parent 45a10b2531
commit b966b519f5
4 changed files with 30 additions and 16 deletions

View File

@ -1,5 +1,5 @@
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.111 2009/02/26 16:02:37 petere Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.112 2009/03/04 11:57:00 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -550,6 +550,18 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--binary-upgrade</option></term>
<listitem>
<para>
This option is for use by in-place upgrade utilities. Its use
for other purposes is not recommended or supported. The
behavior of the option may change in future releases without
notice.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--disable-dollar-quoting</></term> <term><option>--disable-dollar-quoting</></term>
<listitem> <listitem>
@ -841,12 +853,6 @@ CREATE DATABASE foo WITH TEMPLATE template0;
that can be loaded into older database versions. To do this, manual that can be loaded into older database versions. To do this, manual
editing of the dump file might be required. editing of the dump file might be required.
</para> </para>
<para>
<application>pg_dump</application> also supports a
<literal>--binary-upgrade</> option for upgrade utility usage.
</para>
</refsect1> </refsect1>
<refsect1 id="pg-dump-examples"> <refsect1 id="pg-dump-examples">

View File

@ -1,5 +1,5 @@
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.77 2009/02/26 16:02:37 petere Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.78 2009/03/04 11:57:00 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -290,6 +290,18 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--binary-upgrade</option></term>
<listitem>
<para>
This option is for use by in-place upgrade utilities. Its use
for other purposes is not recommended or supported. The
behavior of the option may change in future releases without
notice.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--disable-dollar-quoting</></term> <term><option>--disable-dollar-quoting</></term>
<listitem> <listitem>
@ -503,12 +515,6 @@ PostgreSQL documentation
database creation will fail for databases in non-default database creation will fail for databases in non-default
locations. locations.
</para> </para>
<para>
<application>pg_dump</application> also supports a
<literal>--binary-upgrade</> option for upgrade utility usage.
</para>
</refsect1> </refsect1>

View File

@ -12,7 +12,7 @@
* by PostgreSQL * by PostgreSQL
* *
* IDENTIFICATION * IDENTIFICATION
* $PostgreSQL: pgsql/src/bin/pg_dump/pg_dump.c,v 1.527 2009/02/26 16:02:38 petere Exp $ * $PostgreSQL: pgsql/src/bin/pg_dump/pg_dump.c,v 1.528 2009/03/04 11:57:00 petere Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
@ -828,6 +828,7 @@ help(const char *progname)
printf(_(" -t, --table=TABLE dump the named table(s) only\n")); printf(_(" -t, --table=TABLE dump the named table(s) only\n"));
printf(_(" -T, --exclude-table=TABLE do NOT dump the named table(s)\n")); printf(_(" -T, --exclude-table=TABLE do NOT dump the named table(s)\n"));
printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n")); printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n"));
printf(_(" --binary-upgrade for use by upgrade utilities only\n"));
printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n")); printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n"));
printf(_(" --disable-triggers disable triggers during data-only restore\n")); printf(_(" --disable-triggers disable triggers during data-only restore\n"));
printf(_(" --no-tablespaces do not dump tablespace assignments\n")); printf(_(" --no-tablespaces do not dump tablespace assignments\n"));

View File

@ -6,7 +6,7 @@
* Portions Copyright (c) 1994, Regents of the University of California * Portions Copyright (c) 1994, Regents of the University of California
* *
* *
* $PostgreSQL: pgsql/src/bin/pg_dump/pg_dumpall.c,v 1.118 2009/02/26 16:02:38 petere Exp $ * $PostgreSQL: pgsql/src/bin/pg_dump/pg_dumpall.c,v 1.119 2009/03/04 11:57:00 petere Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
@ -521,6 +521,7 @@ help(void)
printf(_(" -S, --superuser=NAME superuser user name to use in the dump\n")); printf(_(" -S, --superuser=NAME superuser user name to use in the dump\n"));
printf(_(" -t, --tablespaces-only dump only tablespaces, no databases or roles\n")); printf(_(" -t, --tablespaces-only dump only tablespaces, no databases or roles\n"));
printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n")); printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n"));
printf(_(" --binary-upgrade for use by upgrade utilities only\n"));
printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n")); printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n"));
printf(_(" --disable-triggers disable triggers during data-only restore\n")); printf(_(" --disable-triggers disable triggers during data-only restore\n"));
printf(_(" --no-tablespaces do not dump tablespace assignments\n")); printf(_(" --no-tablespaces do not dump tablespace assignments\n"));