mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-30 16:36:29 +01:00
Use the new 'note' field to annotate changes in 20.01..21.03
This commit is contained in:
parent
999d0af502
commit
c2821be94c
@ -393,10 +393,12 @@ get_commands_spec() ->
|
|||||||
args = [], result = {res, rescode}},
|
args = [], result = {res, rescode}},
|
||||||
#ejabberd_commands{name = gc, tags = [server],
|
#ejabberd_commands{name = gc, tags = [server],
|
||||||
desc = "Force full garbage collection",
|
desc = "Force full garbage collection",
|
||||||
|
note = "added in 20.01",
|
||||||
module = ?MODULE, function = gc,
|
module = ?MODULE, function = gc,
|
||||||
args = [], result = {res, rescode}},
|
args = [], result = {res, rescode}},
|
||||||
#ejabberd_commands{name = man, tags = [documentation],
|
#ejabberd_commands{name = man, tags = [documentation],
|
||||||
desc = "Generate Unix manpage for current ejabberd version",
|
desc = "Generate Unix manpage for current ejabberd version",
|
||||||
|
note = "added in 20.01",
|
||||||
module = ejabberd_doc, function = man,
|
module = ejabberd_doc, function = man,
|
||||||
args = [], result = {res, restuple}}
|
args = [], result = {res, restuple}}
|
||||||
].
|
].
|
||||||
|
@ -363,6 +363,7 @@ doc() ->
|
|||||||
"module's README file for details.")}},
|
"module's README file for details.")}},
|
||||||
{auth_password_format,
|
{auth_password_format,
|
||||||
#{value => "plain | scram",
|
#{value => "plain | scram",
|
||||||
|
note => "improved in 20.01",
|
||||||
desc =>
|
desc =>
|
||||||
?T("The option defines in what format the users passwords "
|
?T("The option defines in what format the users passwords "
|
||||||
"are stored. 'plain': The password is stored as plain text "
|
"are stored. 'plain': The password is stored as plain text "
|
||||||
@ -869,6 +870,7 @@ doc() ->
|
|||||||
"only. If not set, the value from 'cache_missed' will be used.")}},
|
"only. If not set, the value from 'cache_missed' will be used.")}},
|
||||||
{oauth_cache_rest_failure_life_time,
|
{oauth_cache_rest_failure_life_time,
|
||||||
#{value => "timeout()",
|
#{value => "timeout()",
|
||||||
|
note => "added in 21.01",
|
||||||
desc =>
|
desc =>
|
||||||
?T("The time that a failure in OAuth ReST is cached. "
|
?T("The time that a failure in OAuth ReST is cached. "
|
||||||
"The default value is 'infinity'.")}},
|
"The default value is 'infinity'.")}},
|
||||||
@ -935,12 +937,14 @@ doc() ->
|
|||||||
"connecting with IPv4, if that fails it tries using IPv6.")}},
|
"connecting with IPv4, if that fails it tries using IPv6.")}},
|
||||||
{outgoing_s2s_ipv4_address,
|
{outgoing_s2s_ipv4_address,
|
||||||
#{value => "Address",
|
#{value => "Address",
|
||||||
|
note => "added in 20.12",
|
||||||
desc =>
|
desc =>
|
||||||
?T("Specify the IPv4 address that will be used when establishing "
|
?T("Specify the IPv4 address that will be used when establishing "
|
||||||
"an outgoing S2S IPv4 connection, for example \"127.0.0.1\". "
|
"an outgoing S2S IPv4 connection, for example \"127.0.0.1\". "
|
||||||
"The default value is 'undefined'.")}},
|
"The default value is 'undefined'.")}},
|
||||||
{outgoing_s2s_ipv6_address,
|
{outgoing_s2s_ipv6_address,
|
||||||
#{value => "Address",
|
#{value => "Address",
|
||||||
|
note => "added in 20.12",
|
||||||
desc =>
|
desc =>
|
||||||
?T("Specify the IPv6 address that will be used when establishing "
|
?T("Specify the IPv6 address that will be used when establishing "
|
||||||
"an outgoing S2S IPv6 connection, for example "
|
"an outgoing S2S IPv6 connection, for example "
|
||||||
@ -1246,6 +1250,7 @@ doc() ->
|
|||||||
"keepalive requests are made.")}},
|
"keepalive requests are made.")}},
|
||||||
{sql_odbc_driver,
|
{sql_odbc_driver,
|
||||||
#{value => "Path",
|
#{value => "Path",
|
||||||
|
note => "added in 20.12",
|
||||||
desc =>
|
desc =>
|
||||||
?T("Path to the ODBC driver to use to connect to a Microsoft SQL "
|
?T("Path to the ODBC driver to use to connect to a Microsoft SQL "
|
||||||
"Server database. This option is only valid if the 'sql_type' "
|
"Server database. This option is only valid if the 'sql_type' "
|
||||||
@ -1270,6 +1275,7 @@ doc() ->
|
|||||||
"'1433' for MS SQL. The option has no effect for SQLite.")}},
|
"'1433' for MS SQL. The option has no effect for SQLite.")}},
|
||||||
{sql_prepared_statements,
|
{sql_prepared_statements,
|
||||||
#{value => "true | false",
|
#{value => "true | false",
|
||||||
|
note => "added in 20.01",
|
||||||
desc =>
|
desc =>
|
||||||
?T("This option is 'true' by default, and is useful to disable "
|
?T("This option is 'true' by default, and is useful to disable "
|
||||||
"prepared statements. The option is valid for PostgreSQL.")}},
|
"prepared statements. The option is valid for PostgreSQL.")}},
|
||||||
@ -1292,6 +1298,7 @@ doc() ->
|
|||||||
"The default value is 'localhost'.")}},
|
"The default value is 'localhost'.")}},
|
||||||
{sql_ssl,
|
{sql_ssl,
|
||||||
#{value => "true | false",
|
#{value => "true | false",
|
||||||
|
note => "improved in 20.03",
|
||||||
desc =>
|
desc =>
|
||||||
?T("Whether to use SSL encrypted connections to the "
|
?T("Whether to use SSL encrypted connections to the "
|
||||||
"SQL server. The option is only available for "
|
"SQL server. The option is only available for "
|
||||||
|
@ -1442,12 +1442,14 @@ mod_doc() ->
|
|||||||
"The default value is 'infinity'.")}},
|
"The default value is 'infinity'.")}},
|
||||||
{max_password,
|
{max_password,
|
||||||
#{value => ?T("Number"),
|
#{value => ?T("Number"),
|
||||||
|
note => "added in 21.01",
|
||||||
desc =>
|
desc =>
|
||||||
?T("This option defines the maximum number of characters "
|
?T("This option defines the maximum number of characters "
|
||||||
"that Password can have when configuring the room. "
|
"that Password can have when configuring the room. "
|
||||||
"The default value is 'infinity'.")}},
|
"The default value is 'infinity'.")}},
|
||||||
{max_captcha_whitelist,
|
{max_captcha_whitelist,
|
||||||
#{value => ?T("Number"),
|
#{value => ?T("Number"),
|
||||||
|
note => "added in 21.01",
|
||||||
desc =>
|
desc =>
|
||||||
?T("This option defines the maximum number of characters "
|
?T("This option defines the maximum number of characters "
|
||||||
"that Captcha Whitelist can have when configuring the room. "
|
"that Captcha Whitelist can have when configuring the room. "
|
||||||
|
@ -237,6 +237,7 @@ get_commands_spec() ->
|
|||||||
result = {rooms, {list, {room, string}}}},
|
result = {rooms, {list, {room, string}}}},
|
||||||
#ejabberd_commands{name = get_user_subscriptions, tags = [muc],
|
#ejabberd_commands{name = get_user_subscriptions, tags = [muc],
|
||||||
desc = "Get the list of rooms where this user is subscribed",
|
desc = "Get the list of rooms where this user is subscribed",
|
||||||
|
note = "added in 21.04",
|
||||||
module = ?MODULE, function = get_user_subscriptions,
|
module = ?MODULE, function = get_user_subscriptions,
|
||||||
args_desc = ["Username", "Server host"],
|
args_desc = ["Username", "Server host"],
|
||||||
args_example = ["tom", "example.com"],
|
args_example = ["tom", "example.com"],
|
||||||
|
@ -159,7 +159,8 @@ mod_doc() ->
|
|||||||
?T("This module allows XMPP clients to discover STUN/TURN services "
|
?T("This module allows XMPP clients to discover STUN/TURN services "
|
||||||
"and to obtain temporary credentials for using them as per "
|
"and to obtain temporary credentials for using them as per "
|
||||||
"https://xmpp.org/extensions/xep-0215.html"
|
"https://xmpp.org/extensions/xep-0215.html"
|
||||||
"[XEP-0215: External Service Discovery]."),
|
"[XEP-0215: External Service Discovery]. "
|
||||||
|
"This module is included in ejabberd since version 20.04."),
|
||||||
opts =>
|
opts =>
|
||||||
[{access,
|
[{access,
|
||||||
#{value => ?T("AccessName"),
|
#{value => ?T("AccessName"),
|
||||||
|
Loading…
Reference in New Issue
Block a user