pgsql: doc: Fix for too many brackets in command synopses on man pages - Mailing list pgsql-committers

From Peter Eisentraut
Subject pgsql: doc: Fix for too many brackets in command synopses on man pages
Date
Msg-id E1SQ2BE-0003Di-7I@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
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.

Branch
------
master

Details
-------
http://git.postgresql.org/pg/commitdiff/1715ff112809bca5218ddb6eccfda2c20dc420b5

Modified Files
--------------
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(-)


pgsql-committers by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: pgsql: Remove dead ports
Next
From: hinoue@pgfoundry.org (User Hinoue)
Date:
Subject: psqlodbc - psqlodbc: Use int instead of size_t when condition >=0 is