From 1715ff112809bca5218ddb6eccfda2c20dc420b5 Mon Sep 17 00:00:00 2001
From: Peter Eisentraut <peter_e@gmx.net>
Date: Thu, 3 May 2012 22:50:04 +0300
Subject: doc: Fix for too many brackets in command synopses on man pages

The default for the choice attribute of the <arg> element is "opt",
which would normally put the argument inside brackets.  But the DSSSL
stylesheets contain a hack that treats <arg> directly inside <group>
specially, so that <group><arg>-x</arg><arg>-y</arg></group> comes out
as [ -x | -y ] rather than [ [-x] | [-y] ], which it would technically
be.  But when building man pages, this doesn't work, and so the
command synopses on the man pages contain lots of extra brackets.

By putting choice="opt" or choice="plain" explicitly on every <arg>
and <group> element, we avoid any toolchain dependencies like that,
and it also makes it clearer in the source code what is meant.

In passing, make some small corrections in the documentation about
which arguments are really optional or not.
---
 doc/src/sgml/sql.sgml | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'doc/src/sgml/sql.sgml')

diff --git a/doc/src/sgml/sql.sgml b/doc/src/sgml/sql.sgml
index c19e8232baa..ba92607966c 100644
--- a/doc/src/sgml/sql.sgml
+++ b/doc/src/sgml/sql.sgml
@@ -1103,7 +1103,7 @@ SELECT sname, pname from supplier
             <arg choice="opt"> NATURAL </arg>
             <group choice="opt">
                 <arg choice="opt"> INNER </arg>
-                <arg>
+                <arg choice="plain">
                 <group choice="req">
                     <arg choice="plain"> LEFT </arg>
                     <arg choice="plain"> RIGHT </arg>
@@ -1115,8 +1115,8 @@ SELECT sname, pname from supplier
             <command> JOIN </command>
             <arg choice="req"> <replaceable class="parameter">T2</replaceable> </arg>
             <group choice="req">
-                <arg> ON <replaceable>search condition</replaceable></arg>
-                <arg> USING ( <replaceable>join column list</replaceable> ) </arg>
+                <arg choice="plain"> ON <replaceable>search condition</replaceable></arg>
+                <arg choice="plain"> USING ( <replaceable>join column list</replaceable> ) </arg>
             </group>
             </cmdsynopsis>
 
@@ -1141,7 +1141,7 @@ SELECT sname, pname from supplier
             <varlistentry>
                 <term>
                     <cmdsynopsis>
-                        <arg> INNER </arg>
+                        <arg choice="opt"> INNER </arg>
                         <command> JOIN </command>
                     </cmdsynopsis>
                 </term>
@@ -1163,7 +1163,7 @@ SELECT sname, pname from supplier
                 <term>
                     <cmdsynopsis>
                         <arg choice="plain"> LEFT </arg>
-                        <arg> OUTER </arg>
+                        <arg choice="opt"> OUTER </arg>
                         <command> JOIN </command>
                     </cmdsynopsis>
                 </term>
@@ -1185,7 +1185,7 @@ SELECT sname, pname from supplier
                 <term>
                     <cmdsynopsis>
                         <arg choice="plain"> RIGHT </arg>
-                        <arg> OUTER </arg>
+                        <arg choice="opt"> OUTER </arg>
                         <command> JOIN </command>
                     </cmdsynopsis>
                 </term>
@@ -1207,7 +1207,7 @@ SELECT sname, pname from supplier
                 <term>
                     <cmdsynopsis>
                         <arg choice="plain"> FULL </arg>
-                        <arg> OUTER </arg>
+                        <arg choice="opt"> OUTER </arg>
                         <command> JOIN </command>
                     </cmdsynopsis>
                 </term>
-- 
cgit v1.2.3