Some TODO cleanup

faucet/dp.py

@@ -1096,7 +1096,7 @@ def resolve_mirror_destinations():
                         mirror_from_port[mirrored_port].append(mirror_port)
 
             # TODO: confusingly, mirror at config time means what ports to mirror from.
-            # But internally we use as a list of ports to mirror to.
+            #   But internally we use as a list of ports to mirror to.
             for mirrored_port, mirror_ports in mirror_from_port.items():
                 mirrored_port.mirror = []
                 for mirror_port in mirror_ports:

faucet/faucet_dot1x.py

@@ -178,7 +178,6 @@ def nfv_sw_port_up(self, dp_id, dot1x_ports, nfv_sw_port):
         Returns:
             list of flowmods
         """
-        # TODO Come back to. Should this be down?
         self._dot1x_speaker.port_down(
             get_mac_str(self.dp_id_to_valve_index[dp_id], nfv_sw_port.number))
         valve = self._valves[dp_id]

faucet/faucet_event.py

@@ -1,10 +1,5 @@
 """FAUCET event notification."""
 
-# TODO: events are currently schema-less. This is to facilitate rapid prototyping, and will change.
-# TODO: not all cases where a notified client fails or could block, have been tested.
-# only one client is supported (multiple clients should be implemented with a client that
-# copies/pushes to a message bus)
-
 # Copyright (C) 2013 Nippon Telegraph and Telephone Corporation.
 # Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
 # Copyright (C) 2015 Research and Education Advanced Network New Zealand Ltd.

faucet/fctl.py

@@ -2,10 +2,6 @@
 
 """Report state based on FAUCET/Gauge/Prometheus variables."""
 
-# TODO: this script and is usage is experimental and its output
-# is expected to change significantly.
-# TODO: add control functionality.
-
 # Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
 # Copyright (C) 2015 Research and Education Advanced Network New Zealand Ltd.
 # Copyright (C) 2015--2019 The Contributors

faucet/prom_client.py

@@ -53,7 +53,6 @@ class PromClient: # pylint: disable=too-few-public-methods
     def __init__(self, reg=None):
         if reg is not None:
             self._reg = reg
-        # TODO: investigate faster alternative (https://bugs.launchpad.net/pbr/+bug/1688405)
         self.version = VersionInfo('faucet').semantic_version().release_string()
         self.faucet_version = PromGauge( # pylint: disable=unexpected-keyword-arg
             'faucet_pbr_version',

faucet/valve.py

@@ -567,12 +567,12 @@ def _send_lldp_beacon_on_port(self, port, now):
 
     def fast_advertise(self, now, _other_valves):
         """Called periodically to send LLDP/LACP packets."""
-        # TODO: the beacon service is specifically NOT to support conventional R/STP.
-        # It is intended to facilitate physical troubleshooting (e.g.
-        # a standard cable tester can display OF port information).
-        # It is used also by stacking to verify stacking links.
-        # TODO: in the stacking case, provide an authentication scheme for the probes
-        # so they cannot be forged.
+        # NOTE: The beacon service is specifically NOT to support conventional R/STP.
+        #   It is intended to facilitate physical troubleshooting (e.g.
+        #       a standard cable tester can display OF port information).
+        #   It is used also by stacking to verify stacking links.
+        # TODO: In the stacking case, provide an authentication scheme for the probes
+        #   so they cannot be forged.
         if (not self.dp.fast_advertise_interval or
                 now - self._last_fast_advertise_sec < self.dp.fast_advertise_interval):
             return {}
@@ -1305,12 +1305,6 @@ def rcv_packet(self, now, other_valves, pkt_meta):
         Returns:
             dict: OpenFlow messages, if any by Valve.
         """
-        # TODO: expensive, even at non-debug level.
-        # self.logger.debug(
-        #    'Packet_in src:%s in_port:%d VLAN:%s' % (
-        #        pkt_meta.eth_src,
-        #        pkt_meta.port.number,
-        #        pkt_meta.vlan))
         if pkt_meta.vlan is None:
             return self._non_vlan_rcv_packet(now, other_valves, pkt_meta)
         return self._vlan_rcv_packet(now, other_valves, pkt_meta)

faucet/vlan.py

@@ -40,9 +40,8 @@ class NullVLAN:
     vid = valve_of.ofp.OFPVID_NONE
 
 
-# TODO: not well supported by any hardware, so not used.
 class AnyVLAN:
-    """Placeholder any tagged VLAN."""
+    """Placeholder any tagged VLAN. NOTE: Not used, not well supported by hardware"""
 
     name = 'Any VLAN'
     vid = valve_of.ofp.OFPVID_PRESENT