Adjust EXPLAIN documentation, so that it's not unreasonably wide.
authorRobert Haas <[email protected]>
Sat, 9 Oct 2010 02:59:48 +0000 (22:59 -0400)
committerRobert Haas <[email protected]>
Sat, 9 Oct 2010 03:00:39 +0000 (23:00 -0400)
The new formatting matches what we do for COPY.

Per a complaint from Bruce Momjian.

doc/src/sgml/ref/explain.sgml

index f31969b81b1b4bbf1176f57789756fa13efd90f7..439f5e23fcb62fe2e87df7f527a6450ca223e323 100644 (file)
@@ -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>