Use the most specific tag for ejabberd commands with several ones

This commit is contained in:
Badlop 2021-07-30 00:58:08 +02:00
parent b22779f018
commit ab5e726176
2 changed files with 13 additions and 13 deletions

View File

@ -119,12 +119,12 @@ get_commands_spec() ->
desc = "Restart ejabberd gracefully", desc = "Restart ejabberd gracefully",
module = init, function = restart, module = init, function = restart,
args = [], result = {res, rescode}}, args = [], result = {res, rescode}},
#ejabberd_commands{name = reopen_log, tags = [logs, server], #ejabberd_commands{name = reopen_log, tags = [logs],
desc = "Reopen the log files", desc = "Reopen the log files",
policy = admin, policy = admin,
module = ?MODULE, function = reopen_log, module = ?MODULE, function = reopen_log,
args = [], result = {res, rescode}}, args = [], result = {res, rescode}},
#ejabberd_commands{name = rotate_log, tags = [logs, server], #ejabberd_commands{name = rotate_log, tags = [logs],
desc = "Rotate the log files", desc = "Rotate the log files",
module = ?MODULE, function = rotate_log, module = ?MODULE, function = rotate_log,
args = [], result = {res, rescode}}, args = [], result = {res, rescode}},
@ -139,14 +139,14 @@ get_commands_spec() ->
args_example = [60, <<"Server will stop now.">>], args_example = [60, <<"Server will stop now.">>],
args = [{delay, integer}, {announcement, string}], args = [{delay, integer}, {announcement, string}],
result = {res, rescode}}, result = {res, rescode}},
#ejabberd_commands{name = get_loglevel, tags = [logs, server], #ejabberd_commands{name = get_loglevel, tags = [logs],
desc = "Get the current loglevel", desc = "Get the current loglevel",
module = ejabberd_logger, function = get, module = ejabberd_logger, function = get,
result_desc = "Tuple with the log level number, its keyword and description", result_desc = "Tuple with the log level number, its keyword and description",
result_example = warning, result_example = warning,
args = [], args = [],
result = {levelatom, atom}}, result = {levelatom, atom}},
#ejabberd_commands{name = set_loglevel, tags = [logs, server], #ejabberd_commands{name = set_loglevel, tags = [logs],
desc = "Set the loglevel", desc = "Set the loglevel",
module = ?MODULE, function = set_loglevel, module = ?MODULE, function = set_loglevel,
args_desc = ["Desired logging level: none | emergency | alert | critical " args_desc = ["Desired logging level: none | emergency | alert | critical "
@ -200,7 +200,7 @@ get_commands_spec() ->
result_example = [<<"example.com">>, <<"anon.example.com">>], result_example = [<<"example.com">>, <<"anon.example.com">>],
args = [], args = [],
result = {vhosts, {list, {vhost, string}}}}, result = {vhosts, {list, {vhost, string}}}},
#ejabberd_commands{name = reload_config, tags = [server, config], #ejabberd_commands{name = reload_config, tags = [config],
desc = "Reload config file in memory", desc = "Reload config file in memory",
module = ?MODULE, function = reload_config, module = ?MODULE, function = reload_config,
args = [], args = [],
@ -268,7 +268,7 @@ get_commands_spec() ->
args_example = ["/var/lib/ejabberd/", "example.com"], args_example = ["/var/lib/ejabberd/", "example.com"],
args = [{dir, string}, {host, string}], result = {res, rescode}}, args = [{dir, string}, {host, string}], result = {res, rescode}},
#ejabberd_commands{name = delete_mnesia, tags = [mnesia, sql], #ejabberd_commands{name = delete_mnesia, tags = [mnesia],
desc = "Delete elements in Mnesia database for a given vhost", desc = "Delete elements in Mnesia database for a given vhost",
module = ejd2sql, function = delete, module = ejd2sql, function = delete,
args_desc = ["Vhost which content will be deleted in Mnesia database"], args_desc = ["Vhost which content will be deleted in Mnesia database"],

View File

@ -84,14 +84,14 @@ code_change(_OldVsn, State, _Extra) ->
%% -- ejabberd commands %% -- ejabberd commands
get_commands_spec() -> get_commands_spec() ->
[#ejabberd_commands{name = modules_update_specs, [#ejabberd_commands{name = modules_update_specs,
tags = [admin,modules], tags = [modules],
desc = "Update the module source code from Git", desc = "Update the module source code from Git",
longdesc = "A connection to Internet is required", longdesc = "A connection to Internet is required",
module = ?MODULE, function = update, module = ?MODULE, function = update,
args = [], args = [],
result = {res, rescode}}, result = {res, rescode}},
#ejabberd_commands{name = modules_available, #ejabberd_commands{name = modules_available,
tags = [admin,modules], tags = [modules],
desc = "List the contributed modules available to install", desc = "List the contributed modules available to install",
module = ?MODULE, function = available_command, module = ?MODULE, function = available_command,
result_desc = "List of tuples with module name and description", result_desc = "List of tuples with module name and description",
@ -103,7 +103,7 @@ get_commands_spec() ->
[{name, atom}, [{name, atom},
{summary, string}]}}}}}, {summary, string}]}}}}},
#ejabberd_commands{name = modules_installed, #ejabberd_commands{name = modules_installed,
tags = [admin,modules], tags = [modules],
desc = "List the contributed modules already installed", desc = "List the contributed modules already installed",
module = ?MODULE, function = installed_command, module = ?MODULE, function = installed_command,
result_desc = "List of tuples with module name and description", result_desc = "List of tuples with module name and description",
@ -115,7 +115,7 @@ get_commands_spec() ->
[{name, atom}, [{name, atom},
{summary, string}]}}}}}, {summary, string}]}}}}},
#ejabberd_commands{name = module_install, #ejabberd_commands{name = module_install,
tags = [admin,modules], tags = [modules],
desc = "Compile, install and start an available contributed module", desc = "Compile, install and start an available contributed module",
module = ?MODULE, function = install, module = ?MODULE, function = install,
args_desc = ["Module name"], args_desc = ["Module name"],
@ -123,7 +123,7 @@ get_commands_spec() ->
args = [{module, binary}], args = [{module, binary}],
result = {res, rescode}}, result = {res, rescode}},
#ejabberd_commands{name = module_uninstall, #ejabberd_commands{name = module_uninstall,
tags = [admin,modules], tags = [modules],
desc = "Uninstall a contributed module", desc = "Uninstall a contributed module",
module = ?MODULE, function = uninstall, module = ?MODULE, function = uninstall,
args_desc = ["Module name"], args_desc = ["Module name"],
@ -131,7 +131,7 @@ get_commands_spec() ->
args = [{module, binary}], args = [{module, binary}],
result = {res, rescode}}, result = {res, rescode}},
#ejabberd_commands{name = module_upgrade, #ejabberd_commands{name = module_upgrade,
tags = [admin,modules], tags = [modules],
desc = "Upgrade the running code of an installed module", desc = "Upgrade the running code of an installed module",
longdesc = "In practice, this uninstalls and installs the module", longdesc = "In practice, this uninstalls and installs the module",
module = ?MODULE, function = upgrade, module = ?MODULE, function = upgrade,
@ -140,7 +140,7 @@ get_commands_spec() ->
args = [{module, binary}], args = [{module, binary}],
result = {res, rescode}}, result = {res, rescode}},
#ejabberd_commands{name = module_check, #ejabberd_commands{name = module_check,
tags = [admin,modules], tags = [modules],
desc = "Check the contributed module repository compliance", desc = "Check the contributed module repository compliance",
module = ?MODULE, function = check, module = ?MODULE, function = check,
args_desc = ["Module name"], args_desc = ["Module name"],