| List: | Commits | « Previous MessageNext Message » | |
| From: | paul | Date: | June 2 2006 10:56pm |
| Subject: | svn commit - mysqldoc@docsrva: r2263 - in trunk: . internals | ||
| View as plain text | |||
Author: paul Date: 2006-06-02 22:56:40 +0200 (Fri, 02 Jun 2006) New Revision: 2263 Log: r10936@frost: paul | 2006-06-02 15:56:26 -0500 Tweaks to plugin macro section. (Mostly adding markup.) Modified: trunk/ trunk/internals/internals.xml Property changes on: trunk ___________________________________________________________________ Name: svk:merge - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:10205 b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:10934 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:7663 + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:10205 b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:10936 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:7663 Modified: trunk/internals/internals.xml =================================================================== --- trunk/internals/internals.xml 2006-06-02 19:56:45 UTC (rev 2262) +++ trunk/internals/internals.xml 2006-06-02 20:56:40 UTC (rev 2263) @@ -3275,14 +3275,14 @@ Beginning with MySQL 5.1, the server supports a plugin architecture for loading plugins. For example, several storage engines have been converted to plugins, and they can be selected - of disabled at configuration time by means of command-options to - <command>configure</command>. + or disabled at configuration time by means of command-line + options to <command>configure</command>. </para> <para> This section describes the command-line options that are used to - control which plugins get built, and the Autoconf macros that - enable a plugin configuration support to be described. + control which plugins get built, and the autotools macros that + enable plugin configuration support to be described. </para> <section id="coding-guidelines-plugin-options"> @@ -3377,13 +3377,10 @@ For any plugin that is not explicitly selected or disabled, it is selected to be built dynamically if it supports dynamic build, and not built if it does not support dynamic build. - </para> - - <para> - Thus, in the case that no plugin options are given, all + (Thus, in the case that no plugin options are given, all plugins that support dynamic build are selected to be built as dynamic plugins. Plugins that do not support dynamic build are - not built. + not built.) </para> </section> @@ -3397,278 +3394,311 @@ configuration files. </para> - <para> - Declaring a plugin: - </para> + <itemizedlist> + <listitem> + <para> + Declaring a plugin: + </para> + <programlisting> -MYSQL_PLUGIN(name, long-name, description [,configlist]) +MYSQL_PLUGIN(<replaceable>name</replaceable>, <replaceable>long-name</replaceable>, <replaceable>description</replaceable> [,<replaceable>configlist</replaceable>]) </programlisting> - <para> - Each plugin is required to have - <literal>MYSQL_PLUGIN()</literal> declared first. The - <literal>configlist</literal> is an optional argument that is - a comma-separated list of configurations of which the module - is a member. - </para> + <para> + Each plugin is required to have + <literal>MYSQL_PLUGIN()</literal> declared first. + <replaceable>configlist</replaceable> is an optional + argument that is a comma-separated list of configurations + of which the module is a member. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN(ftexample, [Simple Parser], [Simple full-text parser plugin]) </programlisting> + </listitem> - <para> - Declaring a storage engine plugin: - </para> + <listitem> + <para> + Declaring a storage engine plugin: + </para> <programlisting> -MYSQL_STORAGE_ENGINE(name, legacy-opt, long-name, description [,configlist]) +MYSQL_STORAGE_ENGINE(<replaceable>name</replaceable>, <replaceable>legacy-opt</replaceable>, <replaceable>long-name</replaceable>, <replaceable>description</replaceable> [,<replaceable>configlist</replaceable>]) </programlisting> - <para> - This is a simple utility macro that calls - <literal>MYSQL_PLUGIN</literal>. It performs the bare basics - required to declare a storage engine plugin and provides - support for handling the legacy <command>configure</command> - command-line options. If the <literal>legacy-opt</literal> is - not specified, it will default to - <option>--with-<replaceable>NAME</replaceable>-storage-engine</option>. - Set the <literal>legacy-opt</literal> value to - <literal>no</literal> if you do not want to handle any legacy - option. - </para> + <para> + This is a simple utility macro that calls + <literal>MYSQL_PLUGIN</literal>. It performs the bare + basics required to declare a storage engine plugin and + provides support for handling the legacy + <command>configure</command> command-line options. If + <replaceable>legacy-opt</replaceable> is not specified, it + will default to + <option>--with-<replaceable>name</replaceable>-storage-engine</option>. + Set the <literal>legacy-opt</literal> value to + <literal>no</literal> if you do not want to handle any + legacy option. + </para> - <para> - This macro is roughly equivalent to: - </para> + <para> + This macro is roughly equivalent to: + </para> <programlisting> -MYSQL_PLUGIN(name, long-name, description) -MYSQL_PLUGIN_DEFINE(name, WITH_name_STORAGE_ENGINE) +MYSQL_PLUGIN(<replaceable>name</replaceable>, <replaceable>long-name</replaceable>, <replaceable>description</replaceable>) +MYSQL_PLUGIN_DEFINE(<replaceable>name</replaceable>, WITH_<replaceable>NAME</replaceable>_STORAGE_ENGINE) </programlisting> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_STORAGE_ENGINE(berkeley, berkeley-db, [BerkeleyDB Storage Engine], [Transactional Tables using BerkeleyDB], [max,max-no-ndb]) </programlisting> + </listitem> - <para> - Declaring a C preprocessor variable: - </para> + <listitem> + <para> + Declaring a C preprocessor variable: + </para> <programlisting> -MYSQL_PLUGIN_DEFINE(name, define-name) +MYSQL_PLUGIN_DEFINE(<replaceable>name</replaceable>, <replaceable>define-name</replaceable>) </programlisting> - <para> - When a plugin will be included in a static build, this will - set a preprocessor variable to 1. These preprocessor variables - are defined in <filename>config.h</filename>. - </para> + <para> + When a plugin will be included in a static build, this + will set a preprocessor variable to 1. These preprocessor + variables are defined in <filename>config.h</filename>. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_DEFINE(innobase, WITH_INNOBASE_STORAGE_ENGINE) </programlisting> + </listitem> - <para> - Declaring a source directory for a plugin: - </para> + <listitem> + <para> + Declaring a source directory for a plugin: + </para> <programlisting> -MYSQL_PLUGIN_DIRECTORY(name, dir-name) +MYSQL_PLUGIN_DIRECTORY(<replaceable>name</replaceable>, <replaceable>dir-name</replaceable>) </programlisting> - <para> - Includes the specified directory into the build. If a file - named <filename>configure</filename> is detected in the - directory, it will be executed as part of the - <command>configure</command> build otherwise it is assumed - that there is a <filename>Makefile</filename> to be built in - that directory. Currently, there is only support for plugin - directories to be specified in the - <filename>storage/</filename> and <filename>plugin/</filename> - subdirectories. - </para> + <para> + Includes the specified directory into the build. If a file + named <filename>configure</filename> is detected in the + directory, it will be executed as part of the + <command>configure</command> build otherwise it is assumed + that there is a <filename>Makefile</filename> to be built + in that directory. Currently, there is only support for + plugin directories to be specified in the + <filename>storage/</filename> and + <filename>plugin/</filename> subdirectories. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_DIRECTORY(archive, [storage/archive]) </programlisting> + </listitem> - <para> - Declaring a static library name for a plugin: - </para> + <listitem> + <para> + Declaring a static library name for a plugin: + </para> <programlisting> -MYSQL_PLUGIN_STATIC(name, lib-name) +MYSQL_PLUGIN_STATIC(<replaceable>name</replaceable>, <replaceable>lib-name</replaceable>) </programlisting> - <para> - Sets the <command>configure</command> substitution - @plugin_NAME_static_target@ to the supplied library name if - the plugin is a static build. It also adds the library to the - list of libraries to be linked into <command>mysqld</command>. - It may either be just the name of the library where if there - is a directory specified then the directory will be prepended - for the link or if the supplied argument is another - <command>make</command> variable or substitution, it will be - passed through as is. - </para> + <para> + Sets the <command>configure</command> substitution + <literal>@plugin_<replaceable>name</replaceable>_static_target@</literal> + to the supplied library name if the plugin is a static + build. It also adds the library to the list of libraries + to be linked into <command>mysqld</command>. It may either + be just the name of the library (where, if there is a + directory specified, the directory will be prepended for + the link) or another <command>make</command> variable or + substitution (in which case, it will be passed through as + is). + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_STATIC(archive, [libarchive.a]) MYSQL_PLUGIN_STATIC(berkeley, [[\$(bdb_libs_with_path)]]) </programlisting> + </listitem> - <para> - Declaring a dynamic library name for a plugin: - </para> + <listitem> + <para> + Declaring a dynamic library name for a plugin: + </para> <programlisting> -MYSQL_PLUGIN_DYNAMIC(name, dso-name) +MYSQL_PLUGIN_DYNAMIC(<replaceable>name</replaceable>, <replaceable>dso-name</replaceable>) </programlisting> - <para> - Sets the <command>configure</command> substitution - <literal>@plugin_NAME_shared_target@</literal> to the supplied - library name if the module is a dynamic build. - </para> + <para> + Sets the <command>configure</command> substitution + <literal>@plugin_<replaceable>name</replaceable>_shared_target@</literal> + to the supplied dynamic shared object library name if the + module is a dynamic build. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_DYNAMIC(archive, [ha_archive.la]) </programlisting> + </listitem> - <para> - Declaring a plugin as a mandatory module: - </para> + <listitem> + <para> + Declaring a plugin as a mandatory module: + </para> <programlisting> -MYSQL_PLUGIN_MANDATORY(name) +MYSQL_PLUGIN_MANDATORY(<replaceable>name</replaceable>) </programlisting> - <para> - Mandatory plugins cannot be disabled. - </para> + <para> + Mandatory plugins cannot be disabled. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_MANDATORY(myisam) </programlisting> + </listitem> - <para> - Declaring a plugin as disabled: - </para> + <listitem> + <para> + Declaring a plugin as disabled: + </para> <programlisting> -MYSQL_PLUGIN_DISABLED(name) +MYSQL_PLUGIN_DISABLED(<replaceable>name</replaceable>) </programlisting> - <para> - A disabled plugin will not be included in any build. If the - plugin has been marked as <literal>MANDATORY</literal>, it - will result in an <command>autoconf</command> error. - </para> + <para> + A disabled plugin will not be included in any build. If + the plugin has been marked as + <literal>MANDATORY</literal>, it will result in an + <command>autoconf</command> error. + </para> + </listitem> - <para> - Declaring additional plugin <command>configure</command> - actions: - </para> + <listitem> + <para> + Declaring additional plugin <command>configure</command> + actions: + </para> <programlisting> -MYSQL_PLUGIN_ACTIONS(name, configure-actions) +MYSQL_PLUGIN_ACTIONS(<replaceable>name</replaceable>, <replaceable>configure-actions</replaceable>) </programlisting> - <para> - Useful if there are additional <command>configure</command> - actions required for a plugin. The - <literal>configure-actions</literal> argument may either be - the name of an <command>autoconf</command> macro or it may be - more <command>autoconf</command> script. - </para> + <para> + This is useful if there are additional + <command>configure</command> actions required for a + plugin. The <replaceable>configure-actions</replaceable> + argument may either be the name of an + <command>autoconf</command> macro or more + <command>autoconf</command> script. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_ACTIONS(ndbcluster,[MYSQL_SETUP_NDBCLUSTER]) </programlisting> + </listitem> - <para> - Declaring plugin dependencies: - </para> + <listitem> + <para> + Declaring plugin dependencies: + </para> <programlisting> -MYSQL_PLUGIN_DEPENDS(name, dependencies) +MYSQL_PLUGIN_DEPENDS(<replaceable>name</replaceable>, <replaceable>dependencies</replaceable>) </programlisting> - <para> - Declares all plugins, in a comma-seperated list, that are - required for the named plugin to be built. If the named plugin - is selected, it will in turn enable all its depenencies. All - plugins listed as a dependency must already have been declared - with <literal>MYSQL_PLUGIN()</literal>. - </para> + <para> + Declares all plugins, in a comma-separated list, that are + required for the named plugin to be built. If the named + plugin is selected, it will in turn enable all its + depenencies. All plugins listed as a dependency must + already have been declared with + <literal>MYSQL_PLUGIN()</literal>. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_PLUGIN_DEPENDS(ndbcluster, [partition]) </programlisting> + </listitem> - <para> - Performing the magic: - </para> + <listitem> + <para> + Performing the magic: + </para> <programlisting> -MYSQL_CONFIGURE_PLUGINS(default-names) +MYSQL_CONFIGURE_PLUGINS(<replaceable>default-names</replaceable>) </programlisting> - <para> - Actually performs the task of generating the shell scripts for - <command>configure</command> based upon the declarations made - previously. It emits the shell code neccessary to check the - options and sets the variables accordingly. - </para> + <para> + Actually performs the task of generating the shell scripts + for <command>configure</command> based upon the + declarations made previously. It emits the shell code + neccessary to check the options and sets the variables + accordingly. + </para> - <para> - Example: - </para> + <para> + Example: + </para> <programlisting> MYSQL_CONFIGURE_PLUGINS([none]) </programlisting> + </listitem> + </itemizedlist> + <para> - <command>configure</command> errors: + Plugin-related <command>configure</command> errors: </para> <itemizedlist> @@ -3684,7 +3714,7 @@ <listitem> <para> When any of the plugins specified in the dependency list - doesn't exist, <command>configure</command> aborts with an + don't exist, <command>configure</command> aborts with an error. </para> </listitem> @@ -3692,7 +3722,7 @@ <listitem> <para> When a mandatory plugin is specified in - <option>--without-plugin-<replaceable>NAME</replaceable></option>, + <option>--without-plugin-<replaceable>PLUGIN</replaceable></option>, <command>configure</command> aborts with an error. </para> </listitem> @@ -3701,7 +3731,7 @@ <para> When a disabled plugin is specified in <option>--with-modules=... </option> or - <option>--with-plugin=<replaceable>NAME</replaceable></option>, + <option>--with-plugin=<replaceable>PLUGIN</replaceable></option>, <command>configure</command> reports an error. </para> </listitem> @@ -3710,7 +3740,7 @@ <para> When an optional plugin that may only be built dynamically is specified in <option>--with-plugins=...</option> or - <option>--with-plugin-<replaceable>NAME</replaceable></option>, + <option>--with-plugin-<replaceable>PLUGIN</replaceable></option>, <command>configure</command> emits a warning and continues to configure the plugin for dynamic build. </para> @@ -3719,9 +3749,9 @@ <listitem> <para> When an optional plugin that may only be built statically - is not specified in <option>--with-plugins=...</option> - nor - <option>--without-plugin-<replaceable>NAME</replaceable></option>, + is specified neither in + <option>--with-plugins=...</option> nor + <option>--without-plugin-<replaceable>PLUGIN</replaceable></option>, <command>configure</command> emits a warning but should proceed anyway. </para>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2263 - in trunk: . internals | paul | 2 Jun |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.693 sec. using MySQL 5.1.14-beta-log