From c021cf34be02254c759a3af39bea1df4bb714aec Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 28 Nov 2024 12:16:02 +0100 Subject: [PATCH] Explain that join_cluster returns immediately (since 5a34020, 24.06) --- src/ejabberd_admin.erl | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index efc07b6af..f326d05d1 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -268,6 +268,16 @@ get_commands_spec() -> #ejabberd_commands{name = join_cluster, tags = [cluster], desc = "Join our local node into the cluster handled by Node", + longdesc = "This command returns immediately, + even before the joining process has + completed. Consequently, if you are using + `ejabberdctl` (or some `CTL_ON_` container + environment variables) to run more commands + afterwards, you may want to precede them with + the _`started`_ command to ensure the + clustering process has completed before + proceeding. For example: `join_cluster + ejabberd@main` > `started` > `list_cluster`.", note = "improved in 24.06", module = ?MODULE, function = join_cluster, args_desc = ["Nodename of the node to join"],