Doc: clarify behavior of back-half options in pg_dump.
authorTom Lane
Wed, 13 Jan 2021 18:30:04 +0000 (13:30 -0500)
committerTom Lane
Wed, 13 Jan 2021 18:30:04 +0000 (13:30 -0500)
Options that change how the archive data is converted to SQL text
are ignored when dumping to archive formats.  The documentation
previously said "not meaningful", which is not helpful.

Discussion: https://postgr.es/m/161052021249.12228.9598689907884726185@wrigleys.postgresql.org

doc/src/sgml/ref/pg_dump.sgml

index bfe55ceb7b4fa733d6422005bb31ac80c75b21a2..8dd126c2e43c00bb07579c9e65348c625742beb9 100644 (file)
@@ -178,8 +178,8 @@ PostgreSQL documentation
        
 
        
-        This option is only meaningful for the plain-text format.  For
-        the archive formats, you can specify the option when you
+        This option is ignored when emitting an archive (non-text) output
+        file.  For the archive formats, you can specify the option when you
         call pg_restore.
        
       
@@ -210,8 +210,8 @@ PostgreSQL documentation
        
 
        
-        This option is only meaningful for the plain-text format.  For
-        the archive formats, you can specify the option when you
+        This option is ignored when emitting an archive (non-text) output
+        file.  For the archive formats, you can specify the option when you
         call pg_restore.
        
       
@@ -457,8 +457,8 @@ PostgreSQL documentation
        
 
        
-        This option is only meaningful for the plain-text format.  For
-        the archive formats, you can specify the option when you
+        This option is ignored when emitting an archive (non-text) output
+        file.  For the archive formats, you can specify the option when you
         call pg_restore.
        
       
@@ -698,8 +698,8 @@ PostgreSQL documentation
        
 
        
-        This option is only meaningful for the plain-text format.  For
-        the archive formats, you can specify the option when you
+        This option is ignored when emitting an archive (non-text) output
+        file.  For the archive formats, you can specify the option when you
         call pg_restore.
        
       
@@ -899,8 +899,8 @@ PostgreSQL documentation
        
 
        
-        This option is only meaningful for the plain-text format.  For
-        the archive formats, you can specify the option when you
+        This option is ignored when emitting an archive (non-text) output
+        file.  For the archive formats, you can specify the option when you
         call pg_restore.