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

Add descriptions to module commands

Browse Source 
Each module command has to describe what it does. This should make module
commands self-documenting to some degree.
This commit is contained in:
Markus Mäkelä
2017-06-09 13:23:30 +03:00
parent 06995837cf
commit 45afbda100
11 changed files with 50 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
server/modules/routing/avrorouter/avro.c
View File

@ -148,7 +148,9 @@ MXS_MODULE* MXS_CREATE_MODULE()
{ MODULECMD_ARG_SERVICE | MODULECMD_ARG_NAME_MATCHES_DOMAIN, "The avrorouter service" },
{ MODULECMD_ARG_STRING, "Action, whether to 'start' or 'stop' the conversion process" }
};
modulecmd_register_command(MXS_MODULE_NAME, "convert", MODULECMD_TYPE_ACTIVE, avro_handle_convert, 2, args);
modulecmd_register_command(MXS_MODULE_NAME, "convert", MODULECMD_TYPE_ACTIVE,
avro_handle_convert, 2, args,
"Start or stop the binlog to avro conversion process");
static MXS_ROUTER_OBJECT MyObject =
{

5
server/modules/routing/debugcli/debugcmd.c
View File

@ -321,8 +321,9 @@ bool listfuncs_cb(const MODULECMD *cmd, void *data)
{
DCB *dcb = (DCB*)data;
dcb_printf(dcb, "Command: %s %s\n", cmd->domain, cmd->identifier);
dcb_printf(dcb, "Parameters: ");
dcb_printf(dcb, "Command:\t%s %s\n", cmd->domain, cmd->identifier);
dcb_printf(dcb, "Description:\t%s\n", cmd->description);
dcb_printf(dcb, "Parameters:\t");
for (int i = 0; i < cmd->arg_count_max; i++)
{