List:Internals« Previous MessageNext Message »
From:mhillyer Date:June 1 2005 7:06pm
Subject:bk commit - mysqldoc@docsrva tree (Mike.Hillyer:1.2729)
View as plain text  
Below is the list of changes that have just been committed into a local
mysqldoc repository of root. When root does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html

ChangeSet
  1.2729 05/06/01 13:06:31 Mike.Hillyer@stripped +2 -0
  Updates and fixes to the refman and query browser docs.

  query-browser/query-browser.xml
    1.10 05/06/01 13:06:29 Mike.Hillyer@stripped +107 -202
    Cleaned up formatting, updated some outdated information.

  Docs/manual.texi
    1.2948 05/06/01 13:06:28 Mike.Hillyer@stripped +3 -12
    Additional tweaking of known issue section headers.

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	Mike.Hillyer
# Host:	www.openwin.org
# Root:	/home/mysqldoc/mysqldoc2

--- 1.9/query-browser/query-browser.xml	2005-05-29 21:20:57 -06:00
+++ 1.10/query-browser/query-browser.xml	2005-06-01 13:06:29 -06:00
@@ -24,15 +24,11 @@
 is no point in generating an empty index.
 -->
 
- <title>
-  &query_browser;
- </title>
+ <title>&query_browser;</title>
 
  <bookinfo>
 
-  <title>
-   &query_browser;
-  </title>
+  <title>&query_browser;</title>
 
   <copyright>
 
@@ -77,9 +73,7 @@
 
  <chapter id="mysql-query-browser-introduction">
 
-  <title>
-   Introduction to the &query_browser;
-  </title>
+  <title>Introduction to the &query_browser;</title>
 
   <para>
    The &query_browser; is a graphical tool provided by MySQL AB for
@@ -120,15 +114,11 @@
 
  <chapter id="mysql-query-browser-installation">
 
-  <title>
-   Installing &query_browser;
-  </title>
+  <title>Installing &query_browser;</title>
 
   <sect1 id="mysql-query-browser-installation-introduction">
 
-   <title>
-    Introduction
-   </title>
+   <title>Introduction</title>
 
    <para>
     The &query_browser; is available for both Windows and Linux, in
@@ -144,9 +134,7 @@
 
   <sect1 id="mysql-query-browser-installation-windows">
 
-   <title>
-    Installing Under Windows
-   </title>
+   <title>Installing Under Windows</title>
 
    <para>
     &query_browser; runs on recent 32-bit Windows NT based operating
@@ -192,10 +180,11 @@
 
    <para>
     Unless you choose otherwise, &query_browser; is installed in
-    <literal>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\&query_browser; 1.1\MySQLQueryBrowser.exe</literal>,
-    where <replaceable>%PROGRAMFILES%</replaceable> is the default
-    directory for programs on your machine. For example, this directory
-    might be <literal>C:\Program Files</literal> or
+    <literal>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\&query_browser;
+    1.1\MySQLQueryBrowser.exe</literal>, where
+    <replaceable>%PROGRAMFILES%</replaceable> is the default directory
+    for programs on your machine. For example, this directory might be
+    <literal>C:\Program Files</literal> or
     <literal>C:\programme</literal>.
    </para>
 
@@ -205,9 +194,7 @@
 
   <sect1 id="mysql-query-browser-installation-linux">
 
-   <title>
-    Installing Under Linux
-   </title>
+   <title>Installing Under Linux</title>
 
    <para>
     &query_browser; runs on Linux machines that have a graphical desktop
@@ -253,7 +240,8 @@
    </para>
 
    <para>
-    Distribution-specific packages are available for Redhat Linux 9 (x86) and Suse Linux 9.1 (x86).
+    Distribution-specific packages are available for Redhat Linux 9
+    (x86) and Suse Linux 9.1 (x86).
    </para>
 
   </sect1>
@@ -266,15 +254,11 @@
 
  <chapter id="mysql-query-browser-starting">
 
-  <title>
-   Starting &query_browser;
-  </title>
+  <title>Starting &query_browser;</title>
 
   <sect1 id="mysql-query-browser-starting-introduction">
 
-   <title>
-    Introduction
-   </title>
+   <title>Introduction</title>
 
    <para>
     The way you start &query_browser; depends on the operating system
@@ -324,9 +308,7 @@
 
   <sect1 id="mysql-query-browser-starting-connection">
 
-   <title>
-    Connection Dialog
-   </title>
+   <title>Connection Dialog</title>
 
    <para>
     Once &query_browser; has been started, it displays a connection
@@ -345,9 +327,7 @@
    </para>
 
    <figure>
-    <title>
-     Connection dialog
-    </title>
+    <title>Connection dialog</title>
     <graphic fileref="images/connection.png" format="PNG" lang="en" />
    </figure>
 
@@ -399,15 +379,11 @@
 
  <chapter id="mysql-query-browser-tour">
 
-  <title>
-   A Tour of the &query_browser;
-  </title>
+  <title>A Tour of the &query_browser;</title>
 
   <sect1 id="mysql-query-browser-tour-mainwindow">
 
-   <title>
-    The Main Query Window
-   </title>
+   <title>The Main Query Window</title>
 
    <para>
     Once you successfully connect to a MySQL server you are presented
@@ -416,9 +392,7 @@
    </para>
 
    <figure>
-    <title>
-     The &query_browser; main query window
-    </title>
+    <title>The &query_browser; main query window</title>
     <graphic fileref="images/mainscreen.png" lang="en" format="PNG"/>
    </figure>
 
@@ -496,9 +470,7 @@
 
   <sect1 id="mysql-query-browser-tour-querybar">
 
-   <title>
-    The Query Toolbar
-   </title>
+   <title>The Query Toolbar</title>
 
    <para>
     All queries, whether generated automatically, graphically, or
@@ -510,9 +482,7 @@
 
    <sect2 id="mysql-query-browser-tour-querybar-navigation">
 
-    <title>
-     The Navigation Buttons
-    </title>
+    <title>The Navigation Buttons</title>
 
     <para>
      To the left of the query area are the navigation buttons. The
@@ -545,9 +515,7 @@
 
    <sect2 id="mysql-query-browser-tour-querybar-queryarea">
 
-    <title>
-     The Query Area
-    </title>
+    <title>The Query Area</title>
 
     <para>
      The query area is where the text of all queries and statements are
@@ -568,9 +536,7 @@
     </para>
 
     <figure>
-     <title>
-      The query area expanded to ten lines
-     </title>
+     <title>The query area expanded to ten lines</title>
      <graphic fileref="images/querybar.png" lang="en" format="PNG"/>
     </figure>
 
@@ -596,9 +562,7 @@
 
    <sect2 id="mysql-query-browser-tour-querybar-actionbuttons">
 
-    <title>
-     The Action Buttons
-    </title>
+    <title>The Action Buttons</title>
 
     <para>
      To the right of the query area are the action buttons. The
@@ -647,9 +611,7 @@
     </para>
 
     <figure>
-     <title>
-      The &query_browser; status icons
-     </title>
+     <title>The &query_browser; status icons</title>
      <graphic fileref="images/twosakilas.png" lang="en" format="PNG"/>
     </figure>
 
@@ -663,9 +625,7 @@
 
   <sect1 id="mysql-query-browser-tour-buttonbar">
 
-   <title>
-    The Advanced Toolbar
-   </title>
+   <title>The Advanced Toolbar</title>
 
    <para>
     Below the query bar is the <literal>Advanced Toolbar</literal>. The
@@ -674,9 +634,7 @@
    </para>
 
    <figure>
-    <title>
-     The advanced toolbar
-    </title>
+    <title>The advanced toolbar</title>
     <graphic fileref="images/buttonbar.png" lang="en" format="PNG"/>
    </figure>
 
@@ -721,9 +679,7 @@
 
   <sect1 id="mysql-query-browser-tour-resultarea">
 
-   <title>
-    The Result Area
-   </title>
+   <title>The Result Area</title>
 
    <para>
     All query results are displayed in the result area. Within the
@@ -788,9 +744,7 @@
 
   <sect1 id="mysql-query-browser-tour-objectbrowser">
 
-   <title>
-    The Object Browser
-   </title>
+   <title>The Object Browser</title>
 
    <para>
     The object browser allows you to browse your server's databases,
@@ -799,9 +753,7 @@
 
    <sect2 id="mysql-query-browser-tour-objectbrowser-schemata">
 
-    <title>
-     The Database Browser
-    </title>
+    <title>The Database Browser</title>
 
     <para>
      The database (schemata) browser is the primary screen of the object
@@ -813,9 +765,7 @@
     </para>
 
     <figure>
-     <title>
-      The database browser
-     </title>
+     <title>The database browser</title>
      <graphic 
 fileref="images/schematabrowser.png" lang="en" format="PNG"/>
     </figure>
@@ -889,9 +839,7 @@
 
    <sect2 id="mysql-query-browser-tour-objectbrowser-bookmarks">
 
-    <title>
-     The Bookmark Browser
-    </title>
+    <title>The Bookmark Browser</title>
 
     <para>
      You can place your more commonly used queries in bookmarks so that
@@ -918,9 +866,7 @@
 
    <sect2 id="mysql-query-browser-tour-objectbrowser-history">
 
-    <title>
-     The History Browser
-    </title>
+    <title>The History Browser</title>
 
     <para>
      With the history browser you can browse through all the queries you
@@ -952,9 +898,7 @@
 
   <sect1 id="mysql-query-browser-tour-pandf">
 
-   <title>
-    The Information Browser
-   </title>
+   <title>The Information Browser</title>
 
    <para>
     The Information Browser provides access to all information that is
@@ -969,15 +913,13 @@
 
    <sect2 id="mysql-query-browser-tour-pandf-parameterbrowser">
 
-    <title>
-     The Parameter Browser
-    </title>
+    <title>The Parameter Browser</title>
 
     <para>
      The parameter browser contains all the local, global, and dynamic
-     parameters that can be included in your query. At the moment only
-     the dynamic parameters are available, which allow you to create
-     master-detail queries.
+     parameters that can be included in your query. To set the value of
+     a local parameter, click on the value and press the
+     <keycap>F2</keycap> key, or double-click the value.
 
      <remark>
       [MH] UPDATE AS NECESSCARY
@@ -990,9 +932,7 @@
 
    <sect2 id="mysql-query-browser-tour-pandf-syntaxbrowser">
 
-    <title>
-     The Syntax Browser
-    </title>
+    <title>The Syntax Browser</title>
 
     <para>
      The syntax browser provides a quick reference tool for determining
@@ -1007,9 +947,7 @@
 
    <sect2 id="mysql-query-browser-tour-pandf-functionbrowser">
 
-    <title>
-     The Function browser
-    </title>
+    <title>The Function browser</title>
 
     <para>
      The function browser provides a quick reference tool for usage of
@@ -1024,9 +962,7 @@
 
    <sect2 id="mysql-query-browser-tour-pandf-transbrowser">
 
-    <title>
-     The Transaction Browser
-    </title>
+    <title>The Transaction Browser</title>
 
     <para>
      The Transaction Browser provides a list of all statements that have
@@ -1045,9 +981,7 @@
 
   <sect1 id="mysql-query-browser-tour-scripteditor-introduction">
 
-   <title>
-    The Script Editor
-   </title>
+   <title>The Script Editor</title>
 
    <para>
     The <literal>Script Editor</literal> provides an alternate interface
@@ -1056,9 +990,7 @@
    </para>
 
    <figure>
-    <title>
-     The script editor
-    </title>
+    <title>The script editor</title>
     <graphic fileref="images/script-editor.png" lang="en" format="PNG"/>
    </figure>
 
@@ -1085,9 +1017,7 @@
 
    <sect2 id="mysql-query-browser-tour-scripteditor-buttons">
 
-    <title>
-     The Script Debugging Buttons
-    </title>
+    <title>The Script Debugging Buttons</title>
 
     <para>
      The following buttons are available when using the Script Editor:
@@ -1132,9 +1062,7 @@
 
    <sect2 id="mysql-query-browser-tour-scripteditor-scriptarea">
 
-    <title>
-     The Script Area
-    </title>
+    <title>The Script Area</title>
 
     <para>
      The current script being edited in the Script Editor is displayed
@@ -1168,9 +1096,7 @@
 
  <chapter id="mysql-query-browser-using">
 
-  <title>
-   Using The &query_browser;
-  </title>
+  <title>Using The &query_browser;</title>
 
   <para>
    In this chapter we further describe the tools available in the
@@ -1179,9 +1105,7 @@
 
   <sect1 id="mysql-query-browser-using-manualentry">
 
-   <title>
-    Entering and Editing Queries Manually
-   </title>
+   <title>Entering and Editing Queries Manually</title>
 
    <para>
     The most common task performed with the query browser is that of
@@ -1252,9 +1176,7 @@
 
   <sect1 id="mysql-query-browser-using-graphicalbuilding">
 
-   <title>
-    Building Queries
-   </title>
+   <title>Building Queries</title>
 
    <para>
     One feature of the &query_browser; is the ability to build queries.
@@ -1272,21 +1194,8 @@
     <literal>SELECT</literal> query.
    </para>
 
-   <para>
-    You can drag additional tables to the query area while holding the
-    <keycap>Ctrl</keycap> or <keycap>Shift</keycap> keys to add them to
-    the <literal>FROM</literal> clause. By holding the
-    <keycap>Shift</keycap> key while dragging, the tables are joined. By
-    holding the <keycap>Ctrl</keycap> key while dragging, a
-    <literal>LEFT OUTER JOIN</literal> is performed. The tables are
-    joined based on identical column names for MyISAM tables and foreign
-    key information for InnoDB tables.
-   </para>
-
    <figure>
-    <title>
-     The table tool
-    </title>
+    <title>The table tool</title>
     <graphic fileref="images/tabletool.png" lang="en" format="PNG"/>
    </figure>
 
@@ -1341,6 +1250,11 @@
    </itemizedlist>
 
    <para>
+    Tables are joined based on identical column names for MyISAM tables
+    and foreign key information for InnoDB tables.
+   </para>
+
+   <para>
     Once a table is selected, you can choose specific columns to query;
     click the <guibutton>Select</guibutton> button from the query
     building buttons on the button bar. Your mouse pointer is changed to
@@ -1379,9 +1293,7 @@
 
   <sect1 id="mysql-query-browser-creating-views">
 
-   <title>
-    Creating Views
-   </title>
+   <title>Creating Views</title>
 
    <para>
     The simplest way to create a view using the &query_browser; is to
@@ -1405,9 +1317,7 @@
 
   <sect1 id="mysql-query-browser-using-navigatingtabsheet">
 
-   <title>
-    Navigating Result Sets Within the Result Area
-   </title>
+   <title>Navigating Result Sets Within the Result Area</title>
 
    <para>
     Once you have successfully executed a query you are then able to
@@ -1508,9 +1418,7 @@
 
   <sect1 id="mysql-query-browser-using-export">
 
-   <title>
-    Exporting Result Sets
-   </title>
+   <title>Exporting Result Sets</title>
 
    <para>
     You can export any result set from &query_browser; by right-clicking
@@ -1527,9 +1435,7 @@
 
   <sect1 id="mysql-query-browser-using-blobs">
 
-   <title>
-    Handling BLOB and TEXT Columns
-   </title>
+   <title>Handling BLOB and TEXT Columns</title>
 
    <para>
     The &query_browser; provides functionality for dealing with
@@ -1538,9 +1444,7 @@
    </para>
 
    <figure>
-    <title>
-     The BLOB handling icons
-    </title>
+    <title>The BLOB handling icons</title>
     <graphic fileref="images/blob-buttons.png" lang="en" format="PNG"/>
    </figure>
 
@@ -1597,9 +1501,7 @@
 
   <sect1 id="mysql-query-browser-using-editingtabsheet">
 
-   <title>
-    Editing Result Sets Within the Result Area
-   </title>
+   <title>Editing Result Sets Within the Result Area</title>
 
    <para>
     When a query is based on a single table, with sufficient identifying
@@ -1653,9 +1555,7 @@
 
   <sect1 id="mysql-query-browser-using-compare">
 
-   <title>
-    Comparing Result Sets
-   </title>
+   <title>Comparing Result Sets</title>
 
    <para>
     You can compare result sets graphically with the &query_browser;,
@@ -1701,9 +1601,7 @@
 
   <sect1 id="mysql-query-browser-using-masterdetail">
 
-   <title>
-    Creating Master-Detail Views
-   </title>
+   <title>Creating Master-Detail Views</title>
 
    <para>
     &query_browser; makes it easy to view data that is in a
@@ -1737,9 +1635,7 @@
    </para>
 
    <figure>
-    <title>
-     The dynamic parameter list
-    </title>
+    <title>The dynamic parameter list</title>
     <graphic fileref="images/dynamiclist.png" lang="en" format="PNG"/>
    </figure>
 
@@ -1761,15 +1657,12 @@
 
   <sect1 id="mysql-query-browser-using-procedures">
 
-   <title>
-    Managing Stored Procedures and Functions with &query_browser;
-   </title>
+   <title>Managing Stored Procedures and Functions with &query_browser;</title>
 
    <para>
     The &query_browser; supports stored procedures and stored functions
-    when used with MySQL version 5 and higher. Support is
-    present for creating, editing, and viewing stored procedures and
-    functions.
+    when used with MySQL version 5 and higher. Support is present for
+    creating, editing, and viewing stored procedures and functions.
    </para>
 
    <para>
@@ -1785,9 +1678,10 @@
     the database browser and choose the <guimenu>Edit
     Procedure</guimenu> or <guimenu>Edit Function</guimenu> option. This
     opens a new script editor tab with the selected procedure/function
-    displayed. Once you have finished editing click the execute button
-    or press <keycap>Ctrl</keycap> + <keycap>Enter</keycap> to update
-    the procedure/function.
+    displayed. Once you have finished editing click the
+    <guibutton>Execute</guibutton> button above the script area or click
+    the <guimenu>Execute</guimenu> option of the
+    <guimenu>Script</guimenu> menu to update the procedure/function.
    </para>
 
    <para>
@@ -1812,8 +1706,10 @@
   </programlisting>
 
    <para>
-    After entering the procedure/function, click the execute button or
-    press <keycap>Ctrl</keycap> + <keycap>Enter</keycap> to create it.
+    After entering the procedure/function, click the
+    <guibutton>Execute</guibutton> button above the script area or click
+    the <guimenu>Execute</guimenu> option of the
+    <guimenu>Script</guimenu> menu to create it.
    </para>
 
    <para>
@@ -1830,9 +1726,7 @@
 
   <sect1 id="mysql-query-browser-using-codeedit">
 
-   <title>
-    Editing Queries From a Development Tool
-   </title>
+   <title>Editing Queries From a Development Tool</title>
 
    <para>
     In order to help programmers optimize and troubleshoot their queries
@@ -1849,30 +1743,43 @@
     The following PHP code will be used as an example:
 
 <programlisting>
-    $SQL = "SELECT Id, Name, Country FROM City";
-    mysql_query($SQL,$db);
+    $SQL = "SELECT Id, Name, Country FROM City" .
+           "WHERE Name LIKE $cityname";
    </programlisting>
 
-    To copy the listing into the &query_browser;, highlight the query
-    from within your editor and press <keycap>Ctrl</keycap> +
-    <keycap>Alt</keycap> + <keycap>Shift</keycap> + <keycap>C</keycap>.
-    The non-query portions of the highlighted area will be stripped and
-    the query will be pasted into the query area.
+    To copy the listing into the &query_browser;, copy the block of code
+    (including the assignment portion), right click within the query
+    area of the &query_browser;, and choose the <guimenu>Paste Clipboard
+    Content as PHP Code</guimenu> option. The non-query portions of the
+    highlighted area will be stripped and the query will be pasted into
+    the query area.
    </para>
 
    <para>
-    After editing the query, press <keycap>Ctrl</keycap> +
-    <keycap>Alt</keycap> + <keycap>Shift</keycap> + <keycap>V</keycap>
-    to load the modified query back into your original code. The
-    surrounding PHP code will be re-inserted along with the modified
-    query. This functionality allows you to edit queries quickly while
-    programming.
+    The dynamic elements of the query are converted into local
+    parameters, visible in the
+    <link linkend="mysql-query-browser-tour-pandf-parameterbrowser">parameter
+    browser</link>:
    </para>
 
+<programlisting>
+SELECT Id, Name, Country FROM City
+WHERE Name LIKE :cityname
+</programlisting>
+
    <para>
-    In order to use this functionality your editing application needs to
-    support the standard Windows clipboard system, which most Windows
-    applications do.
+    To set the value of a local parameter, highlight the value in the
+    parameter browser and press <keycap>F2</keycap>. You can also
+    double-click on the value to edit it. The value you assign will be
+    used when the query is executed.
+   </para>
+
+   <para>
+    After editing the query, right-click within the query area and
+    choose the <guimenu>Copy Query as PHP Code</guimenu> option. The
+    surrounding PHP code will be re-inserted along with the modified
+    query. This functionality allows you to edit queries quickly while
+    programming.
    </para>
 
   </sect1>
@@ -1912,9 +1819,7 @@
 
 <appendix id="mysql-query-browser-appendix-xml-files">
 
-  <title>
-   XML Files Used by &query_browser;
-  </title>
+  <title>XML Files Used by &query_browser;</title>
 
   <para>
    Besides the <link linkend="mysql-gui-appendix-xml-files">common

--- 1.2947/Docs/manual.texi	2005-05-30 17:20:16 -06:00
+++ 1.2948/Docs/manual.texi	2005-06-01 13:06:28 -06:00
@@ -98487,10 +98487,7 @@
 @node Errors in 3.23, Errors in 4.0, Bugs, Bugs
 @appendixsubsec Issues in MySQL 3.23 Fixed in a Later MySQL Version
 
-The following known errors or bugs are not fixed in MySQL 3.23 because fixing
-them would involve changing a lot of code that could introduce other
-even worse bugs. The bugs are also classified as ``not fatal'' or
-``bearable.''
+The following known issues have not been fixed in MySQL 3.23 for various reasons, and are not classified as critical. 
 
 @itemize @bullet
 @item
@@ -98516,10 +98513,7 @@
 @node Errors in 4.0, Errors in 4.1, Errors in 3.23, Bugs
 @appendixsubsec Issues in 4.0 Fixed in a Later MySQL Version
 
-The following known errors or bugs are not fixed in MySQL 4.0 because fixing
-them would involve changing a lot of code that could introduce other
-even worse bugs. The bugs are also classified as ``not fatal'' or
-``bearable.''
+The following known issues have not been fixed in MySQL 4.0 for various reasons, and are not classified as critical. 
 
 @itemize @bullet
 @item
@@ -98560,10 +98554,7 @@
 @node Errors in 4.1, Open bugs, Errors in 4.0, Bugs
 @appendixsubsec Issues in 4.1 Fixed in a Later MySQL Version
 
-The following known errors or bugs are not fixed in MySQL 4.1 because fixing
-them would involve changing a lot of code that could introduce other
-even worse bugs. The bugs are also classified as ``not fatal'' or
-``bearable.''
+The following known issues have not been fixed in MySQL 4.1 for various reasons, and are not classified as critical. 
 
 @itemize @bullet
 Fixed in 5.0.3: @code{VARCHAR} and @code{VARBINARY} did not remember end space.
Thread
bk commit - mysqldoc@docsrva tree (Mike.Hillyer:1.2729)mhillyer1 Jun