Merge pull request #12483 from zmstone/0205-docs-fix-typos

Improve emqx ctl conf cluster_sync CLI and help text
This commit is contained in:
zhongwencool 2024-02-06 09:11:35 +08:00 committed by GitHub
commit d3db53626b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 15 additions and 7 deletions

View File

@ -89,6 +89,10 @@ admins(["skip", Node0]) ->
emqx_cluster_rpc:skip_failed_commit(Node), emqx_cluster_rpc:skip_failed_commit(Node),
status(); status();
admins(["tnxid", TnxId0]) -> admins(["tnxid", TnxId0]) ->
%% changed to 'inspect' in 5.6
%% TODO: delete this clause in 5.7
admins(["inspect", TnxId0]);
admins(["inspect", TnxId0]) ->
TnxId = list_to_integer(TnxId0), TnxId = list_to_integer(TnxId0),
print(emqx_cluster_rpc:query(TnxId)); print(emqx_cluster_rpc:query(TnxId));
admins(["fast_forward"]) -> admins(["fast_forward"]) ->
@ -145,12 +149,14 @@ usage_conf() ->
usage_sync() -> usage_sync() ->
[ [
{"conf cluster_sync status", "Show cluster config sync status summary"}, {"conf cluster_sync status", "Show cluster config sync status summary for all nodes."},
{"conf cluster_sync skip [node]", "Increase one commit on specific node"}, {"conf cluster_sync inspect <ID>",
{"conf cluster_sync tnxid <TnxId>", "Inspect detailed information of the config change transaction at the given commit ID"},
"Display detailed information of the config change transaction at TnxId"}, {"conf cluster_sync skip [node]",
{"conf cluster_sync fast_forward [node] [tnx_id]", "Increment the (currently failing) commit on the given node.\n"
"Fast-forward config change transaction to tnx_id on the given node." "WARNING: This results in inconsistent configs among the clustered nodes."},
{"conf cluster_sync fast_forward [node] <ID>",
"Fast-forward config change to the given commit ID on the given node.\n"
"WARNING: This results in inconsistent configs among the clustered nodes."} "WARNING: This results in inconsistent configs among the clustered nodes."}
]. ].

View File

@ -0,0 +1,2 @@
Renamed `emqx ctl conf cluster_sync tnxid ID` to `emqx ctl conf cluster_sync inspect ID`.
For backward compatibility, `tnxid` is kept, but considered deprecated and will be removed in 5.7.

View File

@ -8,7 +8,7 @@ auto_subscribe.label:
nl.desc: nl.desc:
"""Default value 0. """Default value 0.
MQTT v3.1.1 if you subscribe to the topic published by yourself, you will receive all messages that you published. MQTT v3.1.1: if you subscribe to the topic published by yourself, you will receive all messages that you published.
MQTT v5: if you set this option as 1 when subscribing, the server will not forward the message you published to you.""" MQTT v5: if you set this option as 1 when subscribing, the server will not forward the message you published to you."""
nl.label: nl.label: