From 2f8e9b9c531a787411901b579788ade2185b9fdb Mon Sep 17 00:00:00 2001
From: James Prestwood <james.prestwood@linux.intel.com>
Date: Tue, 30 Jul 2019 12:36:46 -0700
Subject: [PATCH] doc: clean up main.conf documentation

All options should now have a description which describes the
default value for each option. The example use (commented or not)
now contains the default value as well.
---
 doc/main.conf | 29 ++++++++++++++++-------------
 1 file changed, 16 insertions(+), 13 deletions(-)

diff --git a/doc/main.conf b/doc/main.conf
index 60a3f8f8..045a49ee 100644
--- a/doc/main.conf
+++ b/doc/main.conf
@@ -21,7 +21,7 @@ max_4way_handshake_time=5
 # should be set to False.
 ControlPortOverNL80211=True
 #
-# Set the threshold RSSI for roaming
+# Set the threshold RSSI for roaming (default -70)
 roam_rssi_threshold=-70
 #
 # Do not allow iwd to destroy / recreate wireless interfaces at startup,
@@ -35,7 +35,7 @@ roam_rssi_threshold=-70
 # Explicitly enforce/disable management frame protection
 #
 # 0 - Disable management frame protection
-# 1 - Set management frame protection capable
+# 1 - Set management frame protection capable (default)
 # 2 - Management frame protection required
 #
 # ManagementFrameProtection=1
@@ -79,7 +79,8 @@ roam_rssi_threshold=-70
 # issuing the periodic scans for the available networks while disconnected.
 # The behavior of the user-initiated scans isn't affected.
 # The periodic scan is enabled by default.
-#disable_periodic_scan=true
+#
+# disable_periodic_scan=false
 #
 
 #
@@ -87,7 +88,8 @@ roam_rssi_threshold=-70
 # issuing the roaming scans for the available networks while connected.
 # The behavior of the user-initiated scans isn't affected.
 # The roaming scan is enabled by default.
-#disable_roaming_scan=true
+#
+# disable_roaming_scan=false
 #
 
 #
@@ -95,7 +97,8 @@ roam_rssi_threshold=-70
 # the capable network adapters from randomizing MAC addresses during the active
 # scans for networks, thus decreasing user privacy.
 # The MAC address randomization is enabled by default.
-#disable_mac_address_randomization=true
+#
+# disable_mac_address_randomization=false
 #
 
 [Blacklist]
@@ -106,16 +109,16 @@ roam_rssi_threshold=-70
 # for.
 #
 # bss_blacklist_time -       The initial timeout for a blacklisted BSS in
-#                            seconds.
+#                            seconds (default 60)
 # bss_blacklist_multiplier - What bss_blacklist_time is multiplied by after
 #                            future unsuccessful connection attempts in
-#                            seconds.
+#                            seconds (default 30)
 # bss_blacklist_max_time -   The maximum time a BSS can be blacklisted for in
-#                            seconds.
+#                            seconds (default 86400)
 #
-#bss_blacklist_time=60
-#bss_blacklist_multiplier=30
-#bss_blacklist_max_time=86400
+# bss_blacklist_time=60
+# bss_blacklist_multiplier=30
+# bss_blacklist_max_time=86400
 
 [Rank]
 #
@@ -124,6 +127,6 @@ roam_rssi_threshold=-70
 # is still possible for IWD to prefer a 2.4GHz AP in the right conditions.
 # This ranking provides a way to further weight the ranking towards 5G if
 # required. Also, a lower 5G factor could be used to weight 2.4GHz if that is
-# desired.
+# desired. The default is 1.0, which does not affect the calculated ranking.
 #
-#rank_5g_factor=1.0
+# rank_5g_factor=1.0