hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Additional documentation cleanup for 2.1

Browse Source 
Mostly just reflow text (=linebreaks) for better diffs. Some small changes.
Remove Debug-And-Diagnostic-Support.md.
This commit is contained in:
Esa Korhonen
2017-04-21 11:29:58 +03:00
parent 2cc3382a46
commit f1efe72f66
12 changed files with 604 additions and 2276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/Reference/Module-Commands.md
View File

@ -1,14 +1,13 @@
# Module commands
Introduced in MaxScale 2.1, the module commands are special, module-specific
commands. They allow the modules to expand beyond the capabilities of the
module API. Currently, only MaxAdmin implements an interface to the module
commands.
commands. They allow the modules to expand beyond the capabilities of the module
API. Currently, only MaxAdmin implements an interface to the module commands.
All registered module commands can be shown with `maxadmin list commands` and
they can be executed with `maxadmin call command <module> <name> ARGS...` where
_<module>_ is the name of the module and _<name>_ is the name of the
command. _ARGS_ is a command specific list of arguments.
_<module>_ is the name of the module and _<name>_ is the name of the command.
_ARGS_ is a command specific list of arguments.
## Developer reference
@ -16,7 +15,8 @@ The module command API is defined in the _modulecmd.h_ header. It consists of
various functions to register and call module commands. Read the function
documentation in the header for more details.
The following example registers the module command _my_command_ for module _my_module_.
The following example registers the module command _my_command_ for module
_my_module_.
```
#include <maxscale/modulecmd.h>
@ -53,8 +53,9 @@ int main(int argc, char **argv)
}
```
The array _my_args_ of type _modulecmd_arg_type_t_ is used to tell what kinds of arguments
the command expects. The first argument is a boolean and the second argument is an optional string.
The array _my_args_ of type _modulecmd_arg_type_t_ is used to tell what kinds of
arguments the command expects. The first argument is a boolean and the second
argument is an optional string.
Arguments are passed to the parsing function as an array of void pointers. They
are interpreted as the types the command expects.