connman.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Grant Erickson <gerickson@nuovations.com>
To: connman@lists.linux.dev
Subject: [PATCH v2 58/60] main: Add comments tags for online check-related settings.
Date: Wed, 20 Dec 2023 22:40:02 -0800	[thread overview]
Message-ID: <20231221064007.2347566-59-gerickson@nuovations.com> (raw)
In-Reply-To: <20231221064007.2347566-1-gerickson@nuovations.com>

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(-)

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) {
-- 
2.42.0


  parent reply	other threads:[~2023-12-21  6:40 UTC|newest]

Thread overview: 61+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-21  6:39 [PATCH 00/60] Complete 'continuous' Online Check Mode Implementation Grant Erickson
2023-12-21  6:39 ` [PATCH v2 01/60] service: Change return type of '__connman_service_wispr_start' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 02/60] service: Sanity check the 'type' param in '__connman_service_wispr_start' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 03/60] service: Rename 'online_check_enabled_check' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 04/60] service: Change return type of 'start_online_check' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 05/60] service: Change return type of 'start_wispr_if_connected' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 06/60] service: Introduce and use online check 'active' state Grant Erickson
2023-12-21  6:39 ` [PATCH v2 07/60] service: Document 'online_check_state' 'active' member Grant Erickson
2023-12-21  6:39 ` [PATCH v2 08/60] service: Document 'online_check_is_active' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 09/60] service: Document 'online_check_active_set_value' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 10/60] service: Document 'online_check_active_{clear,set}' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 11/60] service: Rename 'start_wispr_if_connected' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 12/60] service: Refactor 'start_online_check_if_connected' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 13/60] service: Document 'start_online_check_if_connected_with_type' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 14/60] service: Add an explicit conditional for IPv6 in 'reschedule_online_check' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 15/60] session: Add service identifier to 'DBG' in four functions Grant Erickson
2023-12-21  6:39 ` [PATCH v2 16/60] service: Add online check failure service error enumeration and string Grant Erickson
2023-12-21  6:39 ` [PATCH v2 17/60] doc/service: Document online check failure service error Grant Erickson
2023-12-21  6:39 ` [PATCH v2 18/60] service: Introduce and use online check 'failures/successes' state Grant Erickson
2023-12-21  6:39 ` [PATCH v2 19/60] service: Document 'online_check_state' 'failures/successes' members Grant Erickson
2023-12-21  6:39 ` [PATCH v2 20/60] main: Introduce the 'OnlineCheck{Failures,Successes}Threshold' settings Grant Erickson
2023-12-21  6:39 ` [PATCH v2 21/60] doc: Document " Grant Erickson
2023-12-21  6:39 ` [PATCH v2 22/60] service: Add per-service online check failure threshold state Grant Erickson
2023-12-21  6:39 ` [PATCH v2 23/60] service: Document 'connman_service' 'online_check_failures_met_threshold' member Grant Erickson
2023-12-21  6:39 ` [PATCH v2 24/60] service: Document 'connman_service' 'online_check_state_ipv{4,6}' members Grant Erickson
2023-12-21  6:39 ` [PATCH v2 25/60] service: Move 'set_error' forward declaration earlier in the source Grant Erickson
2023-12-21  6:39 ` [PATCH v2 26/60] service: Capture IP configuration state by value rather than by pointer Grant Erickson
2023-12-21  6:39 ` [PATCH v2 27/60] service: Complete 'continuous' online check mode implementation Grant Erickson
2023-12-21  6:39 ` [PATCH v2 28/60] service: Document 'online_check_failures_threshold_was_met' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 29/60] service: Document 'online_check_failures_threshold_was_met_set_value' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 30/60] service: Document 'online_check_failures_threshold_was_met_{set,clear}' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 31/60] service: Document 'online_check_counter_reset' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 32/60] service: Document 'online_check_{failures,successes}_reset' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 33/60] service: Document 'online_check_state_reset' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 34/60] service: Document 'online_check_counters_log' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 35/60] service: Document 'online_check_counter_threshold_is_met' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 36/60] service: Document 'is_online_check_failure_threshold_met_predicate' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 37/60] service: Document 'online_check_failures_threshold_is_met' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 38/60] service: Document 'is_online_check_success_threshold_met_predicate' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 39/60] service: Document 'online_check_successes_threshold_is_met' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 40/60] service: Document 'online_check_counter_increment_and_log' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 41/60] service: Document 'online_check_log_success' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 42/60] service: Document 'continuous_online_check_log_{counter,failures,successes}_threshold_met' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 43/60] service: Document 'handle_{continuous,oneshot}_online_check_success' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 44/60] service: Document 'online_check_log_failure' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 45/60] service: Document 'handle_{continuous,oneshot}_online_check_failure' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 46/60] service: Add @sa documentation references Grant Erickson
2023-12-21  6:39 ` [PATCH v2 47/60] service: Document the internals of 'service_compare' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 48/60] service: Document interval assignment in '__connman_service_wispr_start' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 49/60] service: Document 'downgrade_connected_services' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 50/60] service: Document 'service_schedule_changed' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 51/60] service: Document 'service_route_changed' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 52/60] service: Add function parameter to 'default_changed' and 'service_list_sort' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 53/60] service: Add @sa documentation reference to 'current_default' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 54/60] service: Add 'DBG' to 'downgrade_connected_services' Grant Erickson
2023-12-21  6:39 ` [PATCH v2 55/60] main/service: Introduce 'OnlineCheckMode' setting Grant Erickson
2023-12-21  6:40 ` [PATCH v2 56/60] service: Leverage " Grant Erickson
2023-12-21  6:40 ` [PATCH v2 57/60] doc: Document the " Grant Erickson
2023-12-21  6:40 ` Grant Erickson [this message]
2023-12-21  6:40 ` [PATCH v2 59/60] main: Consolidate logging of online check-related settings Grant Erickson
2023-12-21  6:40 ` [PATCH v2 60/60] main: Add deprecation warnings for 'EnableOnlineCheck' and 'EnableOnlineToReadyTransition' Grant Erickson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231221064007.2347566-59-gerickson@nuovations.com \
    --to=gerickson@nuovations.com \
    --cc=connman@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).