[58/90] connection: Document 'gateway_config_state' finite state machine.

From: Grant Erickson <erick205@umn.edu>

From: Grant Erickson <gerickson@nuovations.com>
To: connman@lists.linux.dev
Subject: [PATCH 58/90] connection: Document 'gateway_config_state' finite
 state machine.
Date: Wed,  6 Dec 2023 15:50:24 -0800
Message-ID: <20231206235056.322578-62-gerickson@nuovations.com>
In-Reply-To: <20231206235056.322578-1-gerickson@nuovations.com>
References: <20231206235056.322578-1-gerickson@nuovations.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Message ID	20231206235056.322578-62-gerickson@nuovations.com (mailing list archive)
State	Not Applicable, archived
Headers	show Received: from mohas.pair.com (mohas.pair.com [209.68.5.112]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AAE622FE0D for <connman@lists.linux.dev>; Wed, 6 Dec 2023 23:51:22 +0000 (UTC) From: Grant Erickson <gerickson@nuovations.com> To: connman@lists.linux.dev Subject: [PATCH 58/90] connection: Document 'gateway_config_state' finite state machine. Date: Wed, 6 Dec 2023 15:50:24 -0800 Message-ID: <20231206235056.322578-62-gerickson@nuovations.com> In-Reply-To: <20231206235056.322578-1-gerickson@nuovations.com> References: <20231206235056.322578-1-gerickson@nuovations.com> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	Add Gateway Low-priority Default Routes for Non-default Services \| expand [00/90] Add Gateway Low-priority Default Routes for Non-default Services [01/90] connection: Rename 'find_active_gateway_data'. [02/90] connection: Document 'find_any_active_gateway_data'. [03/90] connection: Replace gateway config active Boolean. [04/90] connection: Document gateway configuration state. [05/90] connection: Replace gateway config VPN Boolean. [06/90] connection: Document gateway configuration flags. [07/90] connection: Introduce gateway configuration 'type'. [08/90] connection: Document 'gateway_config_type'. [09/90] connection: Add function parameter to {un,}set_default_gateway. [10/90] connection: Fix 'DBG' copy-and-paste typo. [11/90] connection: Split '{un,}_default_gateway' IP-specific functions. [12/90] connection: Add 'DBG' to 'del_gateway_routes'. [13/90] connection: Rename 'active_gateway' local. [14/90] connection: Check 'service' parameter for null. [15/90] connection: Check service network index for validity. [16/90] connection: Refactor '__connman_connection_gateway_add'. [17/90] connection: Remove 'DBG' from '__connman_connection_update_gateway'. [18/90] connection: Refactor 'yield_default_gateway'. [19/90] connection: Document 'gateway_data_config_get'. [20/90] connection: Document 'yield_default_gateway_for_type'. [21/90] connection: Add 'gateway_config_free'. [22/90] connection: Document 'gateway_config_free'. [23/90] connection: Introduce and leverage 'mutate_default_gateway'. [24/90] connection: Document 'mutate_default_gateway_ops'. [25/90] connection: Document 'mutate_default_gateway'. [26/90] connection: Add gateway config ADDED/REMOVED states. [27/90] connection: Add low-priority default gateway config type. [28/90] connection: Change return type of 'unset_default_gateway'. [29/90] connection: Leverage 'unset_default_gateway' in 'del_gateway_routes'. [30/90] connection: Change return type of 'set_default_gateway'. [31/90] connection: Fan out route manipulation into callbacks. [32/90] connection: Document 'mutate_default_gateway_route_cb_t'. [33/90] connection: Document 'set_default_gateway_route_common'. [34/90] connection: Document 'unset_default_gateway_route_common'. [35/90] inet: Add '__connman_inet_table2string'. [36/90] inet: Document '__connman_inet_table2string'. [37/90] inet: Leverage '__connman_inet_table2string'. [38/90] rtnl: Add support for extracting the table identifier. [39/90] ipconfig: Pass the rtnl table to '__connman_ipconfig_{new,del}route'. [40/90] rtnl: Add support for extracting the metric/priority. [41/90] ipconfig: Pass the rtnl metric to to '__connman_ipconfig_{new,del}route'. [42/90] ipconfig: Pass the rtnl dst prefixlen to '__connman_ipconfig_{new,del}route'. [43/90] inet: Include interface index and name in 'DBG'. [44/90] inet: Include the command value and string in 'DBG' [45/90] ipconfig: Use 'RT_SCOPE_*' mnemonics. [46/90] inet: Add a metric parameter to 'iproute_default_modify'. [47/90] inet: Document 'iproute_default_modify'. [48/90] connection: Document '__connman_inet_add_default_to_table'. [49/90] connection: Document '__connman_inet_del_default_to_table'. [50/90] inet: Add '__connman_inet_{add,del}_default_{to,from}_table_with_metric'. [51/90] inet: Document '__connman_inet_{add,del}_default_{to,from}_table_with_metric'. [52/90] connection: Add support for low-priority default routes. [53/90] connection: Introduce '{de,pro}mote_default_gateway'. [54/90] connection: Add 'is_addr_any_str'. [55/90] connection: Introduce gateway config 'ops' [56/90] connection: Refactor 'add_host_route'. [57/90] connection: Add 'DBG' else clauses to 'connection_delgateway'. [58/90] connection: Document 'gateway_config_state' finite state machine. [59/90] connection: Document 'gateway_config_ops'. [60/90] connection: Document 'gateway_config'. [61/90] connection: Document 'gateway_data'. [62/90] connection: Document 'gateway_hash'. [63/90] connection: Document 'is_addr_any_str'. [64/90] connection: Update 'find_any_active_gateway_data' documentation. [65/90] connection: Document 'compute_low_priority_metric'. [66/90] connection: Document 'add_host_route'. [67/90] connection: Document call to 'connman_service_unref'. [68/90] connection: Document 'demote_default_gateway'. [69/90] connection: Document 'promote_default_gateway'. [70/90] connection: Document 'set_ipv4_high_priority_default_gateway_route_cb'. [71/90] connection: Document 'set_ipv6_high_priority_default_gateway_route_cb'. [72/90] connection: Document 'set_ipv4_high_priority_default_gateway'. [73/90] connection: Document 'set_ipv6_high_priority_default_gateway'. [74/90] connection: Document 'unset_ipv4_high_priority_default_gateway_route_cb'. [75/90] connection: Document 'unset_ipv6_high_priority_default_gateway_route_cb'. [76/90] connection: Document 'unset_ipv4_high_priority_default_gateway'. [77/90] connection: Document 'unset_ipv6_high_priority_default_gateway'. [78/90] connection: Document 'set_ipv4_low_priority_default_gateway_route_cb'. [79/90] connection: Document 'set_ipv4_low_priority_default_gateway'. [80/90] connection: Document 'set_low_priority_default_gateway'. [81/90] connection: Document 'unset_ipv4_low_priority_default_gateway_route_cb'. [82/90] connection: Document 'unset_ipv4_low_priority_default_gateway'. [83/90] connection: Document 'unset_low_priority_default_gateway'. [84/90] connection: Fix documentation typos. [85/90] connection: Update 'set_default_gateway_route_common' documentation. [86/90] connection: Update 'unset_default_gateway_route_common' documentation. [87/90] connection: Update '{un,}set_default_gateway' documentation. [88/90] connection: Add @file comment. [89/90] connection: Add whitespace around 'del_gateway_routes_if_active'. [90/90] connection: Ensure function attribution 'DBG' output is consistent.

[58/90] connection: Document 'gateway_config_state' finite state machine.

Commit Message

Patch