svn commit - mysqldoc@docsrva: r11467 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0

[paul.dubois]

Author: paul
Date: 2008-08-01 17:33:25 +0200 (Fri, 01 Aug 2008)
New Revision: 11467

Log:
 r33143@frost:  paul | 2008-08-01 10:32:31 -0500
 Fix documentation bug:
 Bug#33544: UDF_INIT member decimals initialized wrong with STRING_RESULT
 argument


Modified:
   trunk/refman-4.1/extending-mysql.xml
   trunk/refman-5.0/extending-mysql.xml
   trunk/refman-5.1/extending-mysql.xml
   trunk/refman-6.0/extending-mysql.xml

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


Modified: trunk/refman-4.1/extending-mysql.xml
===================================================================
--- trunk/refman-4.1/extending-mysql.xml	2008-08-01 15:31:30 UTC (rev 11466)
+++ trunk/refman-4.1/extending-mysql.xml	2008-08-01 15:33:25 UTC (rev 11467)
Changed blocks: 1, Lines Added: 31, Lines Deleted: 1; 2437 bytes

@@ -875,12 +875,42 @@
             <para>
               The number of decimal digits to the right of the decimal
               point. The default value is the maximum number of decimal
-              digits in the arguments passed to the main function. (For
+              digits in the arguments passed to the main function. For
               example, if the function is passed
               <literal>1.34</literal>, <literal>1.345</literal>,
and
               <literal>1.3</literal>, the default would be 3, because
               <literal>1.345</literal> has 3 decimal digits.
             </para>
+
+            <para>
+              For arguments that have no fixed number of decimals, the
+              <literal>decimals</literal> value is set to 31, which is 1
+              more than the maximum number of decimals allowed for the
+              <literal>DECIMAL</literal>,
<literal>FLOAT</literal>, and
+              <literal>DOUBLE</literal> data types.
+            </para>
+
+            <para>
+              A <literal>decimals</literal> value of 31 is used for
+              arguments in cases such as a <literal>FLOAT</literal> or
+              <literal>DOUBLE</literal> column declared without an
+              explicit number of decimals (for example,
+              <literal>FLOAT</literal> rather than
+              <literal>FLOAT(10,3)</literal>) and for floating-point
+              constants such as <literal>1345E-3</literal>. It is also
+              used for string and other non-number arguments that might
+              be converted within the function to numeric form.
+            </para>
+
+            <para>
+              The value to which the <literal>decimals</literal> member
+              is initialized is only a default. It can be changed within
+              the function to reflect the actual calculation performed.
+              The default is determined such that the largest number of
+              decimals of the arguments is used. If the number of
+              decimals is 31 for even one of the arguments, that is the
+              value used for <literal>decimals</literal>.
+            </para>
           </listitem>
 
           <listitem>


Modified: trunk/refman-5.0/extending-mysql.xml
===================================================================
--- trunk/refman-5.0/extending-mysql.xml	2008-08-01 15:31:30 UTC (rev 11466)
+++ trunk/refman-5.0/extending-mysql.xml	2008-08-01 15:33:25 UTC (rev 11467)
Changed blocks: 1, Lines Added: 31, Lines Deleted: 1; 2437 bytes

@@ -863,12 +863,42 @@
             <para>
               The number of decimal digits to the right of the decimal
               point. The default value is the maximum number of decimal
-              digits in the arguments passed to the main function. (For
+              digits in the arguments passed to the main function. For
               example, if the function is passed
               <literal>1.34</literal>, <literal>1.345</literal>,
and
               <literal>1.3</literal>, the default would be 3, because
               <literal>1.345</literal> has 3 decimal digits.
             </para>
+
+            <para>
+              For arguments that have no fixed number of decimals, the
+              <literal>decimals</literal> value is set to 31, which is 1
+              more than the maximum number of decimals allowed for the
+              <literal>DECIMAL</literal>,
<literal>FLOAT</literal>, and
+              <literal>DOUBLE</literal> data types.
+            </para>
+
+            <para>
+              A <literal>decimals</literal> value of 31 is used for
+              arguments in cases such as a <literal>FLOAT</literal> or
+              <literal>DOUBLE</literal> column declared without an
+              explicit number of decimals (for example,
+              <literal>FLOAT</literal> rather than
+              <literal>FLOAT(10,3)</literal>) and for floating-point
+              constants such as <literal>1345E-3</literal>. It is also
+              used for string and other non-number arguments that might
+              be converted within the function to numeric form.
+            </para>
+
+            <para>
+              The value to which the <literal>decimals</literal> member
+              is initialized is only a default. It can be changed within
+              the function to reflect the actual calculation performed.
+              The default is determined such that the largest number of
+              decimals of the arguments is used. If the number of
+              decimals is 31 for even one of the arguments, that is the
+              value used for <literal>decimals</literal>.
+            </para>
           </listitem>
 
           <listitem>


Modified: trunk/refman-5.1/extending-mysql.xml
===================================================================
--- trunk/refman-5.1/extending-mysql.xml	2008-08-01 15:31:30 UTC (rev 11466)
+++ trunk/refman-5.1/extending-mysql.xml	2008-08-01 15:33:25 UTC (rev 11467)
Changed blocks: 1, Lines Added: 31, Lines Deleted: 1; 2439 bytes

@@ -2954,12 +2954,42 @@
             <para>
               The number of decimal digits to the right of the decimal
               point. The default value is the maximum number of decimal
-              digits in the arguments passed to the main function. (For
+              digits in the arguments passed to the main function. For
               example, if the function is passed
               <literal>1.34</literal>, <literal>1.345</literal>,
and
               <literal>1.3</literal>, the default would be 3, because
               <literal>1.345</literal> has 3 decimal digits.
             </para>
+
+            <para>
+              For arguments that have no fixed number of decimals, the
+              <literal>decimals</literal> value is set to 31, which is 1
+              more than the maximum number of decimals allowed for the
+              <literal>DECIMAL</literal>,
<literal>FLOAT</literal>, and
+              <literal>DOUBLE</literal> data types.
+            </para>
+
+            <para>
+              A <literal>decimals</literal> value of 31 is used for
+              arguments in cases such as a <literal>FLOAT</literal> or
+              <literal>DOUBLE</literal> column declared without an
+              explicit number of decimals (for example,
+              <literal>FLOAT</literal> rather than
+              <literal>FLOAT(10,3)</literal>) and for floating-point
+              constants such as <literal>1345E-3</literal>. It is also
+              used for string and other non-number arguments that might
+              be converted within the function to numeric form.
+            </para>
+
+            <para>
+              The value to which the <literal>decimals</literal> member
+              is initialized is only a default. It can be changed within
+              the function to reflect the actual calculation performed.
+              The default is determined such that the largest number of
+              decimals of the arguments is used. If the number of
+              decimals is 31 for even one of the arguments, that is the
+              value used for <literal>decimals</literal>.
+            </para>
           </listitem>
 
           <listitem>


Modified: trunk/refman-6.0/extending-mysql.xml
===================================================================
--- trunk/refman-6.0/extending-mysql.xml	2008-08-01 15:31:30 UTC (rev 11466)
+++ trunk/refman-6.0/extending-mysql.xml	2008-08-01 15:33:25 UTC (rev 11467)
Changed blocks: 1, Lines Added: 35, Lines Deleted: 1; 2670 bytes

@@ -3003,12 +3003,46 @@
             <para>
               The number of decimal digits to the right of the decimal
               point. The default value is the maximum number of decimal
-              digits in the arguments passed to the main function. (For
+              digits in the arguments passed to the main function. For
               example, if the function is passed
               <literal>1.34</literal>, <literal>1.345</literal>,
and
               <literal>1.3</literal>, the default would be 3, because
               <literal>1.345</literal> has 3 decimal digits.
             </para>
+
+            <para>
+              For arguments that have no fixed number of decimals, the
+              <literal>decimals</literal> value is set to 31, which is 1
+              more than the maximum number of decimals allowed for the
+              <literal>DECIMAL</literal>,
<literal>FLOAT</literal>, and
+              <literal>DOUBLE</literal> data types. As of MySQL 6.0.6,
+              this value is available as the constant
+              <literal>NOT_FIXED_DEC</literal> in the
+              <filename>mysql_com.h</filename> header file.
+            </para>
+
+            <para>
+              A <literal>decimals</literal> value of 31 is used for
+              arguments in cases such as a <literal>FLOAT</literal> or
+              <literal>DOUBLE</literal> column declared without an
+              explicit number of decimals (for example,
+              <literal>FLOAT</literal> rather than
+              <literal>FLOAT(10,3)</literal>) and for floating-point
+              constants such as <literal>1345E-3</literal>. It is also
+              used for string and other non-number arguments that might
+              be converted within the function to numeric form.
+            </para>
+
+            <para>
+              The value to which the <literal>decimals</literal> member
+              is initialized is only a default. It can be changed within
+              the function to reflect the actual calculation performed.
+              The default is determined such that the largest number of
+              decimals of the arguments is used. If the number of
+              decimals is <literal>NOT_FIXED_DEC</literal> for even one
+              of the arguments, that is the value used for
+              <literal>decimals</literal>.
+            </para>
           </listitem>
 
           <listitem>