From 0e62f4e70d24c15c7f29a7dc57fa29be35bf4bac Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 21 Jun 2022 21:04:13 +0200 Subject: [PATCH] docs: escape as \ --- apps/emqx/i18n/emqx_schema_i18n.conf | 4 ++-- apps/emqx/src/emqx_schema.erl | 2 +- apps/emqx_conf/i18n/emqx_conf_schema.conf | 2 +- apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apps/emqx/i18n/emqx_schema_i18n.conf b/apps/emqx/i18n/emqx_schema_i18n.conf index 5d85829f4..24274930d 100644 --- a/apps/emqx/i18n/emqx_schema_i18n.conf +++ b/apps/emqx/i18n/emqx_schema_i18n.conf @@ -2000,7 +2000,7 @@ When publishing or subscribing, prefix all topics with a mountpoint string. The prefixed string will be removed from the topic name when the message is delivered to the subscriber. The mountpoint is a way that users can use to implement isolation of message routing between different listeners. -For example if a client A subscribes to `t` with `listeners.tcp..mountpoint` +For example if a client A subscribes to `t` with `listeners.tcp.\.mountpoint` set to `some_tenant`, then the client actually subscribes to the topic `some_tenant/t`. Similarly, if another client B (connected to the same listener as the client A) sends a message to topic `t`, the message is routed @@ -2017,7 +2017,7 @@ Variables in mountpoint string: 将消息传递给订阅者时，将从主题名称中删除带前缀的字符串。挂载点是一种用户可以用来实现不同侦听器之间消息路由隔离的方法。 -例如，如果客户机 A 使用 listeners.tcp..mountpoint 设置为'some_tenant'，那么客户端实际上订阅了主题'some_tenant/t'。
+例如，如果客户机 A 使用 listeners.tcp.\.mountpoint 设置为'some_tenant'，那么客户端实际上订阅了主题'some_tenant/t'。
类似地，如果另一个客户端B（与客户端A连接到同一个侦听器）向主题 't' 发送消息，该消息将路由到所有订阅了'some_租户/t'的客户端，因此客户端 A 将接收主题名为't'的消息
设置为"" 以禁用该功能
diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl index 04e33699f..f0655d438 100644 --- a/apps/emqx/src/emqx_schema.erl +++ b/apps/emqx/src/emqx_schema.erl @@ -1650,7 +1650,7 @@ desc("zone") -> "A `Zone` defines a set of configuration items (such as the maximum number of connections)" " that can be shared between multiple listeners.\n\n" "`Listener` can refer to a `Zone` through the configuration item" - " listener...zone.\n\n" + " listener.\\.\\.zone.\n\n" "The configs defined in the zones will override the global configs with the same key.\n\n" "For example, given the following config:\n" "```\n" diff --git a/apps/emqx_conf/i18n/emqx_conf_schema.conf b/apps/emqx_conf/i18n/emqx_conf_schema.conf index f5f26d522..f73d69037 100644 --- a/apps/emqx_conf/i18n/emqx_conf_schema.conf +++ b/apps/emqx_conf/i18n/emqx_conf_schema.conf @@ -400,7 +400,7 @@ or hostname.""" en: """Unique name of the EMQX node. It must follow %name%@FQDN or %name%@IPv4 format. """ - zh: """节点名。格式为 @。其中 可以是 IP 地址，也可以是 FQDN。 + zh: """节点名。格式为 \@\。其中 可以是 IP 地址，也可以是 FQDN。 详见 http://erlang.org/doc/reference_manual/distributed.html。 """ } diff --git a/apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf b/apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf index 7f8bd6dcf..32d8cfe48 100644 --- a/apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf +++ b/apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf @@ -602,14 +602,14 @@ When set to false clients will be allowed to connect without authen desc { en: """When publishing or subscribing, prefix all topics with a mountpoint string. The prefixed string will be removed from the topic name when the message is delivered to the subscriber. The mountpoint is a way that users can use to implement isolation of message routing between different listeners. -For example if a client A subscribes to `t` with `listeners.tcp..mountpoint` set to `some_tenant`, then the client actually subscribes to the topic `some_tenant/t`. Similarly, if another client B (connected to the same listener as the client A) sends a message to topic `t`, the message is routed to all the clients subscribed `some_tenant/t`, so client A will receive the message, with topic name `t`. Set to `\"\"` to disable the feature. +For example if a client A subscribes to `t` with `listeners.tcp.\.mountpoint` set to `some_tenant`, then the client actually subscribes to the topic `some_tenant/t`. Similarly, if another client B (connected to the same listener as the client A) sends a message to topic `t`, the message is routed to all the clients subscribed `some_tenant/t`, so client A will receive the message, with topic name `t`. Set to `\"\"` to disable the feature. Variables in mountpoint string: - ${clientid}: clientid - ${username}: username """ zh: """发布或订阅时，在所有主题前增加前缀字符串。 当消息投递给订阅者时，前缀字符串将从主题名称中删除。挂载点是用户可以用来实现不同监听器之间的消息路由隔离的一种方式。 -例如，如果客户端 A 在 `listeners.tcp..mountpoint` 设置为 `some_tenant` 的情况下订阅 `t`，则客户端实际上订阅了 `some_tenant/t` 主题。 类似地，如果另一个客户端 B（连接到与客户端 A 相同的侦听器）向主题 `t` 发送消息，则该消息被路由到所有订阅了 `some_tenant/t` 的客户端，因此客户端 A 将收到该消息，带有 主题名称`t`。 设置为 `\"\"` 以禁用该功能。 +例如，如果客户端 A 在 `listeners.tcp.\.mountpoint` 设置为 `some_tenant` 的情况下订阅 `t`，则客户端实际上订阅了 `some_tenant/t` 主题。 类似地，如果另一个客户端 B（连接到与客户端 A 相同的侦听器）向主题 `t` 发送消息，则该消息被路由到所有订阅了 `some_tenant/t` 的客户端，因此客户端 A 将收到该消息，带有 主题名称`t`。 设置为 `\"\"` 以禁用该功能。 挂载点字符串中可用的变量： - ${clientid}：clientid - ${username}：用户名