Skip to content
Snippets Groups Projects
Select Git revision
  • benchmark-tools
  • postgres-lambda
  • master default
  • REL9_4_25
  • REL9_5_20
  • REL9_6_16
  • REL_10_11
  • REL_11_6
  • REL_12_1
  • REL_12_0
  • REL_12_RC1
  • REL_12_BETA4
  • REL9_4_24
  • REL9_5_19
  • REL9_6_15
  • REL_10_10
  • REL_11_5
  • REL_12_BETA3
  • REL9_4_23
  • REL9_5_18
  • REL9_6_14
  • REL_10_9
  • REL_11_4
23 results

sql.sgml

Blame
    • Peter Eisentraut's avatar
      1715ff11
      doc: Fix for too many brackets in command synopses on man pages · 1715ff11
      Peter Eisentraut authored
      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.
      1715ff11
      History
      doc: Fix for too many brackets in command synopses on man pages
      Peter Eisentraut authored
      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.