]> granicus.if.org Git - postgresql/commit
doc: Fix for too many brackets in command synopses on man pages
authorPeter Eisentraut <peter_e@gmx.net>
Thu, 3 May 2012 19:50:04 +0000 (22:50 +0300)
committerPeter Eisentraut <peter_e@gmx.net>
Thu, 3 May 2012 19:58:00 +0000 (22:58 +0300)
commit1715ff112809bca5218ddb6eccfda2c20dc420b5
treeaf19faa1d5bc727fb90b27e55b7c3c452f556570
parentebcaa5fcde8411786e3765414465174e6d31c8e6
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.
16 files changed:
doc/src/sgml/ref/clusterdb.sgml
doc/src/sgml/ref/createdb.sgml
doc/src/sgml/ref/createlang.sgml
doc/src/sgml/ref/createuser.sgml
doc/src/sgml/ref/droplang.sgml
doc/src/sgml/ref/dropuser.sgml
doc/src/sgml/ref/initdb.sgml
doc/src/sgml/ref/pg_controldata.sgml
doc/src/sgml/ref/pg_ctl-ref.sgml
doc/src/sgml/ref/pg_dump.sgml
doc/src/sgml/ref/pg_resetxlog.sgml
doc/src/sgml/ref/pg_restore.sgml
doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/ref/reindexdb.sgml
doc/src/sgml/ref/vacuumdb.sgml
doc/src/sgml/sql.sgml