adding comment to VLANStarTopo in vlanhost.py

2014-08-28 05:57:10 -07:00
parent 05f3fbae73
commit 6b8d3538ef
1 changed files with 6 additions and 1 deletions
@@ -68,7 +68,12 @@ def exampleAllHosts( vlan ):
    net.stop()

 class VLANStarTopo( Topo ):
-    """Example topology that uses host in multiple VLANs"""
+    """Example topology that uses host in multiple VLANs
+
+       The topology has a single switch. There are k VLANs with
+       n hosts in each, all connected to the single switch. There
+       are also n hosts that are not in any VLAN, also connected to
+       the switch."""

    def build( self, k=2, n=2, vlanBase=100 ):
        s1 = self.addSwitch( 's1' )