svn commit - mysqldoc@docsrva: r13790 - in trunk: . mysqldoc-guide

[paul.dubois]

Author: paul
Date: 2009-02-17 02:46:58 +0100 (Tue, 17 Feb 2009)
New Revision: 13790

Log:
 r38656@frost:  paul | 2009-02-16 19:48:47 -0500
 Document <option role="sysvar">var_name</option> auto-link markup


Modified:
   trunk/mysqldoc-guide/special-markup.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:41755
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:38635
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:36507
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:41755
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:38656
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:36507


Modified: trunk/mysqldoc-guide/special-markup.xml
===================================================================
--- trunk/mysqldoc-guide/special-markup.xml	2009-02-17 00:15:08 UTC (rev 13789)
+++ trunk/mysqldoc-guide/special-markup.xml	2009-02-17 01:46:58 UTC (rev 13790)
Changed blocks: 1, Lines Added: 18, Lines Deleted: 0; 1302 bytes

@@ -1229,6 +1229,24 @@
 &lt;option role="mysqld" condition="host"&gt;-h <replaceable>host_name</replaceable>&lt;/option&gt;
 </programlisting>
 
+    <para>
+      System variables can be passed as command-line options as well, so
+      <literal>&lt;option&gt;</literal> can be used for those. In such
+      cases, the <literal>role</literal> attribute is
+      <literal>sysvar</literal> and the option content provides the
+      variable name, possible with dashes mapped to underscores. The
+      following elements all generate links to the description for the
+      <literal>max_allowed_packet</literal> system variable, which has
+      an ID of <literal>sysvar_max_allowed_packet</literal>:
+    </para>
+
+<programlisting>
+&lt;option role="sysvar"&gt;--max_allowed_packet=1G&lt;/option&gt;
+&lt;option role="sysvar"&gt;--max-allowed-packet=1G&lt;/option&gt;
+&lt;option role="sysvar"&gt;max_allowed_packet=1G&lt;/option&gt;
+&lt;option role="sysvar"&gt;max-allowed-packet=1G&lt;/option&gt;
+</programlisting>
+
   </section>
 
 </section>