List:Commits« Previous MessageNext Message »
From:shinz Date:July 19 2006 9:47pm
Subject:svn commit - mysqldoc@docsrva: r2779 - in trunk: refman-4.1 refman-5.0 refman-5.1
View as plain text  
Author: shinz
Date: 2006-07-19 23:47:34 +0200 (Wed, 19 Jul 2006)
New Revision: 2779

Log:
Move information about example option files to Using MySQL Programs chapter (new option-files-preconfigured subsection), mentioning that on Windows files have a .ini rather than a .cnf extension (bug #21134); add links to new section from Installing and Optimization chapters

Modified:
   trunk/refman-4.1/installing.xml
   trunk/refman-4.1/optimization.xml
   trunk/refman-4.1/using-mysql-programs.xml
   trunk/refman-5.0/installing.xml
   trunk/refman-5.0/optimization.xml
   trunk/refman-5.0/using-mysql-programs.xml
   trunk/refman-5.1/installing.xml
   trunk/refman-5.1/optimization.xml
   trunk/refman-5.1/using-mysql-programs.xml


Modified: trunk/refman-4.1/installing.xml
===================================================================
--- trunk/refman-4.1/installing.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-4.1/installing.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 3, Lines Added: 6, Lines Deleted: 9; 1535 bytes

@@ -1977,7 +1977,8 @@
 
     <section id="verifying-package-integrity">
 
-      <title>Verifying Package Integrity Using MD5 Checksums or <literal>GnuPG</literal></title>
+      <title>Verifying Package Integrity Using MD5 Checksums or
+        <literal>GnuPG</literal></title>
 
       <para>
         After you have downloaded the MySQL package that suits your

@@ -4165,13 +4166,8 @@
 
       <para>
         You can also make use of the example option files included with
-        your MySQL distribution. Look in your installation directory for
-        files such as <filename>my-small.cnf</filename>,
-        <filename>my-medium.cnf</filename>,
-        <filename>my-large.cnf</filename>, and
-        <filename>my-huge.cnf</filename>, which you can rename and copy
-        to the appropriate location for use as a base configuration
-        file.
+        your MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>

@@ -18388,7 +18384,8 @@
 
     <section id="perl-support-problems">
 
-      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal> Interface</title>
+      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal>
+        Interface</title>
 
       <indexterm>
         <primary>problems</primary>


Modified: trunk/refman-4.1/optimization.xml
===================================================================
--- trunk/refman-4.1/optimization.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-4.1/optimization.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 2, Lines Added: 5, Lines Deleted: 10; 1304 bytes

@@ -2782,7 +2782,8 @@
 
     <section id="left-join-optimization">
 
-      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal> Optimization</title>
+      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal>
+        Optimization</title>
 
       <indexterm type="function">
         <primary>LEFT JOIN</primary>

@@ -7335,15 +7336,9 @@
       </para>
 
       <para>
-        When you have installed MySQL, the
-        <filename>support-files</filename> directory contains some
-        different <filename>my.cnf</filename> sample files:
-        <filename>my-huge.cnf</filename>,
-        <filename>my-large.cnf</filename>,
-        <filename>my-medium.cnf</filename>, and
-        <filename>my-small.cnf</filename>. You can use these as a basis
-        for optimizing your system. (On Windows, look in the MySQL
-        installation directory.)
+        You can make use of the example option files included with your
+        MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>


Modified: trunk/refman-4.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-4.1/using-mysql-programs.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-4.1/using-mysql-programs.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 3, Lines Added: 27, Lines Deleted: 2; 2216 bytes

@@ -701,7 +701,8 @@
         The <option>--execute</option> or <option>-e</option> option may
         also be used to pass commands in an analogous fashion to the
         <command>ndb_mgm</command> management client for MySQL Cluster.
-        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an example.
+        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
+        an example.
       </para>
 
     </section>

@@ -738,7 +739,9 @@
         provide a convenient way to specify commonly used options so
         that they need not be entered on the command line each time you
         run a program. Option file capability is available from MySQL
-        3.22 on.
+        3.22 on. For the MySQL server, MySQL provides a number of
+        <link linkend="option-files-preconfigured">preconfigured option
+        files</link>.
       </para>
 
       <para>

@@ -1357,6 +1360,28 @@
         the documentation for your preferred interface.
       </para>
 
+      <section id="option-files-preconfigured">
+
+        <title>Preconfigured Option Files</title>
+
+        <para>
+          MySQL provides a number of preconfigured option files that can
+          be used as a basis for tuning the MySQL server. Look in your
+          installation directory for files such as
+          <filename>my-small.cnf</filename>,
+          <filename>my-medium.cnf</filename>,
+          <filename>my-large.cnf</filename>, and
+          <filename>my-huge.cnf</filename>, which you can rename and
+          copy to the appropriate location for use as a base
+          configuration file. Regarding names and appropriate location,
+          see the general information provided in
+          <xref linkend="option-files"/>. On Windows, those files have a
+          <filename>.ini</filename> rather than a
+          <filename>.cnf</filename> extension.
+        </para>
+
+      </section>
+
     </section>
 
     <section id="environment-variable-options">


Modified: trunk/refman-5.0/installing.xml
===================================================================
--- trunk/refman-5.0/installing.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.0/installing.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 3, Lines Added: 6, Lines Deleted: 9; 1530 bytes

@@ -1977,7 +1977,8 @@
 
     <section id="verifying-package-integrity">
 
-      <title>Verifying Package Integrity Using MD5 Checksums or <literal>GnuPG</literal></title>
+      <title>Verifying Package Integrity Using MD5 Checksums or
+        <literal>GnuPG</literal></title>
 
       <para>
         After you have downloaded the MySQL package that suits your

@@ -4113,13 +4114,8 @@
 
       <para>
         You can also make use of the example option files included with
-        your MySQL distribution. Look in your install directory for
-        files such as <filename>my-small.cnf</filename>,
-        <filename>my-medium.cnf</filename>,
-        <filename>my-large.cnf</filename>, and
-        <filename>my-huge.cnf</filename>, which you can rename and copy
-        to the appropriate location for use as a base configuration
-        file.
+        your MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>

@@ -17711,7 +17707,8 @@
 
     <section id="perl-support-problems">
 
-      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal> Interface</title>
+      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal>
+        Interface</title>
 
       <indexterm>
         <primary>problems</primary>


Modified: trunk/refman-5.0/optimization.xml
===================================================================
--- trunk/refman-5.0/optimization.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.0/optimization.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 2, Lines Added: 5, Lines Deleted: 10; 1304 bytes

@@ -3307,7 +3307,8 @@
 
     <section id="left-join-optimization">
 
-      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal> Optimization</title>
+      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal>
+        Optimization</title>
 
       <indexterm type="function">
         <primary>LEFT JOIN</primary>

@@ -8843,15 +8844,9 @@
       </para>
 
       <para>
-        When you have installed MySQL, the
-        <filename>support-files</filename> directory contains some
-        different <filename>my.cnf</filename> sample files:
-        <filename>my-huge.cnf</filename>,
-        <filename>my-large.cnf</filename>,
-        <filename>my-medium.cnf</filename>, and
-        <filename>my-small.cnf</filename>. You can use these as a basis
-        for optimizing your system. (On Windows, look in the MySQL
-        installation directory.)
+        You can make use of the example option files included with your
+        MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>


Modified: trunk/refman-5.0/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.0/using-mysql-programs.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.0/using-mysql-programs.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 3, Lines Added: 27, Lines Deleted: 2; 2224 bytes

@@ -708,7 +708,8 @@
         The <option>--execute</option> or <option>-e</option> option may
         also be used to pass commands in an analogous fashion to the
         <command>ndb_mgm</command> management client for MySQL Cluster.
-        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an example.
+        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
+        an example.
       </para>
 
     </section>

@@ -744,7 +745,9 @@
         (also sometimes called configuration files). Option files
         provide a convenient way to specify commonly used options so
         that they need not be entered on the command line each time you
-        run a program.
+        run a program. For the MySQL server, MySQL provides a number of
+        <link linkend="option-files-preconfigured">preconfigured option
+        files</link>.
       </para>
 
       <para>

@@ -1385,6 +1388,28 @@
         the documentation for your preferred interface.
       </para>
 
+      <section id="option-files-preconfigured">
+
+        <title>Preconfigured Option Files</title>
+
+        <para>
+          MySQL provides a number of preconfigured option files that can
+          be used as a basis for tuning the MySQL server. Look in your
+          installation directory for files such as
+          <filename>my-small.cnf</filename>,
+          <filename>my-medium.cnf</filename>,
+          <filename>my-large.cnf</filename>, and
+          <filename>my-huge.cnf</filename>, which you can rename and
+          copy to the appropriate location for use as a base
+          configuration file. Regarding names and appropriate location,
+          see the general information provided in
+          <xref linkend="option-files"/>. On Windows, those files have a
+          <filename>.ini</filename> rather than a
+          <filename>.cnf</filename> extension.
+        </para>
+
+      </section>
+
     </section>
 
     <section id="environment-variable-options">


Modified: trunk/refman-5.1/installing.xml
===================================================================
--- trunk/refman-5.1/installing.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.1/installing.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 7, Lines Added: 19, Lines Deleted: 30; 3867 bytes

@@ -1973,7 +1973,8 @@
 
     <section id="verifying-package-integrity">
 
-      <title>Verifying Package Integrity Using MD5 Checksums or <literal>GnuPG</literal></title>
+      <title>Verifying Package Integrity Using MD5 Checksums or
+        <literal>GnuPG</literal></title>
 
       <para>
         After you have downloaded the MySQL package that suits your

@@ -3006,14 +3007,10 @@
         <para>
           A tree view on the left side of the custom install dialog
           lists all available components. Components that are not
-          installed have a red
-
-          <guiicon>X</guiicon>
-
-          icon; components that are installed have a gray icon. To
-          change whether a component is installed, click on that
-          component's icon and choose a new option from the drop-down
-          list that appears.
+          installed have a red <guiicon>X</guiicon> icon; components
+          that are installed have a gray icon. To change whether a
+          component is installed, click on that component's icon and
+          choose a new option from the drop-down list that appears.
         </para>
 
         <para>

@@ -4113,13 +4110,8 @@
 
       <para>
         You can also make use of the example option files included with
-        your MySQL distribution. Look in your install directory for
-        files such as <filename>my-small.cnf</filename>,
-        <filename>my-medium.cnf</filename>,
-        <filename>my-large.cnf</filename>, and
-        <filename>my-huge.cnf</filename>, which you can rename and copy
-        to the appropriate location for use as a base configuration
-        file.
+        your MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>

@@ -4616,12 +4608,9 @@
 
         <listitem>
           <para>
-            On the Windows desktop, right-click on the
-
-            <guiicon>My
-            Computer</guiicon>
-
-            icon, and select <guimenuitem>Properties</guimenuitem>
+            On the Windows desktop, right-click on the <guiicon>My
+            Computer</guiicon> icon, and select
+            <guimenuitem>Properties</guimenuitem>
           </para>
         </listitem>
 

@@ -6112,12 +6101,10 @@
       you also need to install the MySQL Startup Item. It is part of the
       Mac OS X installation disk images as a separate installation
       package. Simply double-click the
-
-      <guiicon>MySQLStartupItem.pkg</guiicon>
-
-      icon and follow the instructions to install it. The Startup Item
-      need be installed only once. There is no need to install it each
-      time you upgrade the MySQL package later.
+      <guiicon>MySQLStartupItem.pkg</guiicon> icon and follow the
+      instructions to install it. The Startup Item need be installed
+      only once. There is no need to install it each time you upgrade
+      the MySQL package later.
     </para>
 
     <para>

@@ -11740,7 +11727,8 @@
           &current-series;. For information on upgrading from MySQL
           &previous-series;, see the
           <citetitle>&title-refman-previous;</citetitle>; for earlier
-          releases, see the <citetitle>MySQL 3.23, 4.0, 4.1 Reference Manual</citetitle>.
+          releases, see the <citetitle>MySQL 3.23, 4.0, 4.1 Reference
+          Manual</citetitle>.
         </para>
       </listitem>
 

@@ -16970,7 +16958,8 @@
 
     <section id="perl-support-problems">
 
-      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal> Interface</title>
+      <title>Problems Using the Perl <literal>DBI</literal>/<literal>DBD</literal>
+        Interface</title>
 
       <indexterm>
         <primary>problems</primary>


Modified: trunk/refman-5.1/optimization.xml
===================================================================
--- trunk/refman-5.1/optimization.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.1/optimization.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 2, Lines Added: 5, Lines Deleted: 10; 1304 bytes

@@ -3329,7 +3329,8 @@
 
     <section id="left-join-optimization">
 
-      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal> Optimization</title>
+      <title><literal>LEFT JOIN</literal> and <literal>RIGHT JOIN</literal>
+        Optimization</title>
 
       <indexterm type="function">
         <primary>LEFT JOIN</primary>

@@ -8985,15 +8986,9 @@
       </para>
 
       <para>
-        When you have installed MySQL, the
-        <filename>support-files</filename> directory contains some
-        different <filename>my.cnf</filename> sample files:
-        <filename>my-huge.cnf</filename>,
-        <filename>my-large.cnf</filename>,
-        <filename>my-medium.cnf</filename>, and
-        <filename>my-small.cnf</filename>. You can use these as a basis
-        for optimizing your system. (On Windows, look in the MySQL
-        installation directory.)
+        You can make use of the example option files included with your
+        MySQL distribution; see
+        <xref linkend="option-files-preconfigured"/>.
       </para>
 
       <para>


Modified: trunk/refman-5.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.1/using-mysql-programs.xml	2006-07-19 21:13:23 UTC (rev 2778)
+++ trunk/refman-5.1/using-mysql-programs.xml	2006-07-19 21:47:34 UTC (rev 2779)
Changed blocks: 3, Lines Added: 27, Lines Deleted: 2; 2224 bytes

@@ -708,7 +708,8 @@
         The <option>--execute</option> or <option>-e</option> option may
         also be used to pass commands in an analogous fashion to the
         <command>ndb_mgm</command> management client for MySQL Cluster.
-        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an example.
+        See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
+        an example.
       </para>
 
     </section>

@@ -744,7 +745,9 @@
         (also sometimes called configuration files). Option files
         provide a convenient way to specify commonly used options so
         that they need not be entered on the command line each time you
-        run a program.
+        run a program. For the MySQL server, MySQL provides a number of
+        <link linkend="option-files-preconfigured">preconfigured option
+        files</link>.
       </para>
 
       <para>

@@ -1381,6 +1384,28 @@
         the documentation for your preferred interface.
       </para>
 
+      <section id="option-files-preconfigured">
+
+        <title>Preconfigured Option Files</title>
+
+        <para>
+          MySQL provides a number of preconfigured option files that can
+          be used as a basis for tuning the MySQL server. Look in your
+          installation directory for files such as
+          <filename>my-small.cnf</filename>,
+          <filename>my-medium.cnf</filename>,
+          <filename>my-large.cnf</filename>, and
+          <filename>my-huge.cnf</filename>, which you can rename and
+          copy to the appropriate location for use as a base
+          configuration file. Regarding names and appropriate location,
+          see the general information provided in
+          <xref linkend="option-files"/>. On Windows, those files have a
+          <filename>.ini</filename> rather than a
+          <filename>.cnf</filename> extension.
+        </para>
+
+      </section>
+
     </section>
 
     <section id="environment-variable-options">


Thread
svn commit - mysqldoc@docsrva: r2779 - in trunk: refman-4.1 refman-5.0 refman-5.1shinz19 Jul