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

chore: temporarily revert `NO_DOC` changes to fields with default value = false 

These will be dealt with in follow up PRs, by allowing the parent struct to be set to a
special `disabled` value in such cases.
This commit is contained in:
Thales Macedo Garitezi 2024-07-24 16:40:30 -03:00
parent d7112921a6
commit b3074144cc
10 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
apps/emqx/src/emqx_schema.erl
View File

@ -388,7 +388,7 @@ fields("flapping_detect") ->
boolean(), boolean(),
#{ #{
default => false, default => false,
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
desc => ?DESC(flapping_detect_enable) desc => ?DESC(flapping_detect_enable)
} }
)}, )},
@ -455,7 +455,7 @@ fields("overload_protection") ->
boolean(), boolean(),
#{ #{
desc => ?DESC(overload_protection_enable), desc => ?DESC(overload_protection_enable),
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
default => false default => false
} }
)}, )},
@ -1673,7 +1673,7 @@ fields("durable_sessions") ->
sc( sc(
boolean(), #{ boolean(), #{
desc => ?DESC(durable_sessions_enable), desc => ?DESC(durable_sessions_enable),
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
default => false default => false
} }
)}, )},
@ -2426,7 +2426,7 @@ client_ssl_opts_schema(Defaults) ->
boolean(), boolean(),
#{ #{
default => false, default => false,
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
desc => ?DESC(client_ssl_opts_schema_enable) desc => ?DESC(client_ssl_opts_schema_enable)
} }
)}, )},

7
apps/emqx_conf/src/emqx_conf_schema.erl
View File

@ -1271,6 +1271,11 @@ log_handler_common_confs(Handler, Default) ->
EnvValue = os:getenv("EMQX_DEFAULT_LOG_HANDLER"), EnvValue = os:getenv("EMQX_DEFAULT_LOG_HANDLER"),
Enable = lists:member(EnvValue, EnableValues), Enable = lists:member(EnvValue, EnableValues),
LevelDesc = maps:get(level_desc, Default, "common_handler_level"), LevelDesc = maps:get(level_desc, Default, "common_handler_level"),
EnableImportance =
case Enable of
true -> ?IMPORTANCE_NO_DOC;
false -> ?IMPORTANCE_MEDIUM
end,
[ [
{"level", {"level",
sc( sc(
@ -1287,7 +1292,7 @@ log_handler_common_confs(Handler, Default) ->
#{ #{
default => Enable, default => Enable,
desc => ?DESC("common_handler_enable"), desc => ?DESC("common_handler_enable"),
importance => ?IMPORTANCE_NO_DOC importance => EnableImportance
} }
)}, )},
{"formatter", {"formatter",

2
apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl
View File

@ -47,7 +47,7 @@ common_backend_schema(Backend) ->
mk( mk(
boolean(), #{ boolean(), #{
desc => ?DESC(backend_enable), desc => ?DESC(backend_enable),
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
required => false, required => false,
default => false default => false
} }

2
apps/emqx_ft/src/emqx_ft_schema.erl
View File

@ -66,7 +66,7 @@ fields(file_transfer) ->
boolean(), boolean(),
#{ #{
desc => ?DESC("enable"), desc => ?DESC("enable"),
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
required => false, required => false,
default => false default => false
} }

8
apps/emqx_opentelemetry/src/emqx_otel_schema.erl
View File

@ -72,7 +72,7 @@ fields("otel_metrics") ->
boolean(), boolean(),
#{ #{
default => false, default => false,
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
required => true, required => true,
desc => ?DESC(enable) desc => ?DESC(enable)
} }
@ -105,7 +105,8 @@ fields("otel_logs") ->
#{ #{
default => false, default => false,
desc => ?DESC(enable), desc => ?DESC(enable),
importance => ?IMPORTANCE_NO_DOC %% importance => ?IMPORTANCE_NO_DOC
importance => ?IMPORTANCE_HIGH
} }
)}, )},
{max_queue_size, {max_queue_size,
@ -144,7 +145,8 @@ fields("otel_traces") ->
#{ #{
default => false, default => false,
desc => ?DESC(enable), desc => ?DESC(enable),
importance => ?IMPORTANCE_NO_DOC %% importance => ?IMPORTANCE_NO_DOC
importance => ?IMPORTANCE_HIGH
} }
)}, )},
{max_queue_size, {max_queue_size,

4
apps/emqx_prometheus/src/emqx_prometheus_schema.erl
View File

@ -78,7 +78,7 @@ fields(push_gateway) ->
#{ #{
default => false, default => false,
required => true, required => true,
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
desc => ?DESC(push_gateway_enable) desc => ?DESC(push_gateway_enable)
} }
)}, )},
@ -230,7 +230,7 @@ fields(legacy_deprecated_setting) ->
#{ #{
default => false, default => false,
required => true, required => true,
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
desc => ?DESC(legacy_enable) desc => ?DESC(legacy_enable)
} }
)}, )},

2
apps/emqx_psk/src/emqx_psk_schema.erl
View File

@ -42,7 +42,7 @@ fields() ->
[ [
{enable, {enable,
?HOCON(boolean(), #{ ?HOCON(boolean(), #{
importance => ?IMPORTANCE_NO_DOC, %% importance => ?IMPORTANCE_NO_DOC,
default => false, default => false,
require => true, require => true,
desc => ?DESC(enable) desc => ?DESC(enable)

7
apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl
View File

@ -27,7 +27,8 @@ roots() ->
fields("slow_subs") -> fields("slow_subs") ->
[ [
{enable, sc(boolean(), false, enable, ?IMPORTANCE_NO_DOC)}, %% {enable, sc(boolean(), false, enable, ?IMPORTANCE_NO_DOC)},
{enable, sc(boolean(), false, enable)},
{threshold, {threshold,
sc( sc(
%% not used in a `receive ... after' block, just timestamp comparison %% not used in a `receive ... after' block, just timestamp comparison
@ -67,5 +68,5 @@ desc(_) ->
sc(Type, Default, Desc) -> sc(Type, Default, Desc) ->
?HOCON(Type, #{default => Default, desc => ?DESC(Desc)}). ?HOCON(Type, #{default => Default, desc => ?DESC(Desc)}).
sc(Type, Default, Desc, Importance) -> %% sc(Type, Default, Desc, Importance) ->
?HOCON(Type, #{default => Default, desc => ?DESC(Desc), importance => Importance}). %% ?HOCON(Type, #{default => Default, desc => ?DESC(Desc), importance => Importance}).

1
rel/config/examples/gateway.exproto.conf.example
View File

@ -16,6 +16,7 @@ gateway.exproto {
## Configurations for request to ConnectionHandler service ## Configurations for request to ConnectionHandler service
handler { handler {
address = "http://127.0.0.1:9001" address = "http://127.0.0.1:9001"
ssl_options {enable = false}
} }
listeners.tcp.default { listeners.tcp.default {

2
rel/config/examples/plugins.conf.example
View File

@ -10,7 +10,7 @@ plugins {
## Note: name and version should be what it is in the plugin application ## Note: name and version should be what it is in the plugin application
name_vsn = "my_acl-0.1.0", name_vsn = "my_acl-0.1.0",
}, },
{name_vsn = "my_rule-0.1.1"} {name_vsn = "my_rule-0.1.1", enable = false}
] ]
## The installation directory for the external plugins ## The installation directory for the external plugins