Commit 5c965dee authored by unknown's avatar unknown

Update PeterG's internals documentation per comments from

Monty; minor changes only.

parent 4de03995
...@@ -3286,17 +3286,11 @@ server. ...@@ -3286,17 +3286,11 @@ server.
The C program files in the directory are: The C program files in the directory are:
@itemize @bullet @itemize @bullet
@item @item
connect_test.c -- test that a connect is possible
@item
get_password.c -- ask for a password from the console get_password.c -- ask for a password from the console
@item @item
insert_test.c -- test that an insert is possible
@item
list_test.c -- test that a select is possible
@item
mysql.cc -- "The MySQL command tool" mysql.cc -- "The MySQL command tool"
@item @item
mysqladmin.c -- maintenance of MYSQL databases mysqladmin.c -- maintenance of MySQL databases
@item @item
mysqlcheck.c -- check all databases, check connect, etc. mysqlcheck.c -- check all databases, check connect, etc.
@item @item
...@@ -3313,14 +3307,6 @@ mysqlshow.c -- show databases, tables or columns ...@@ -3313,14 +3307,6 @@ mysqlshow.c -- show databases, tables or columns
mysqltest.c -- test program used by the mysql-test suite, mysql-test-run mysqltest.c -- test program used by the mysql-test suite, mysql-test-run
@item @item
password.c -- password checking routines (version 4.1 and up) password.c -- password checking routines (version 4.1 and up)
@item
select_test.c -- test that a select is possible
@item
showdb_test.c -- test that a show-databases is possible
@item
ssl_test.c -- test that SSL is possible
@item
thread_test.c -- test that threading is possible
@end itemize @end itemize
@*@* @*@*
...@@ -4440,7 +4426,7 @@ lock.cc -- Locks ...@@ -4440,7 +4426,7 @@ lock.cc -- Locks
@item @item
log.cc -- Logs log.cc -- Logs
@item @item
log_event.cc -- Log event log_event.cc -- Log event (a binary log consists of a stream of log events)
@item @item
matherr.c -- Handling overflow, underflow, etc. matherr.c -- Handling overflow, underflow, etc.
@item @item
...@@ -4482,7 +4468,7 @@ sql_acl.cc -- Functions related to ACL security; checks, stores, retrieves, an ...@@ -4482,7 +4468,7 @@ sql_acl.cc -- Functions related to ACL security; checks, stores, retrieves, an
@item @item
sql_analyse.cc -- Implements the PROCEDURE analyse, which analyses a query result and returns the 'optimal' data type for each result column sql_analyse.cc -- Implements the PROCEDURE analyse, which analyses a query result and returns the 'optimal' data type for each result column
@item @item
sql_base.cc -- Basic functions needed by many modules sql_base.cc -- Basic functions needed by many modules, like opening and closing tables with table cache management
@item @item
sql_cache.cc -- SQL query cache, with long comments about how caching works sql_cache.cc -- SQL query cache, with long comments about how caching works
@item @item
...@@ -4515,7 +4501,7 @@ sql_load.cc -- The LOAD DATA statement ...@@ -4515,7 +4501,7 @@ sql_load.cc -- The LOAD DATA statement
@item @item
sql_map.cc -- Memory-mapped files (not yet in use) sql_map.cc -- Memory-mapped files (not yet in use)
@item @item
sql_manager.cc -- Maintenance tasks, e.g. flushing the buffers periodically sql_manager.cc -- Maintenance tasks, e.g. flushing the buffers periodically; used with BDB table logs
@item @item
sql_olap.cc -- ROLLUP sql_olap.cc -- ROLLUP
@item @item
...@@ -4753,8 +4739,26 @@ MySQL. ...@@ -4753,8 +4739,26 @@ MySQL.
Tests in Perl and in C. Tests in Perl and in C.
@*@* @*@*
These are tests that were run once to check for bugs in various The files in this directory are test programs that can be used
scenarios: forks, locks, big records, exporting, truncating, etc. as a base to write a program to simulate problems in MySQL in various
scenarios: forks, locks, big records, exporting, truncating, and so on.
Some examples are:
@itemize @bullet
@item
connect_test.c -- test that a connect is possible
@item
insert_test.c -- test that an insert is possible
@item
list_test.c -- test that a select is possible
@item
select_test.c -- test that a select is possible
@item
showdb_test.c -- test that a show-databases is possible
@item
ssl_test.c -- test that SSL is possible
@item
thread_test.c -- test that threading is possible
@end itemize
@*@* @*@*
@subsection tools @subsection tools
...@@ -4765,8 +4769,9 @@ Tools -- well, actually, one tool. ...@@ -4765,8 +4769,9 @@ Tools -- well, actually, one tool.
The only file is: The only file is:
@itemize @bullet @itemize @bullet
@item @item
mysqlmanager.c -- A "server management daemon" by Sasha Pachev. This mysqlmanager.c -- A "server management daemon" by Sasha Pachev. This
is a tool under development and is not yet useful. is a tool under development and is not yet useful. Related to fail-safe
replication.
@end itemize @end itemize
@*@* @*@*
...@@ -4784,10 +4789,10 @@ script uses these files to create a Windows source installation. ...@@ -4784,10 +4789,10 @@ script uses these files to create a Windows source installation.
@*@* @*@*
This directory has subdirectories which are copies of the main directories. This directory has subdirectories which are copies of the main directories.
For example there is a subdirectory \VC++Files\heap, which has the For example, there is a subdirectory \VC++Files\heap, which has the Microsoft
same files as \heap. So for a description of the files in developer studio project file to compile \heap with VC++. So for a description
\VC++Files\heap, see the description of the files in \heap. The same of the files in \VC++Files\heap, see the description of the files in \heap. The
applies for almost all of VC++Files's subdirectories (bdb, client, same applies for almost all of VC++Files's subdirectories (bdb, client,
isam, libmysql, etc.). The difference is that the \VC++Files variants isam, libmysql, etc.). The difference is that the \VC++Files variants
are specifically for compilation with Microsoft Visual C++ in 32-bit are specifically for compilation with Microsoft Visual C++ in 32-bit
Windows environments. Windows environments.
...@@ -4842,7 +4847,7 @@ thr_insert_test -- (nearly empty) ...@@ -4842,7 +4847,7 @@ thr_insert_test -- (nearly empty)
@item @item
thr_test -- one short program used to test for memory-allocation bug thr_test -- one short program used to test for memory-allocation bug
@item @item
winmysqladmin -- the winmysqladmin.exe source. machine-generated? winmysqladmin -- the winmysqladmin.exe source
@end itemize @end itemize
@*@* @*@*
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment