Merge lp:~mordred/drizzle/clean-doco into lp:~drizzle-trunk/drizzle/development

[Monty Taylor]

Updates to documentation and removal of some unused options.

[Andrew Hutchings (linuxjedi)]

Fantastic start to the docs!

review: Approve

[lp:~mordred/drizzle/clean-doco]

1803. By Brian Aker <email address hidden> on 2010-09-30

Adding environmental table to utility schema.

1804. By Brian Aker <email address hidden> on 2010-09-30

1) Fixed a couple of tests that were still relying on counts of tables in
schemas.
2) Removed utility dictionary from being loaded automatically.

1805. By Brian Aker on 2010-10-04

Merge to trunk.

1806. By Monty Taylor on 2010-10-04

Merged up with trunk.

=== modified file 'docs/index.rst'
--- docs/index.rst	2010-09-26 21:24:38 +0000
+++ docs/index.rst	2010-10-04 22:47:14 +0000
@@ -49,6 +49,5 @@
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 

=== modified file 'docs/options.rst'
--- docs/options.rst	2010-09-26 20:42:38 +0000
+++ docs/options.rst	2010-10-04 22:47:14 +0000
@@ -1,8 +1,297 @@
-
 Drizzled Options
 ================
 
 There are many different options one can use to configure Drizzle.
 
+Config File Options
+-------------------
+
+.. option:: --help-extended
+  Display this help and exit after initializing plugins.
+
+.. option:: -?,--help
+  Display this help and exit.
+
+.. option:: --no-defaults
+  Configuration file defaults are not used if no-defaults is set
+
+.. option:: --defaults-file arg
+  Configuration file to use
+
+.. option:: --config-dir arg (=/etc/drizzle)
+  Base location for config files
+
+.. option:: --plugin-dir arg
+  Directory for plugins
+
+.. option:: --pid-file arg
+
+  Pid file used by drizzled.
+
+Plugin Loading Options
+----------------------
+
+.. option:: --plugin-add arg
+  Optional comma separated list of plugins to load at startup in addition
+  to the default list of plugins.
+  
+  for example: --plugin_add=crc32,console,pbxt
+
+.. option:: --plugin-remove arg
+  Optional comma separated list of plugins to not load at startup.
+  Effectively removes a plugin from the list of plugins to be loaded.
+
+  for example: --plugin_remove=syslog,md5
+
+.. option:: --plugin-load arg (=version,uuid_function,user_function,transaction_log,syslog,substr_functions,sleep,show_schema_proto,rot13,reverse_function,rand_function,multi_thread,md5,logging_stats,length,hex_functions,hello_world,filtered_replicator,errmsg_stderr,default_replicator,database_function,crc32,connection_id,compression,charlength,benchmark,ascii,)
+
+  Optional comma separated list of plugins to load at starup instead of 
+  the default plugin load list. This completely replaces the whole list.
+
 Kernel Options
 --------------
+
+.. option:: --auto-increment-increment arg (=1)
+  
+  Auto-increment columns are incremented by this
+
+.. option:: --auto-increment-offset arg (=1)
+
+  Offset added to Auto-increment columns.
+  Used when auto-increment-increment != 1
+
+.. option:: -b,--basedir arg
+
+  Path to installation directory.
+  All paths are usually resolved relative to this.
+
+.. option:: -r,--chroot arg
+
+  Chroot drizzled daemon during startup.
+
+.. option:: --collation-server arg
+
+  Set the default collation.
+
+.. option:: --completion-type arg (=0)
+
+  Default completion type.
+
+.. option:: --core-file
+
+  Write core on errors.
+
+.. option:: --datadir arg
+
+  Path to the database root.
+
+.. option:: --default-storage-engine arg
+
+  Set the default storage engine for tables.
+
+.. option:: --default-time-zone arg
+
+  Set the default time zone.
+
+.. We should really remove --exit-info as an option
+.. option:: -T,--exit-info arg
+
+  Used for debugging;  Use at your own risk!
+
+.. option:: --gdb
+
+  Set up signals usable for debugging
+
+.. option:: --lc-time-name arg
+
+  Set the language used for the month names and the days of the week.
+
+.. option:: -W [ --log-warnings ] arg
+
+  Log some not critical warnings to the log file.
+
+.. Why is this a core argument?
+.. option:: --port-open-timeout arg (=0)
+
+  Maximum time in seconds to wait for the port to become free.
+  A value of 0 means not to wait.
+
+.. option:: --secure-file-priv arg
+
+  Limit LOAD DATA, SELECT ... OUTFILE, and LOAD_FILE() to files within
+  specified directory
+
+.. Why is this still here?
+.. option:: --server-id arg (=0)
+
+  Uniquely identifies the server instance in the community of replication
+  partners.
+
+.. option:: --skip-stack-trace
+
+  Don't print a stack trace on failure.
+
+.. option:: -s,--symbolic-links
+
+  Enable symbolic link support.
+
+.. option:: --timed-mutexes
+
+  Specify whether to time mutexes (only InnoDB mutexes are currently supported)
+
+.. option::  -t,--tmpdir arg
+
+  Path for temporary files.
+
+.. option:: --transaction-isolation arg
+
+  Default transaction isolation level.
+
+.. option:: -u,--user arg
+
+  Run drizzled daemon as user.
+  
+.. option:: -V,--version
+
+  Output version information and exit.
+
+.. option:: --back-log arg (=50)
+
+  The number of outstanding connection requests Drizzle can have. This comes
+  into play when the main Drizzle thread gets very many connection requests in
+  a very short time.
+
+.. option:: --bulk-insert-buffer-size arg (=8388608)
+  
+  Size of tree cache used in bulk insert optimization. Note that this is a limit
+  per thread!
+
+.. option:: --div-precision-increment arg (=4)
+  
+  Precision of the result of '/' operator will be increased on that value.
+
+.. option:: --group-concat-max-len arg (=1024)
+
+  The maximum length of the result of function  group_concat.
+
+.. option:: --join-buffer-size arg (=131072)
+
+  The size of the buffer that is used for full joins.
+
+.. Why is this a core arg?
+.. option:: --max-allowed-packet arg (=1M)
+
+  Max packetlength to send/receive from to server.
+
+.. option:: --max-connect-errors arg (=10)
+
+  If there is more than this number of interrupted connections from a host 
+  this host will be blocked from further connections.
+
+.. option:: --max-error-count arg (=64)
+
+  Max number of errors/warnings to store for a statement.
+
+.. option:: --max-heap-table-size arg (=16M)
+
+  Don't allow creation of heap tables bigger than this.
+
+.. option:: --max-join-size arg (=2147483647)
+
+  Joins that are probably going to read more than max_join_size records return 
+  an error.
+
+.. option:: --max-length-for-sort-data arg (=1024)
+
+  Max number of bytes in sorted records.
+  
+.. option:: --max-seeks-for-key arg (=18446744073709551615)
+
+  Limit assumed max number of seeks when looking up rows based on a key
+
+.. option:: --max-sort-length arg (=1024)
+
+  The number of bytes to use when sorting BLOB or TEXT values (only the first 
+  max_sort_length bytes of each value are used; the rest are ignored).
+
+.. option:: --max-write-lock-count arg (=18446744073709551615)
+
+  After this many write locks, allow some read locks to run in between.
+
+.. option:: --min-examined-row-limit arg (=0)
+
+  Don't log queries which examine less than min_examined_row_limit rows to file.
+
+.. option:: --disable-optimizer-prune
+
+  Do not apply any heuristic(s) during query optimization to prune, thus
+  perform an exhaustive search from the optimizer search space.
+
+.. option:: --optimizer-search-depth arg (=0)
+
+  Maximum depth of search performed by the query optimizer. Values larger than
+  the number of relations in a query result in better query plans, but take
+  longer to compile a query. Smaller values than the number of tables in a
+  relation result in faster optimization, but may produce very bad query plans. 
+  If set to 0, the system will automatically pick a reasonable value; if set to
+  MAX_TABLES+2, the optimizer will switch to the original find_best (used for
+  testing/comparison).
+
+.. option:: --preload-buffer-size arg (=32768)
+
+  The size of the buffer that is allocated when preloading indexes
+
+.. option:: --query-alloc-block-size arg (=8192)
+
+  Allocation block size for query parsing and execution
+
+.. option:: --query-prealloc-size arg (=8192)
+
+  Persistent buffer for query parsing and execution
+
+.. option:: --range-alloc-block-size arg (=4096)
+
+  Allocation block size for storing ranges during optimization
+
+.. option:: --read-buffer-size arg (=131072)
+
+  Each thread that does a sequential scan allocates a buffer of this size for
+  each table it scans. If you do many sequential scans, you may want to
+  increase this value.
+
+.. option:: --read-rnd-buffer-size arg (=262144)
+
+  When reading rows in sorted order after a sort, the rows are read through
+  this buffer to avoid a disk seeks. If not set, then it's set to the value of
+  record_buffer.
+
+.. option:: --scheduler arg (=multi-thread)
+
+  Select scheduler to be used.
+
+.. option:: --sort-buffer-size arg (=2097144)
+
+  Each thread that needs to do a sort allocates a buffer of this size.
+
+.. option:: --table-definition-cache arg (=128)
+
+  The number of cached table definitions.
+
+.. option:: --table-open-cache arg (=1024)
+
+  The number of cached open tables.
+
+.. option:: --table-lock-wait-timeout arg (=50)
+
+  Timeout in seconds to wait for a table level lock before returning an error.
+  Used only if the connection has active cursors.
+
+.. option:: --thread-stack arg (=0)
+
+  The stack size for each thread. 0 means use OS default.
+
+.. option:: --tmp-table-size arg (=16M)
+
+  If an internal in-memory temporary table exceeds this size, Drizzle will
+  automatically convert it to an on-disk MyISAM table.
+

=== modified file 'docs/protocol.rst'
--- docs/protocol.rst	2010-09-26 21:24:15 +0000
+++ docs/protocol.rst	2010-10-04 22:47:14 +0000
@@ -1,12 +1,10 @@
-#
-# Drizzle Client & Protocol Library
-# 
-# Copyright (C) 2008 Eric Day ([e-mail])
-# All rights reserved.
-# 
-# Use and distribution licensed under the BSD license.  See
-# the COPYING file in this directory for full text.
-#
+.. Drizzle Client & Protocol Library
+
+.. Copyright (C) 2008 Eric Day ([e-mail])
+.. All rights reserved.
+ 
+.. Use and distribution licensed under the BSD license.  See
+.. the COPYING.BSD file in the root source directory for full text.
 
 Drizzle Protocol
 ================

=== modified file 'drizzled/drizzled.cc'
--- drizzled/drizzled.cc	2010-09-29 17:28:31 +0000
+++ drizzled/drizzled.cc	2010-10-04 22:47:14 +0000
@@ -207,7 +207,6 @@
 static bool opt_debugging= 0;
 static uint32_t wake_thread;
 static char *drizzled_chroot;
-static char *language_ptr;
 static const char *default_character_set_name;
 static const char *character_set_filesystem_name;
 static char *lc_time_names_name;
@@ -293,8 +292,7 @@
 char *default_tz_name;
 char glob_hostname[FN_REFLEN];
 
-char language[FN_REFLEN], 
-     *opt_tc_log_file;
+char *opt_tc_log_file;
 const key_map key_map_empty(0);
 key_map key_map_full(0);                        // Will be initialized later
 
@@ -1270,15 +1268,13 @@
   ("datadir", po::value<string>(),
   N_("Path to the database root."))
   ("default-storage-engine", po::value<string>(),
-  N_("Set the default storage engine (table type) for tables."))
+  N_("Set the default storage engine for tables."))
   ("default-time-zone", po::value<string>(),
   N_("Set the default time zone."))
   ("exit-info,T", po::value<long>(),
   N_("Used for debugging;  Use at your own risk!"))
   ("gdb", po::value<bool>(&opt_debugging)->default_value(false)->zero_tokens(),
   N_("Set up signals usable for debugging"))
-  ("language,L", po::value<string>(),
-  N_("(IGNORED)"))  
   ("lc-time-name", po::value<string>(),
   N_("Set the language used for the month names and the days of the week."))
   ("log-warnings,W", po::value<string>(),
@@ -1286,8 +1282,7 @@
   ("pid-file", po::value<string>(),
   N_("Pid file used by drizzled."))
   ("port-open-timeout", po::value<uint32_t>(&drizzled_bind_timeout)->default_value(0),
-  N_("Maximum time in seconds to wait for the port to become free. "
-     "(Default: no wait)"))
+  N_("Maximum time in seconds to wait for the port to become free. "))
   ("secure-file-priv", po::value<string>(),
   N_("Limit LOAD DATA, SELECT ... OUTFILE, and LOAD_FILE() to files "
      "within specified directory"))
@@ -1806,10 +1801,6 @@
    N_("Set up signals usable for debugging"),
    (char**) &opt_debugging, (char**) &opt_debugging,
    0, GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
-  {"language", 'L',
-   N_("(IGNORED)"),
-   (char**) &language_ptr, (char**) &language_ptr, 0, GET_STR, REQUIRED_ARG,
-   0, 0, 0, 0, 0, 0},
   {"lc-time-names", OPT_LC_TIME_NAMES,
    N_("Set the language used for the month names and the days of the week."),
    (char**) &lc_time_names_name,
@@ -2152,15 +2143,11 @@
   /* Things with default values that are not zero */
   drizzle_home_ptr= drizzle_home;
   pidfile_name_ptr= pidfile_name;
-  language_ptr= language;
   session_startup_options= (OPTION_AUTO_IS_NULL | OPTION_SQL_NOTES);
   refresh_version= 1L;	/* Increments on each reload */
   global_thread_id= 1UL;
   getSessionList().clear();
 
-  /* Set directory paths */
-  strncpy(language, LANGUAGE, sizeof(language)-1);
-
   /* Variables in libraries */
   default_character_set_name= "utf8";
   default_collation_name= (char *)compiled_default_collation_name;
@@ -2251,11 +2238,6 @@
                     vm["user"].as<string>().c_str(), drizzled_user);
   }
 
-  if (vm.count("language"))
-  {
-    strncpy(language, vm["language"].as<string>().c_str(), sizeof(language)-1);
-  }
-
   if (vm.count("version"))
   {
     print_version();
@@ -2382,7 +2364,6 @@
     pos[0]= FN_LIBCHAR;
     pos[1]= 0;
   }
-  internal::convert_dirname(language,language,NULL);
   (void) internal::my_load_path(drizzle_home, drizzle_home,""); // Resolve current dir
 
   fs::path pid_file_path(pidfile_name);
@@ -2403,7 +2384,6 @@
     strncat(buff, sharedir, sizeof(buff)-strlen(drizzle_home)-1);
   }
   internal::convert_dirname(buff,buff,NULL);
-  (void) internal::my_load_path(language,language,buff);
 
   if (not opt_help)
   {

=== modified file 'drizzled/set_var.cc'
--- drizzled/set_var.cc	2010-09-27 14:34:21 +0000
+++ drizzled/set_var.cc	2010-10-04 22:47:14 +0000
@@ -317,7 +317,6 @@
 #define FIXED_VARS_SIZE (sizeof(fixed_vars) / sizeof(drizzle_show_var))
 static drizzle_show_var fixed_vars[]= {
   {"back_log",                (char*) &back_log,                SHOW_INT},
-  {"language",                language,                         SHOW_CHAR},
   {"pid_file",                (char*) pidfile_name,             SHOW_CHAR},
   {"plugin_dir",              (char*) opt_plugin_dir,           SHOW_CHAR},
   {"thread_stack",            (char*) &my_thread_stack_size,    SHOW_INT},

=== modified file 'drizzled/set_var.h'
--- drizzled/set_var.h	2010-09-27 14:34:21 +0000
+++ drizzled/set_var.h	2010-10-04 22:47:14 +0000
@@ -61,7 +61,6 @@
 extern const char *in_left_expr_name;
 extern const char *in_additional_cond;
 extern const char *in_having_cond;
-extern char language[FN_REFLEN];
 extern char glob_hostname[FN_REFLEN];
 extern char drizzle_home[FN_REFLEN];
 extern char pidfile_name[FN_REFLEN];