yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(i18n): fix missing docs for gateway configs

This commit is contained in:
Zaiming (Stone) Shi 2023-03-28 23:14:01 +02:00
parent bdd3960e17
commit 5f6d318cf0
4 changed files with 27 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
apps/emqx_gateway/src/emqx_gateway_schema.erl
View File

@ -453,20 +453,20 @@ fields(translator) ->
];
fields(udp_listeners) ->
[
{udp, sc(map(name, ref(udp_listener)), #{desc => ?DESC(udp_listener)})},
{dtls, sc(map(name, ref(dtls_listener)), #{desc => ?DESC(dtls_listener)})}
{udp, sc(map(name, ref(udp_listener)), #{desc => ?DESC(listener_name_to_settings_map)})},
{dtls, sc(map(name, ref(dtls_listener)), #{desc => ?DESC(listener_name_to_settings_map)})}
];
fields(tcp_listeners) ->
[
{tcp, sc(map(name, ref(tcp_listener)), #{desc => ?DESC(tcp_listener)})},
{ssl, sc(map(name, ref(ssl_listener)), #{desc => ?DESC(ssl_listener)})}
{tcp, sc(map(name, ref(tcp_listener)), #{desc => ?DESC(listener_name_to_settings_map)})},
{ssl, sc(map(name, ref(ssl_listener)), #{desc => ?DESC(listener_name_to_settings_map)})}
];
fields(tcp_udp_listeners) ->
[
{tcp, sc(map(name, ref(tcp_listener)), #{desc => ?DESC(tcp_listener)})},
{ssl, sc(map(name, ref(ssl_listener)), #{desc => ?DESC(ssl_listener)})},
{udp, sc(map(name, ref(udp_listener)), #{desc => ?DESC(udp_listener)})},
{dtls, sc(map(name, ref(dtls_listener)), #{desc => ?DESC(dtls_listener)})}
{tcp, sc(map(name, ref(tcp_listener)), #{desc => ?DESC(listener_name_to_settings_map)})},
{ssl, sc(map(name, ref(ssl_listener)), #{desc => ?DESC(listener_name_to_settings_map)})},
{udp, sc(map(name, ref(udp_listener)), #{desc => ?DESC(listener_name_to_settings_map)})},
{dtls, sc(map(name, ref(dtls_listener)), #{desc => ?DESC(listener_name_to_settings_map)})}
];
fields(tcp_listener) ->
%% some special configs for tcp listener
@ -558,19 +558,19 @@ desc(udp_listeners) ->
desc(tcp_listeners) ->
"Settings for the TCP listeners.";
desc(tcp_udp_listeners) ->
"Settings for the listeners.";
"Settings for TCP and UDP listeners.";
desc(tcp_listener) ->
"Settings for the TCP listener.";
"Settings for TCP listener.";
desc(ssl_listener) ->
"Settings for the SSL listener.";
"Settings for SSL listener.";
desc(udp_listener) ->
"Settings for the UDP listener.";
"Settings for UDP listener.";
desc(dtls_listener) ->
"Settings for the DTLS listener.";
"Settings for DTLS listener.";
desc(udp_opts) ->
"Settings for the UDP sockets.";
"Settings for UDP sockets.";
desc(dtls_opts) ->
"Settings for the DTLS protocol.";
"Settings for DTLS protocol.";
desc(_) ->
undefined.
@ -625,7 +625,7 @@ mountpoint(Default) ->
binary(),
#{
default => iolist_to_binary(Default),
desc => ?DESC(gateway_common_mountpoint)
desc => ?DESC(gateway_mountpoint)
}
).
@ -674,7 +674,7 @@ common_listener_opts() ->
binary(),
#{
default => undefined,
desc => ?DESC(gateway_common_listener_mountpoint)
desc => ?DESC(gateway_mountpoint)
}
)},
{access_rules,

36
rel/i18n/emqx_gateway_schema.hocon
View File

@ -370,13 +370,6 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
}
}
gateway_common_mountpoint {
desc {
en: """"""
zh: """"""
}
}
gateway_common_clientinfo_override {
desc {
en: """ClientInfo override."""
@ -431,10 +424,10 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
}
}
tcp_listener {
listener_name_to_settings_map{
desc {
en: """"""
zh: """"""
en: """A map from listener names to listener settings."""
zh: """从监听器名称到配置参数的映射。"""
}
}
@ -468,13 +461,6 @@ EMQX will close the TCP connection if proxy protocol packet is not received with
}
}
ssl_listener {
desc {
en: """"""
zh: """"""
}
}
ssl_listener_options {
desc {
en: """SSL Socket options."""
@ -482,13 +468,6 @@ EMQX will close the TCP connection if proxy protocol packet is not received with
}
}
udp_listener {
desc {
en: """"""
zh: """"""
}
}
udp_listener_udp_opts {
desc {
en: """Settings for the UDP sockets."""
@ -533,13 +512,6 @@ See: https://erlang.org/doc/man/inet.html#setopts-2"""
}
}
dtls_listener {
desc {
en: """"""
zh: """"""
}
}
dtls_listener_acceptors {
desc {
en: """Size of the acceptor pool."""
@ -592,7 +564,7 @@ When set to <code>false</code> clients will be allowed to connect without authen
}
}
gateway_common_listener_mountpoint {
gateway_mountpoint {
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.

4
rel/i18n/emqx_rule_api_schema.hocon
View File

@ -35,8 +35,8 @@ emqx_rule_api_schema {
event_username {
desc {
en: "The User Name"
zh: ""
en: "Username"
zh: "用户名"
}
label: {
en: "Username"

7
scripts/check-i18n-style.escript
View File

@ -4,11 +4,12 @@
-mode(compile).
-define(YELLOW, "\e[33m").
% -define(YELLOW, "\e[33m"). % not used
-define(RED, "\e[31m").
-define(RESET, "\e[39m").
main([Files0]) ->
io:format(user, "checking i18n file styles", []),
_ = put(errors, 0),
Files = string:tokens(Files0, "\n"),
ok = load_hocon(),
@ -48,7 +49,7 @@ logerr(Fmt, Args) ->
check(File) ->
io:format(user, "checking: ~s~n", [File]),
io:format(user, ".", []),
{ok, C} = hocon:load(File),
maps:foreach(fun check_one_field/2, C),
ok.
@ -86,7 +87,7 @@ do_check_desc(Name, _) ->
die("~s: missing 'zh' or 'en'~n", [Name]).
check_desc_string(Name, Tr, <<>>) ->
io:format(standard_error, ?YELLOW ++ "WARNING: ~s.~s: empty string~n" ++ ?RESET, [Name, Tr]);
logerr("~s.~s: empty string~n", [Name, Tr]);
check_desc_string(Name, Tr, BinStr) ->
Str = unicode:characters_to_list(BinStr, utf8),
Err = fun(Reason) ->