bk commit - mysqldoc tree (paul:1.2761)

[paul]

Below is the list of changes that have just been committed into a local
mysqldoc repository of paul. When paul 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.2761 05/03/22 10:50:12 paul@stripped +1 -0
  manual.texi:
    Some wording cleanups.
    Additional index entries.

  Docs/manual.texi
    1.2595 05/03/22 10:47:42 paul@stripped +157 -91
    Some wording cleanups.
    Additional index entries.

# 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:	paul
# Host:	frost.snake.net
# Root:	/Volumes/frost2/MySQL/bk/mysqldoc

--- 1.2594/Docs/manual.texi	2005-03-22 07:44:18 -06:00
+++ 1.2595/Docs/manual.texi	2005-03-22 10:47:42 -06:00
@@ -12052,41 +12052,43 @@
 @node Downgrading to-4.1, Downgrading to-4.0, Downgrading, Downgrading
 @subsection Downgrading to 4.1
 
-If you after downgrading from MYsQL 5.0 get the following information in
-the mysql.err file:
+After downgrading from MySQL 5.0, you may see the following information in
+the @file{mysql.err} file:
 
-@code{Incorrect information in file: './mysql/user.frm'}
+@example
+Incorrect information in file: './mysql/user.frm'
+@end example
 
-you can do the following:
+In this case, you can do the following:
 
 @enumerate
 @item
-Start MySQL 5.0.4 (or newer)
+Start MySQL 5.0.4 (or newer).
 @item
-Run @code{mysql_fix_privilege_tables}, which will change the @code{mysql.user}
-table to a format that both MySQL 4.1 and 5.0 can use.
+Run @command{mysql_fix_privilege_tables}, which will change the
+@code{mysql.user} table to a format that both MySQL 4.1 and 5.0 can use.
 @item
-Stop the MySQL server
+Stop the MySQL server.
 @item
-Start MySQL 4.1
+Start MySQL 4.1.
 @end enumerate
 
-If the above would fail, then you should be able to use the following
-procedure:
+If the preceding procedure fails, then you should be able to do the following
+instead:
 
 @enumerate
 @item
-Start MySQL 5.0.4 (or newer)
+Start MySQL 5.0.4 (or newer).
 @item
-Run @code{mysqldump --opt --add-drop-table mysql > /tmp/mysql.dump}
+Run @command{mysqldump --opt --add-drop-table mysql > /tmp/mysql.dump}.
 @item
-Stop the MySQL server
+Stop the MySQL server.
 @item
 Start MySQL 4.1 with the @code{--skip-grant} option.
 @item
-Run @code{mysql mysql < /tmp/mysql.dump}.
+Run @command{mysql mysql < /tmp/mysql.dump}.
 @item
-Run @code{mysqladmin flush-privileges}
+Run @command{mysqladmin flush-privileges}.
 @end enumerate
 
 
@@ -12094,10 +12096,10 @@
 @subsection Downgrading to 4.0
 
 The table format in 4.1 changed to include more and new character set
-information. Because of this, you must use @code{mysqldump} to dump any tables
-you have created with the newer MySQL server.  For example, if all the tables
-in a particular database need to be dumped to be reverted back to MySQL 4.0
-format, use this command:
+information. Because of this, you must use @command{mysqldump} to dump any
+tables you have created with the newer MySQL server.  For example, if all
+the tables in a particular database need to be dumped to be reverted back to
+MySQL 4.0 format, use this command:
 
 @example
 shell> mysqldump --create-options --compatible=mysql40 @var{db_name} >
@var{dump_file}
@@ -44957,7 +44959,8 @@
 @table @code
 
 @c description_for_help_topic BIT
-@tindex BIT
+@tindex BIT data type
+@tindex data type, BIT
 @item BIT[(@var{M})]
 
 A bit-field type. @var{M} indicates the number of bits per value, from 1 to
@@ -44968,7 +44971,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TINYINT  BOOLEAN BOOL ZEROFILL UNSIGNED INT1
-@tindex TINYINT
+@tindex TINYINT data type
+@tindex data type, TINYINT
 @item TINYINT[(@var{M})] [UNSIGNED] [ZEROFILL]
 
 A very small integer. The signed range is @code{-128} to @code{127}. The
@@ -44976,8 +44980,10 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic BOOLEAN  BOOL
-@tindex BOOLEAN
-@tindex BOOL
+@tindex BOOLEAN data type
+@tindex BOOL data type
+@tindex data type, BOOLEAN
+@tindex data type, BOOL
 @item BOOL
 @itemx BOOLEAN
 These are synonyms for @code{TINYINT(1)}.
@@ -44989,7 +44995,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic SMALLINT  INT2
-@tindex SMALLINT
+@tindex SMALLINT data type
+@tindex data type, SMALLINT
 @item SMALLINT[(@var{M})] [UNSIGNED] [ZEROFILL]
 
 A small integer. The signed range is @code{-32768} to @code{32767}. The
@@ -44997,7 +45004,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic MEDIUMINT  INT3 MIDDLEINT
-@tindex MEDIUMINT
+@tindex MEDIUMINT data type
+@tindex data type, MEDIUMINT
 @item MEDIUMINT[(@var{M})] [UNSIGNED] [ZEROFILL]
 
 A medium-size integer. The signed range is @code{-8388608} to
@@ -45005,20 +45013,23 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic INT  INT4 UNSIGNED ZEROFILL INTEGER
-@tindex INT
+@tindex INT data type
+@tindex data type, INT
 @item INT[(@var{M})] [UNSIGNED] [ZEROFILL]
 
 A normal-size integer. The signed range is @code{-2147483648} to
 @code{2147483647}.  The unsigned range is @code{0} to @code{4294967295}.
 
-@tindex INTEGER
+@tindex INTEGER data type
+@tindex data type, INTEGER
 @item INTEGER[(@var{M})] [UNSIGNED] [ZEROFILL]
 
 This is a synonym for @code{INT}.
 @c end_description_for_help_topic
 
 @c description_for_help_topic BIGINT  UNSIGNED ZEROFILL INT8
-@tindex BIGINT
+@tindex BIGINT data type
+@tindex data type, BIGINT
 @item BIGINT[(@var{M})] [UNSIGNED] [ZEROFILL]
 A large integer. The signed range is @code{-9223372036854775808} to
 @code{9223372036854775807}. The unsigned range is @code{0} to
@@ -45062,8 +45073,8 @@
 
 @c description_for_help_topic FLOAT  UNSIGNED ZEROFILL FLOAT4
 @cindex floating-point number
-@tindex FLOAT
-@tindex FLOAT(p)
+@tindex FLOAT data type
+@tindex data type, FLOAT
 @item FLOAT(@var{p}) [UNSIGNED] [ZEROFILL]
 
 A floating-point number.  @var{p} represents the precision. It can be from
@@ -45084,9 +45095,8 @@
 all calculations in MySQL are done with double precision.
 @xref{No matching rows}.
 
-@tindex FLOAT
-@tindex FLOAT(M,D)
-@tindex FLOAT(p)
+@tindex FLOAT data type
+@tindex data type, FLOAT
 @item FLOAT[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
 
 A small (single-precision) floating-point number.  Allowable values are
@@ -45099,9 +45109,10 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic DOUBLE  FLOAT8 UNSIGNED ZEROFILL PRECISION REAL
-@tindex DOUBLE
-@tindex DOUBLE(M,D)
-@tindex FLOAT(p)
+@tindex DOUBLE data type
+@tindex FLOAT data type
+@tindex data type, DOUBLE
+@tindex data type, FLOAT
 @item DOUBLE[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
 
 A normal-size (double-precision) floating-point number.
@@ -45114,8 +45125,10 @@
 @var{p} is in the
 range from 25 to 53) stands for a double-precision floating-point number.
 
-@tindex DOUBLE PRECISION
-@tindex REAL
+@tindex DOUBLE PRECISION data type
+@tindex REAL data type
+@tindex data type, DOUBLE PRECISION
+@tindex data type, REAL
 @item DOUBLE PRECISION[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
 @itemx REAL[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
 
@@ -45125,7 +45138,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic NUMERIC  ZEROFILL UNSIGNED DECIMAL DEC FIXED
-@tindex DECIMAL
+@tindex DECIMAL data type
+@tindex data type, DECIMAL
 @item DECIMAL[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
 
 @c TODO: update for precision math
@@ -45147,9 +45161,12 @@
 Prior to MySQL 3.23, the @var{M} argument must be large enough to
 include the space needed for the sign and the decimal point.
 
-@tindex DEC
-@tindex NUMERIC
-@tindex FIXED
+@tindex DEC data type
+@tindex NUMERIC data type
+@tindex FIXED data type
+@tindex data type, DEC
+@tindex data type, NUMERIC
+@tindex data type, FIXED
 @item DEC[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
 @itemx NUMERIC[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
 @itemx FIXED[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
@@ -45169,7 +45186,8 @@
 
 @table @code
 
-@tindex DATE
+@tindex DATE data type
+@tindex data type, DATE
 @item DATE
 
 @c description_for_help_topic DATE  DATE
@@ -45179,7 +45197,8 @@
 numbers.
 @c end_description_for_help_topic
 
-@tindex DATETIME
+@tindex DATETIME data type
+@tindex data type, DATETIME
 @item DATETIME
 
 @c description_for_help_topic DATETIME
@@ -45190,7 +45209,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TIMESTAMP  TIMESTAMP
-@tindex TIMESTAMP
+@tindex TIMESTAMP data type
+@tindex data type, TIMESTAMP
 @item TIMESTAMP[(@var{M})]
 
 A timestamp.  The range is @code{'1970-01-01 00:00:00'} to partway through the
@@ -45225,7 +45245,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TIME  TIME
-@tindex TIME
+@tindex TIME data type
+@tindex data type, TIME
 @item TIME
 
 A time.  The range is @code{'-838:59:59'} to @code{'838:59:59'}.
@@ -45235,7 +45256,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic YEAR type
-@tindex YEAR
+@tindex YEAR data type
+@tindex data type, YEAR
 @item YEAR[(2|4)]
 
 A year in two-digit or four-digit format. The default is four-digit format.
@@ -45314,10 +45336,14 @@
 @table @code
 
 @c description_for_help_topic CHAR  NATIONAL CHARACTER NCHAR BINARY
-@tindex NATIONAL CHAR
-@tindex NCHAR
-@tindex CHAR
-@tindex CHARACTER
+@tindex CHAR data type
+@tindex NATIONAL CHAR data type
+@tindex NCHAR data type
+@tindex CHARACTER data type
+@tindex data type, CHAR
+@tindex data type, NATIONAL CHAR
+@tindex data type, NCHAR
+@tindex data type, CHARACTER
 @item [NATIONAL] CHAR(@var{M}) [BINARY | ASCII | UNICODE]
 
 A fixed-length string that is always right-padded with spaces to the
@@ -45367,10 +45393,14 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic VARCHAR  BINARY NATIONAL VARYING CHARACTER VARCHARACTER
-@tindex CHARACTER VARYING
-@tindex CHAR VARYING
-@tindex VARCHAR
-@tindex VARCHARACTER
+@tindex VARCHAR data type
+@tindex CHARACTER VARYING data type
+@tindex CHAR VARYING data type
+@tindex VARCHARACTER data type
+@tindex data type, VARCHAR
+@tindex data type, CHARACTER VARYING
+@tindex data type, CHAR VARYING
+@tindex data type, VARCHARACTER
 @item [NATIONAL] VARCHAR(@var{M}) [BINARY]
 
 A variable-length string.  @var{M} represents the maximum column length.
@@ -45406,7 +45436,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic BINARY
-@tindex BINARY
+@tindex BINARY data type
+@tindex data type, BINARY
 @item BINARY(@var{M})
 
 The @code{BINARY} type is similar to the @code{CHAR} type, but stores
@@ -45416,7 +45447,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic VARBINARY
-@tindex VARBINARY
+@tindex VARBINARY data type
+@tindex data type, VARBINARY
 @item VARBINARY(@var{M})
 
 The @code{VARBINARY} type is similar to the @code{VARCHAR} type, but stores
@@ -45426,7 +45458,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TINYBLOB
-@tindex TINYBLOB
+@tindex TINYBLOB data type
+@tindex data type, TINYBLOB
 @item TINYBLOB
 
 A @code{BLOB} column with a maximum length of 255
@@ -45434,7 +45467,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TINYTEXT
-@tindex TINYTEXT
+@tindex TINYTEXT data type
+@tindex data type, TINYTEXT
 @item TINYTEXT
 
 A @code{TEXT} column with a maximum length of 255
@@ -45442,7 +45476,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic BLOB type
-@tindex BLOB
+@tindex BLOB data type
+@tindex data type, BLOB
 @item BLOB
 
 A @code{BLOB} column with a maximum length of 65,535
@@ -45450,7 +45485,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic TEXT type
-@tindex TEXT
+@tindex TEXT data type
+@tindex data type, TEXT
 @item TEXT
 
 A @code{TEXT} column with a maximum length of 65,535
@@ -45458,7 +45494,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic MEDIUMBLOB
-@tindex MEDIUMBLOB
+@tindex MEDIUMBLOB data type
+@tindex data type, MEDIUMBLOB
 @item MEDIUMBLOB
 
 A @code{BLOB} column with a maximum length of 16,777,215
@@ -45466,7 +45503,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic MEDIUMTEXT
-@tindex MEDIUMTEXT
+@tindex MEDIUMTEXT data type
+@tindex data type, MEDIUMTEXT
 @item MEDIUMTEXT
 
 A @code{TEXT} column with a maximum length of 16,777,215
@@ -45474,7 +45512,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic LONGBLOB  LONG LONGBINARY
-@tindex LONGBLOB
+@tindex LONGBLOB data type
+@tindex data type, LONGBLOB
 @item LONGBLOB
 
 A @code{BLOB} column with a maximum length of 4,294,967,295 or
@@ -45487,7 +45526,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic LONGTEXT
-@tindex LONGTEXT
+@tindex LONGTEXT data type
+@tindex data type, LONGTEXT
 @item LONGTEXT
 
 A @code{TEXT} column with a maximum length of 4,294,967,295 or
@@ -45500,7 +45540,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic ENUM
-@tindex ENUM
+@tindex ENUM data type
+@tindex data type, ENUM
 @item ENUM('@var{value1}','@var{value2}',...)
 
 An enumeration.  A string object that can have only one value, chosen
@@ -45511,7 +45552,8 @@
 @c end_description_for_help_topic
 
 @c description_for_help_topic type SET
-@tindex SET
+@tindex SET data type
+@tindex data type, SET
 @item SET('@var{value1}','@var{value2}',...)
 
 A set.  A string object that can have zero or more values, each of which must
@@ -45847,9 +45889,12 @@
 @node DATETIME, TIME, Date and time types, Date and time types
 @subsection The @code{DATETIME}, @code{DATE}, and @code{TIMESTAMP} Types
 
-@tindex DATETIME
-@tindex DATE
-@tindex TIMESTAMP
+@tindex DATETIME data type
+@tindex DATE data type
+@tindex TIMESTAMP data type
+@tindex data type, DATETIME
+@tindex data type, DATE
+@tindex data type, TIMESTAMP
 
 @menu
 * TIMESTAMP pre-4.1::           @code{TIMESTAMP} Properties Prior to MySQL 4.1
@@ -46384,7 +46429,8 @@
 @node TIME, YEAR, DATETIME, Date and time types
 @subsection The @code{TIME} Type
 
-@tindex TIME
+@tindex TIME data type
+@tindex data type, TIME
 
 MySQL retrieves and displays @code{TIME} values in @code{'HH:MM:SS'}
 format (or @code{'HHH:MM:SS'} format for large hours values).  @code{TIME}
@@ -46457,7 +46503,8 @@
 
 @c TODO: This really applies to YEAR(4). It could be more precise for YEAR(2).
 
-@tindex YEAR
+@tindex YEAR data type
+@tindex data type, YEAR
 
 The @code{YEAR} type is a one-byte type used for representing years.
 
@@ -46545,8 +46592,10 @@
 @cindex types, strings
 @cindex string types
 
-@tindex CHAR
-@tindex VARCHAR
+@tindex CHAR data type
+@tindex VARCHAR data type
+@tindex data type, CHAR
+@tindex data type, VARCHAR
 
 @menu
 * CHAR::                        The @code{CHAR} and @code{VARCHAR} Types
@@ -46664,6 +46713,11 @@
 @node BINARY VARBINARY, BLOB, CHAR, String types
 @subsection The @code{BINARY} and @code{VARBINARY} Types
 
+@tindex BINARY data type
+@tindex VARBINARY data type
+@tindex data type, BINARY
+@tindex data type, VARBINARY
+
 The @code{BINARY} and @code{VARBINARY} types are similar to @code{CHAR} and
 @code{VARCHAR}, except that they contain binary strings rather than
 non-binary strings. That is, they contain byte strings rather than character
@@ -46694,9 +46748,12 @@
 @c TODO: needs some discussion of the change to character semantics
 @c for TEXT in 4.1.
 
-@tindex BLOB
-@tindex TEXT
-@tindex LONG
+@tindex BLOB data type
+@tindex TEXT data type
+@tindex data type, BLOB
+@tindex data type, TEXT
+@tindex LONG data type
+@tindex data type, LONG
 
 @c description_for_help_topic BLOB
 A @code{BLOB} is a binary large object that can hold a variable amount of
@@ -46841,7 +46898,8 @@
 @node ENUM, SET, BLOB, String types
 @subsection The @code{ENUM} Type
 
-@tindex ENUM
+@tindex ENUM data type
+@tindex data type, ENUM
 
 An @code{ENUM} is a string object with a value chosen from a list
 of allowed values that are enumerated explicitly in the column specification
@@ -46952,7 +47010,8 @@
 @node SET,  , ENUM, String types
 @subsection The @code{SET} Type
 
-@tindex SET
+@tindex SET data type
+@tindex data type, SET
 
 A @code{SET} is a string object that can have zero or more values, each of
 which must be chosen from a list of allowed values specified when the table
@@ -61738,7 +61797,6 @@
 @findex SHOW STATUS
 @findex SHOW TABLES
 @findex SHOW TABLE STATUS
-@findex SHOW ENGINES
 @findex SHOW TABLE TYPES
 @findex SHOW VARIABLES
 @findex SHOW WARNINGS
@@ -77537,14 +77595,22 @@
 @node MySQL spatial datatypes, Creating spatial values, Creating a spatially enabled
MySQL database, Creating a spatially enabled MySQL database
 @subsection MySQL Spatial Data Types
 
-@tindex GEOMETRY
-@tindex POINT
-@tindex LINESTRING
-@tindex POLYGON
-@tindex MULTIPOINT
-@tindex MULTILINESTRING
-@tindex MULTIPOLYGON
-@tindex GEOMETRYCOLLECTION
+@tindex GEOMETRY data type
+@tindex POINT data type
+@tindex LINESTRING data type
+@tindex POLYGON data type
+@tindex MULTIPOINT data type
+@tindex MULTILINESTRING data type
+@tindex MULTIPOLYGON data type
+@tindex GEOMETRYCOLLECTION data type
+@tindex data type, GEOMETRY
+@tindex data type, POINT
+@tindex data type, LINESTRING
+@tindex data type, POLYGON
+@tindex data type, MULTIPOINT
+@tindex data type, MULTILINESTRING
+@tindex data type, MULTIPOLYGON
+@tindex data type, GEOMETRYCOLLECTION
 
 MySQL has data types that correspond to OpenGIS classes.
 Some of these types hold single geometry values:
@@ -99282,8 +99348,8 @@
 Functionality added or changed:
 @itemize @bullet
 @item
-Added back faster sub query execution from 4.1.8. This adds also back a bug
-from 4.1.8 in comparing @code{NULL} to the value of a sub query.
+Added back faster subquery execution from 4.1.8. This adds also back a bug
+from 4.1.8 in comparing @code{NULL} to the value of a subquery.
 @xref{Open bugs}.
 
 @item