Rename domain to module

The module commands now use the module name as the replacement for
domain. The domain itself wasn't any better when compared to the module
name.
This commit is contained in:
Markus Mäkelä 2017-01-27 16:34:06 +02:00
parent 5972d87fba
commit 7dc5698c90
4 changed files with 15 additions and 17 deletions

View File

@ -409,10 +409,10 @@ List the status of the polling threads in MaxScale
'commands' - List registered commands
Usage list commands [DOMAIN] [COMMAND]
Usage list commands [MODULE] [COMMAND]
Parameters:
DOMAIN Regular expressions for filtering module domains
COMMAND Regular expressions for filtering module commands
MODULE Regular expressions for filtering module names
COMMAND Regular expressions for filtering module command names
MaxScale>
```
@ -1437,8 +1437,8 @@ sort of arguments they take.
If no module commands are registered, no output will be generated. Refer to the
module specific documentation for more details about module commands.
To call a module commands, execute `call command <domain> <command>` in
maxadmin. The _<domain>_ is the name of the module and _<command>_ is the
To call a module commands, execute `call command <module> <command>` in
maxadmin. The _<module>_ is the name of the module and _<command>_ is the
command that should be called. The commands take a variable amount of arguments
which are explained in the output of `list commands`.

View File

@ -6,9 +6,9 @@ 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 <domain> <name> ARGS...` where
_<domain>_ is the domain where the module registered the command and _<name>_
is the name of the command. _ARGS_ is a function specific list of arguments.
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.
## Developer reference
@ -16,9 +16,7 @@ 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.
**Note:** The domain should match the name of the module.
The following example registers the module command _my_command_ in the _my_module_ domain.
The following example registers the module command _my_command_ for module _my_module_.
```
#include <maxscale/modulecmd.h>

View File

@ -206,9 +206,9 @@ 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 <domain> <name> ARGS...` where
_<domain>_ is the domain where the module registered the function and _<name>_
is the name of the function. _ARGS_ is a command specific list of arguments.
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.
Read [Module Commands](../Reference/Module-Commands.md) documentation for more details.

View File

@ -414,10 +414,10 @@ struct subcommand listoptions[] =
{
"commands", 0, 2, dListCommands,
"List registered commands",
"Usage list commands [DOMAIN] [COMMAND]\n\n"
"Usage list commands [MODULE] [COMMAND]\n\n"
"Parameters:\n"
"DOMAIN Regular expressions for filtering module domains\n"
"COMMAND Regular expressions for filtering module commands\n",
"MODULE Regular expressions for filtering module names\n"
"COMMAND Regular expressions for filtering module command names\n",
{ARG_TYPE_STRING, ARG_TYPE_STRING}
},
{ EMPTY_OPTION}