[v3,58/60] main: Add comments tags for online check-related settings.

Commit Message

Grant Erickson Dec. 21, 2023, 10:35 p.m. UTC

At this point, there are a sufficient number of settings in
'parse_config' that it is easy to lose track of where the block for
one settings handler ends and the next begins.

This adds comment tags for online check-related settings to make it
easy, at a glance, to see where the block for each is.
---
 src/main.c | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

Patch

diff --git a/src/main.c b/src/main.c
index 97ed3ed744b1..c8d97ee80f03 100644
--- a/src/main.c
+++ b/src/main.c
@@ -565,6 +565,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* EnableOnlineCheck */
+
 	boolean = __connman_config_get_bool(config, "General",
 					CONF_ENABLE_ONLINE_CHECK, &error);
 	if (!error) {
@@ -575,6 +577,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* EnableOnlineToReadyTransition */
+
 	boolean = __connman_config_get_bool(config, "General",
 			CONF_ENABLE_ONLINE_TO_READY_TRANSITION, &error);
 	if (!error) {
@@ -603,7 +607,7 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
-	/* OnlineCheckConnecTimeout */
+	/* OnlineCheckConnectTimeout */
 
 	real = g_key_file_get_double(config, "General",
 			CONF_ONLINE_CHECK_CONNECT_TIMEOUT, &error);
@@ -624,6 +628,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* OnlineCheckIPv4URL */
+
 	string = __connman_config_get_string(config, "General",
 					CONF_ONLINE_CHECK_IPV4_URL, &error);
 	if (!error)
@@ -634,6 +640,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* OnlineCheckIPv6URL */
+
 	string = __connman_config_get_string(config, "General",
 					CONF_ONLINE_CHECK_IPV6_URL, &error);
 	if (!error)
@@ -645,6 +653,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* OnlineCheck{Initial,Max}Interval */
+
 	integer = g_key_file_get_integer(config, "General",
 			CONF_ONLINE_CHECK_INITIAL_INTERVAL, &error);
 	if (!error && integer >= 0)
@@ -703,6 +713,8 @@  static void parse_config(GKeyFile *config)
 
 	g_clear_error(&error);
 
+	/* OnlineCheckIntervalStyle */
+
 	string = __connman_config_get_string(config, "General",
 					CONF_ONLINE_CHECK_INTERVAL_STYLE, &error);
 	if (!error) {