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.

diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml
index 04242c7030bcc5f731f2a22ec747ac66521433a3..b4b7ebb627f8aff30c717625ddce470a409f4d72 100644 (file)
--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
@@ -550,6 +550,18 @@ PostgreSQL documentation
       </listitem>
      </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>
       <term><option>--disable-dollar-quoting</></term>
       <listitem>
@@ -841,12 +853,6 @@ CREATE DATABASE foo WITH TEMPLATE template0;
    that can be loaded into older database versions.  To do this, manual
    editing of the dump file might be required.
   </para>
-
-  <para>
-   <application>pg_dump</application> also supports a
-   <literal>--binary-upgrade</> option for upgrade utility usage.
-  </para>
-
  </refsect1>
 
  <refsect1 id="pg-dump-examples">

diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml
index 53d0be1b19e4a42d3ceaefdc2970a36480c5036c..62d8dc66367983eec21d9f1c1eebf668d9e76519 100644 (file)
--- a/doc/src/sgml/ref/pg_dumpall.sgml
+++ b/doc/src/sgml/ref/pg_dumpall.sgml
@@ -290,6 +290,18 @@ PostgreSQL documentation
       </listitem>
      </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>
       <term><option>--disable-dollar-quoting</></term>
       <listitem>
@@ -503,12 +515,6 @@ PostgreSQL documentation
    database creation will fail for databases in non-default
    locations.
   </para>
-
-  <para>
-   <application>pg_dump</application> also supports a
-   <literal>--binary-upgrade</> option for upgrade utility usage.
-  </para>
-
  </refsect1>
 
 

diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c
index cbc54b9e95a49fec0c47970bad1f31053f306d6d..99e5b8848859edcf7cfa5f8f00a47ef101bc619d 100644 (file)
--- a/src/bin/pg_dump/pg_dump.c
+++ b/src/bin/pg_dump/pg_dump.c
@@ -828,6 +828,7 @@ help(const char *progname)
        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(_("  -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-triggers          disable triggers during data-only restore\n"));
        printf(_("  --no-tablespaces            do not dump tablespace assignments\n"));

diff --git a/src/bin/pg_dump/pg_dumpall.c b/src/bin/pg_dump/pg_dumpall.c
index 2f8b2c3ac0526d549dbeaafde199c63e59a91b76..e3f26c69a33eb3bc714558ddd163da7414ca5311 100644 (file)
--- a/src/bin/pg_dump/pg_dumpall.c
+++ b/src/bin/pg_dump/pg_dumpall.c
@@ -521,6 +521,7 @@ help(void)
        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(_("  -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-triggers          disable triggers during data-only restore\n"));
        printf(_("  --no-tablespaces            do not dump tablespace assignments\n"));