Explain that reopen_log and rotate_log only affect some modules (#4156)

This commit is contained in:
Badlop 2024-02-06 12:09:48 +01:00
parent 2979fb4a9b
commit 70bf316f9d
1 changed files with 7 additions and 3 deletions

View File

@ -126,15 +126,19 @@ get_commands_spec() ->
module = ?MODULE, function = restart,
args = [], result = {res, rescode}},
#ejabberd_commands{name = reopen_log, tags = [logs],
desc = "Reopen the log files after being renamed",
longdesc = "This can be useful when an external tool is "
desc = "Reopen maybe the log files after being renamed",
longdesc = "Has no effect on ejabberd main log files, "
"only on log files generated by some modules.\n"
"This can be useful when an external tool is "
"used for log rotation. See "
"[Log Files](https://docs.ejabberd.im/admin/guide/troubleshooting/#log-files).",
policy = admin,
module = ?MODULE, function = reopen_log,
args = [], result = {res, rescode}},
#ejabberd_commands{name = rotate_log, tags = [logs],
desc = "Rotate the log files",
desc = "Rotate maybe log file of some module",
longdesc = "Has no effect on ejabberd main log files, "
"only on log files generated by some modules.",
module = ?MODULE, function = rotate_log,
args = [], result = {res, rescode}},
#ejabberd_commands{name = stop_kindly, tags = [server],