From 0c7d35042f198287b867743f85765b6adb18361b Mon Sep 17 00:00:00 2001
From: Jan Uhlig <juhlig@hnc-agency.org>
Date: Mon, 11 Nov 2024 09:38:59 +0100
Subject: [PATCH] Add backwards compatibility note to tests

---
 test/acceptor_SUITE.erl | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/test/acceptor_SUITE.erl b/test/acceptor_SUITE.erl
index 1b0bfd4918..ba57c86f3e 100644
--- a/test/acceptor_SUITE.erl
+++ b/test/acceptor_SUITE.erl
@@ -600,6 +600,8 @@ misc_connection_alarms(_) ->
 	end,
 	Alarms0 = #{
 		test1 => Alarm1 = #{type => num_connections, threshold => 2, cooldown => 0, callback => AlarmCallback},
+		%% The test2 alarm uses the misspelled treshold key to test for backwards compatibility.
+		%% @TODO: Change to use the proper spelling when treshold gets removed in Ranch 3.0.
 		test2 => Alarm2 = #{type => num_connections, treshold => 3, cooldown => 0, callback => AlarmCallback}
 	},
 	ConnectOpts = [binary, {active, false}, {packet, raw}],