From 1715ff112809bca5218ddb6eccfda2c20dc420b5 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Thu, 3 May 2012 22:50:04 +0300 Subject: [PATCH] doc: Fix for too many brackets in command synopses on man pages The default for the choice attribute of the element is "opt", which would normally put the argument inside brackets. But the DSSSL stylesheets contain a hack that treats directly inside specially, so that -x-y 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 and 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/ref/clusterdb.sgml | 10 +-- doc/src/sgml/ref/createdb.sgml | 4 +- doc/src/sgml/ref/createlang.sgml | 6 +- doc/src/sgml/ref/createuser.sgml | 2 +- doc/src/sgml/ref/droplang.sgml | 6 +- doc/src/sgml/ref/dropuser.sgml | 2 +- doc/src/sgml/ref/initdb.sgml | 4 +- doc/src/sgml/ref/pg_controldata.sgml | 4 +- doc/src/sgml/ref/pg_ctl-ref.sgml | 92 ++++++++++++++-------------- doc/src/sgml/ref/pg_dump.sgml | 2 +- doc/src/sgml/ref/pg_resetxlog.sgml | 16 ++--- doc/src/sgml/ref/pg_restore.sgml | 2 +- doc/src/sgml/ref/psql-ref.sgml | 4 +- doc/src/sgml/ref/reindexdb.sgml | 20 +++--- doc/src/sgml/ref/vacuumdb.sgml | 14 ++--- doc/src/sgml/sql.sgml | 14 ++--- 16 files changed, 101 insertions(+), 101 deletions(-) diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index e0246b3bca2..097ea912f1c 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -23,16 +23,16 @@ PostgreSQL documentation clusterdb connection-option - - table - dbname + + table + dbname clusterdb connection-option - - + + diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index cbbc5c05455..7dbedc2e909 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -24,8 +24,8 @@ PostgreSQL documentation createdb connection-option option - dbname - description + dbname + description diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index 4ca32fba39a..2bc43627e54 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -24,14 +24,14 @@ PostgreSQL documentation createlang connection-option langname - dbname + dbname createlang connection-option - - dbname + + dbname diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index 9942cd66f61..dedc97f2233 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -24,7 +24,7 @@ PostgreSQL documentation createuser connection-option option - username + username diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 2bfdbfe8885..81b954a68f0 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -24,14 +24,14 @@ PostgreSQL documentation droplang connection-option langname - dbname + dbname droplang connection-option - - dbname + + dbname diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index bc6feafe9f2..891bbd60371 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -24,7 +24,7 @@ PostgreSQL documentation dropuser connection-option option - username + username diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 092df33d100..89f392eaeb0 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -25,8 +25,8 @@ PostgreSQL documentation option - - + + directory diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml index d39b6e18f88..7926acb9180 100644 --- a/doc/src/sgml/ref/pg_controldata.sgml +++ b/doc/src/sgml/ref/pg_controldata.sgml @@ -22,8 +22,8 @@ PostgreSQL documentation pg_controldata - option - datadir + option + datadir diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index fcc34ecb967..1409e0c44e4 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -23,36 +23,36 @@ PostgreSQL documentation pg_ctl - - datadir - initdb-options + + datadir + initdb-options pg_ctl - - seconds - - datadir - filename - options - path - + + seconds + + datadir + filename + options + path + pg_ctl - - seconds - - datadir - + + seconds + + datadir + - - - + + + @@ -60,39 +60,39 @@ PostgreSQL documentation pg_ctl - - seconds - - datadir - - + + seconds + + datadir + + - - - + + + - options + options pg_ctl - - datadir + + datadir pg_ctl - datadir + datadir pg_ctl - - datadir + + datadir @@ -105,26 +105,26 @@ PostgreSQL documentation pg_ctl - servicename - username - password - datadir - + servicename + username + password + datadir + - - + + - - seconds - - options + + seconds + + options pg_ctl - servicename + servicename diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 6b315009ff7..a5e53043267 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -27,7 +27,7 @@ PostgreSQL documentation pg_dump connection-option option - dbname + dbname diff --git a/doc/src/sgml/ref/pg_resetxlog.sgml b/doc/src/sgml/ref/pg_resetxlog.sgml index 3a7dfb3c73e..fe67a3d1f20 100644 --- a/doc/src/sgml/ref/pg_resetxlog.sgml +++ b/doc/src/sgml/ref/pg_resetxlog.sgml @@ -22,14 +22,14 @@ PostgreSQL documentation pg_resetxlog - - - oid - xid - xid_epoch - mxid - mxoff - timelineid,fileid,seg + + + oid + xid + xid_epoch + mxid + mxoff + timelineid,fileid,seg datadir diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 6c3326668ff..47e972223e6 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -25,7 +25,7 @@ pg_restore connection-option option - filename + filename diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index bdcadf36928..487df746176 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -25,8 +25,8 @@ PostgreSQL documentation psql option - dbname - username + dbname + username diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml index 526fd768178..7b2f72d04f8 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -25,27 +25,27 @@ PostgreSQL documentation connection-option - - + + table - - + + index - dbname + dbname reindexdb connection-option - - + + @@ -53,10 +53,10 @@ PostgreSQL documentation reindexdb connection-option - - + + - dbname + dbname diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index c008611a5af..c60ba4424fe 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -24,15 +24,15 @@ PostgreSQL documentation vacuumdb connection-option option - + - - + + table - ( column [,...] ) + ( column [,...] ) - dbname + dbname @@ -40,8 +40,8 @@ PostgreSQL documentation connection-option option - - + + 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 NATURAL INNER - + LEFT RIGHT @@ -1115,8 +1115,8 @@ SELECT sname, pname from supplier JOIN T2 - ON search condition - USING ( join column list ) + ON search condition + USING ( join column list ) @@ -1141,7 +1141,7 @@ SELECT sname, pname from supplier - INNER + INNER JOIN @@ -1163,7 +1163,7 @@ SELECT sname, pname from supplier LEFT - OUTER + OUTER JOIN @@ -1185,7 +1185,7 @@ SELECT sname, pname from supplier RIGHT - OUTER + OUTER JOIN @@ -1207,7 +1207,7 @@ SELECT sname, pname from supplier FULL - OUTER + OUTER JOIN