Improve documentation of --single-transaction option: fix markup, and

don't promise more than the code actually delivers.

diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml
index 21974eb61925a3fd3ea0de8d778ab4c4b6981daa..e63c82ead2139e017852b9f5da53c5334b823b21 100644 (file)
--- a/doc/src/sgml/ref/pg_restore.sgml
+++ b/doc/src/sgml/ref/pg_restore.sgml
@@ -1,4 +1,4 @@
-
+
 
 
  
@@ -454,9 +454,11 @@
       --single-transaction
       
        
-        Force the restore to execute as a single transaction. Either all
-        SQL statements complete successfully, or no changes are applied. This
-        option also forces --exit-on-error.
+        Execute the restore as a single transaction (that is, wrap the
+        emitted commands in BEGIN/COMMIT).  This
+        ensures that either all the commands complete successfully, or no
+        changes are applied. This option implies
+        --exit-on-error.
        
       
      

diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index 52fb8fa141a0299cb37db7abb5463b83e4eac253..b264216dffe515f8fe1b1ca36acebc2f6d6892bf 100644 (file)
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -1,5 +1,5 @@
 
 
@@ -468,9 +468,13 @@ PostgreSQL documentation
       --single-transaction
       
        
-        When psql executes a script with the -f option, this additional option
-        will force the script to execute as a single transaction. Either all
-        SQL statements complete successfully, or no changes are applied. 
+        When psql executes a script with the
+        -f option, adding this option wraps
+        BEGIN/COMMIT around the script to execute it
+        as a single transaction.  This ensures that either all the commands
+        complete successfully, or no changes are applied.  (However, if the
+        script itself uses BEGIN or COMMIT, this
+        option will not have the desired effect!)