KCC: improve docstring and comment for kcc.remove_unneeded_ntdsconn()

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>

diff --git a/source4/scripting/bin/samba_kcc b/source4/scripting/bin/samba_kcc
index 78a00c7b9b44883fd6d08a1361b82a8dd6dca71d..ec089d62ed4f036afc0c15ca62d4f8f2a7475737 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -404,12 +404,17 @@ class KCC(object):
         pass
 
     def remove_unneeded_ntdsconn(self, all_connected):
-        """Removes unneeded NTDS Connections after computation
-        of KCC intra and inter-site topology has finished.
+        """Remove unneeded NTDS Connections once topology is calculated
+
+        Based on MS-ADTS 6.2.2.4 Removing Unnecessary Connections
+
+        :param all_connected: indicates whether all sites are connected
+        :return: None
         """
         mydsa = self.my_dsa
 
-        # Loop thru connections
+        # New connections won't have GUIDs which are needed for
+        # sorting. Add them.
         for cn_conn in mydsa.connect_table.values():
             if cn_conn.guid is None:
                 if opts.readonly: