aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2021-07-30 00:58:08 +0200
committerBadlop <badlop@process-one.net>2021-07-30 01:14:36 +0200
commitab5e726176d7165a07faf896d8839892c03ad392 (patch)
treeb74818fcd8f1aa45db99bff6016b27e3dfb9195b
parentShow tags and definer module in generated API document when it's a gen_mod (diff)
Use the most specific tag for ejabberd commands with several ones
-rw-r--r--src/ejabberd_admin.erl12
-rw-r--r--src/ext_mod.erl14
2 files changed, 13 insertions, 13 deletions
diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl
index 2eeb97b99..23becc7f2 100644
--- a/src/ejabberd_admin.erl
+++ b/src/ejabberd_admin.erl
@@ -119,12 +119,12 @@ get_commands_spec() ->
desc = "Restart ejabberd gracefully",
module = init, function = restart,
args = [], result = {res, rescode}},
- #ejabberd_commands{name = reopen_log, tags = [logs, server],
+ #ejabberd_commands{name = reopen_log, tags = [logs],
desc = "Reopen the log files",
policy = admin,
module = ?MODULE, function = reopen_log,
args = [], result = {res, rescode}},
- #ejabberd_commands{name = rotate_log, tags = [logs, server],
+ #ejabberd_commands{name = rotate_log, tags = [logs],
desc = "Rotate the log files",
module = ?MODULE, function = rotate_log,
args = [], result = {res, rescode}},
@@ -139,14 +139,14 @@ get_commands_spec() ->
args_example = [60, <<"Server will stop now.">>],
args = [{delay, integer}, {announcement, string}],
result = {res, rescode}},
- #ejabberd_commands{name = get_loglevel, tags = [logs, server],
+ #ejabberd_commands{name = get_loglevel, tags = [logs],
desc = "Get the current loglevel",
module = ejabberd_logger, function = get,
result_desc = "Tuple with the log level number, its keyword and description",
result_example = warning,
args = [],
result = {levelatom, atom}},
- #ejabberd_commands{name = set_loglevel, tags = [logs, server],
+ #ejabberd_commands{name = set_loglevel, tags = [logs],
desc = "Set the loglevel",
module = ?MODULE, function = set_loglevel,
args_desc = ["Desired logging level: none | emergency | alert | critical "
@@ -200,7 +200,7 @@ get_commands_spec() ->
result_example = [<<"example.com">>, <<"anon.example.com">>],
args = [],
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",
module = ?MODULE, function = reload_config,
args = [],
@@ -268,7 +268,7 @@ get_commands_spec() ->
args_example = ["/var/lib/ejabberd/", "example.com"],
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",
module = ejd2sql, function = delete,
args_desc = ["Vhost which content will be deleted in Mnesia database"],
diff --git a/src/ext_mod.erl b/src/ext_mod.erl
index 5353019bb..b3e88a9cb 100644
--- a/src/ext_mod.erl
+++ b/src/ext_mod.erl
@@ -84,14 +84,14 @@ code_change(_OldVsn, State, _Extra) ->
%% -- ejabberd commands
get_commands_spec() ->
[#ejabberd_commands{name = modules_update_specs,
- tags = [admin,modules],
+ tags = [modules],
desc = "Update the module source code from Git",
longdesc = "A connection to Internet is required",
module = ?MODULE, function = update,
args = [],
result = {res, rescode}},
#ejabberd_commands{name = modules_available,
- tags = [admin,modules],
+ tags = [modules],
desc = "List the contributed modules available to install",
module = ?MODULE, function = available_command,
result_desc = "List of tuples with module name and description",
@@ -103,7 +103,7 @@ get_commands_spec() ->
[{name, atom},
{summary, string}]}}}}},
#ejabberd_commands{name = modules_installed,
- tags = [admin,modules],
+ tags = [modules],
desc = "List the contributed modules already installed",
module = ?MODULE, function = installed_command,
result_desc = "List of tuples with module name and description",
@@ -115,7 +115,7 @@ get_commands_spec() ->
[{name, atom},
{summary, string}]}}}}},
#ejabberd_commands{name = module_install,
- tags = [admin,modules],
+ tags = [modules],
desc = "Compile, install and start an available contributed module",
module = ?MODULE, function = install,
args_desc = ["Module name"],
@@ -123,7 +123,7 @@ get_commands_spec() ->
args = [{module, binary}],
result = {res, rescode}},
#ejabberd_commands{name = module_uninstall,
- tags = [admin,modules],
+ tags = [modules],
desc = "Uninstall a contributed module",
module = ?MODULE, function = uninstall,
args_desc = ["Module name"],
@@ -131,7 +131,7 @@ get_commands_spec() ->
args = [{module, binary}],
result = {res, rescode}},
#ejabberd_commands{name = module_upgrade,
- tags = [admin,modules],
+ tags = [modules],
desc = "Upgrade the running code of an installed module",
longdesc = "In practice, this uninstalls and installs the module",
module = ?MODULE, function = upgrade,
@@ -140,7 +140,7 @@ get_commands_spec() ->
args = [{module, binary}],
result = {res, rescode}},
#ejabberd_commands{name = module_check,
- tags = [admin,modules],
+ tags = [modules],
desc = "Check the contributed module repository compliance",
module = ?MODULE, function = check,
args_desc = ["Module name"],