From c2821be94c1ec9e591a08e261892bd350704d4dd Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 5 May 2021 11:43:49 +0200 Subject: [PATCH] Use the new 'note' field to annotate changes in 20.01..21.03 --- src/ejabberd_admin.erl | 2 ++ src/ejabberd_options_doc.erl | 7 +++++++ src/mod_muc.erl | 2 ++ src/mod_muc_admin.erl | 1 + src/mod_stun_disco.erl | 3 ++- 5 files changed, 14 insertions(+), 1 deletion(-) diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index 01ecbcae5..84b85b061 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -393,10 +393,12 @@ get_commands_spec() -> args = [], result = {res, rescode}}, #ejabberd_commands{name = gc, tags = [server], desc = "Force full garbage collection", + note = "added in 20.01", module = ?MODULE, function = gc, args = [], result = {res, rescode}}, #ejabberd_commands{name = man, tags = [documentation], desc = "Generate Unix manpage for current ejabberd version", + note = "added in 20.01", module = ejabberd_doc, function = man, args = [], result = {res, restuple}} ]. diff --git a/src/ejabberd_options_doc.erl b/src/ejabberd_options_doc.erl index 2addfd19c..2577c4965 100644 --- a/src/ejabberd_options_doc.erl +++ b/src/ejabberd_options_doc.erl @@ -363,6 +363,7 @@ doc() -> "module's README file for details.")}}, {auth_password_format, #{value => "plain | scram", + note => "improved in 20.01", desc => ?T("The option defines in what format the users passwords " "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.")}}, {oauth_cache_rest_failure_life_time, #{value => "timeout()", + note => "added in 21.01", desc => ?T("The time that a failure in OAuth ReST is cached. " "The default value is 'infinity'.")}}, @@ -935,12 +937,14 @@ doc() -> "connecting with IPv4, if that fails it tries using IPv6.")}}, {outgoing_s2s_ipv4_address, #{value => "Address", + note => "added in 20.12", desc => ?T("Specify the IPv4 address that will be used when establishing " "an outgoing S2S IPv4 connection, for example \"127.0.0.1\". " "The default value is 'undefined'.")}}, {outgoing_s2s_ipv6_address, #{value => "Address", + note => "added in 20.12", desc => ?T("Specify the IPv6 address that will be used when establishing " "an outgoing S2S IPv6 connection, for example " @@ -1246,6 +1250,7 @@ doc() -> "keepalive requests are made.")}}, {sql_odbc_driver, #{value => "Path", + note => "added in 20.12", desc => ?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' " @@ -1270,6 +1275,7 @@ doc() -> "'1433' for MS SQL. The option has no effect for SQLite.")}}, {sql_prepared_statements, #{value => "true | false", + note => "added in 20.01", desc => ?T("This option is 'true' by default, and is useful to disable " "prepared statements. The option is valid for PostgreSQL.")}}, @@ -1292,6 +1298,7 @@ doc() -> "The default value is 'localhost'.")}}, {sql_ssl, #{value => "true | false", + note => "improved in 20.03", desc => ?T("Whether to use SSL encrypted connections to the " "SQL server. The option is only available for " diff --git a/src/mod_muc.erl b/src/mod_muc.erl index 80fb7d9e3..0139db430 100644 --- a/src/mod_muc.erl +++ b/src/mod_muc.erl @@ -1442,12 +1442,14 @@ mod_doc() -> "The default value is 'infinity'.")}}, {max_password, #{value => ?T("Number"), + note => "added in 21.01", desc => ?T("This option defines the maximum number of characters " "that Password can have when configuring the room. " "The default value is 'infinity'.")}}, {max_captcha_whitelist, #{value => ?T("Number"), + note => "added in 21.01", desc => ?T("This option defines the maximum number of characters " "that Captcha Whitelist can have when configuring the room. " diff --git a/src/mod_muc_admin.erl b/src/mod_muc_admin.erl index 38d3a8220..a595d00c3 100644 --- a/src/mod_muc_admin.erl +++ b/src/mod_muc_admin.erl @@ -237,6 +237,7 @@ get_commands_spec() -> result = {rooms, {list, {room, string}}}}, #ejabberd_commands{name = get_user_subscriptions, tags = [muc], desc = "Get the list of rooms where this user is subscribed", + note = "added in 21.04", module = ?MODULE, function = get_user_subscriptions, args_desc = ["Username", "Server host"], args_example = ["tom", "example.com"], diff --git a/src/mod_stun_disco.erl b/src/mod_stun_disco.erl index 885fb0a75..bb701b96b 100644 --- a/src/mod_stun_disco.erl +++ b/src/mod_stun_disco.erl @@ -159,7 +159,8 @@ mod_doc() -> ?T("This module allows XMPP clients to discover STUN/TURN services " "and to obtain temporary credentials for using them as per " "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 => [{access, #{value => ?T("AccessName"),