aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Haas <rhaas@postgresql.org>2010-10-08 22:59:48 -0400
committerRobert Haas <rhaas@postgresql.org>2010-10-08 22:59:48 -0400
commitab6d9f16414af946083fab2347c8ccc4761fc004 (patch)
tree490c4def67462e7c67029bd74e53b6fec56b731f
parentf7dbddac69d01fb27484ad27c1d042f36f55ea12 (diff)
downloadpostgresql-ab6d9f16414af946083fab2347c8ccc4761fc004.tar.gz
postgresql-ab6d9f16414af946083fab2347c8ccc4761fc004.zip
Adjust EXPLAIN documentation, so that it's not unreasonably wide.
The new formatting matches what we do for COPY. Per a complaint from Bruce Momjian.
-rw-r--r--doc/src/sgml/ref/explain.sgml10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
index 8b98e42e33c..3d7d13c0c10 100644
--- a/doc/src/sgml/ref/explain.sgml
+++ b/doc/src/sgml/ref/explain.sgml
@@ -31,8 +31,16 @@ PostgreSQL documentation
<refsynopsisdiv>
<synopsis>
-EXPLAIN [ ( { ANALYZE <replaceable class="parameter">boolean</replaceable> | VERBOSE <replaceable class="parameter">boolean</replaceable> | COSTS <replaceable class="parameter">boolean</replaceable> | BUFFERS <replaceable class="parameter">boolean</replaceable> | FORMAT { TEXT | XML | JSON | YAML } } [, ...] ) ] <replaceable class="parameter">statement</replaceable>
+EXPLAIN [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] <replaceable class="parameter">statement</replaceable>
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
+
+<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
+
+ ANALYZE [ <replaceable class="parameter">boolean</replaceable> ]
+ VERBOSE [ <replaceable class="parameter">boolean</replaceable> ]
+ COSTS [ <replaceable class="parameter">boolean</replaceable> ]
+ BUFFERS [ <replaceable class="parameter">boolean</replaceable> ]
+ FORMAT { TEXT | XML | JSON | YAML }
</synopsis>
</refsynopsisdiv>