~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/debug/docs/index.rst

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Debugging Functions
 
2
===================
 
3
 
 
4
The ``debug`` plugin provides these debugging functions:
 
5
 
 
6
* ``ASSERT_AND_CRASH``
 
7
* ``BACKTRACE``
 
8
* ``TRACE``
 
9
 
 
10
These functions are for Drizzle developers.
 
11
 
 
12
.. _debug_loading:
 
13
 
 
14
Loading
 
15
-------
 
16
 
 
17
To load this plugin, start :program:`drizzled` with::
 
18
 
 
19
   --plugin-add=debug
 
20
 
 
21
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
22
 
 
23
.. _debug_authors:
 
24
 
 
25
Authors
 
26
-------
 
27
 
 
28
Brian Aker
 
29
 
 
30
.. _debug_version:
 
31
 
 
32
Version
 
33
-------
 
34
 
 
35
This documentation applies to **debug 1.1**.
 
36
 
 
37
To see which version of the plugin a Drizzle server is running, execute:
 
38
 
 
39
.. code-block:: mysql
 
40
 
 
41
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='debug'
 
42
 
 
43
Changelog
 
44
---------
 
45
 
 
46
v1.1
 
47
^^^^
 
48
* First release.