diff --git a/Documentation/Reference/MaxAdmin.md b/Documentation/Reference/MaxAdmin.md index d4c710560..d65ebe41f 100644 --- a/Documentation/Reference/MaxAdmin.md +++ b/Documentation/Reference/MaxAdmin.md @@ -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 ` in -maxadmin. The __ is the name of the module and __ is the +To call a module commands, execute `call command ` in +maxadmin. The __ is the name of the module and __ is the command that should be called. The commands take a variable amount of arguments which are explained in the output of `list commands`. diff --git a/Documentation/Reference/Module-Commands.md b/Documentation/Reference/Module-Commands.md index 7e4a94f76..624ad0af8 100644 --- a/Documentation/Reference/Module-Commands.md +++ b/Documentation/Reference/Module-Commands.md @@ -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 ARGS...` where -__ is the domain where the module registered the command and __ -is the name of the command. _ARGS_ is a function specific list of arguments. +they can be executed with `maxadmin call command ARGS...` where +__ is the name of the module and __ 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 diff --git a/Documentation/Release-Notes/MaxScale-2.1.0-Release-Notes.md b/Documentation/Release-Notes/MaxScale-2.1.0-Release-Notes.md index 3c94ee627..9f7683a2f 100644 --- a/Documentation/Release-Notes/MaxScale-2.1.0-Release-Notes.md +++ b/Documentation/Release-Notes/MaxScale-2.1.0-Release-Notes.md @@ -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 ARGS...` where -__ is the domain where the module registered the function and __ -is the name of the function. _ARGS_ is a command specific list of arguments. +they can be executed with `maxadmin call command ARGS...` where +__ is the name of the module and __ 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. diff --git a/server/modules/routing/debugcli/debugcmd.c b/server/modules/routing/debugcli/debugcmd.c index 7cac25c4a..3bae1fb39 100644 --- a/server/modules/routing/debugcli/debugcmd.c +++ b/server/modules/routing/debugcli/debugcmd.c @@ -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}