From: Rafael Zalamena <rzalamena@gmail.com>
Date: Wed, 21 Jun 2017 17:12:57 +0000 (-0300)
Subject: Topogen: document new options
X-Git-Tag: frr-7.1-dev~151^2~309
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=d9ea1cda814e5553d295fc989d86982969cf9681;p=matthieu%2Ffrr.git

Topogen: document new options

We can now add routers to the topology using different daemon binaries
path. This will allow us to run tests with different daemon versions and
types.
---

diff --git a/tests/topotests/lib/topogen.py b/tests/topotests/lib/topogen.py
index 72da0d4446..250d4ba216 100644
--- a/tests/topotests/lib/topogen.py
+++ b/tests/topotests/lib/topogen.py
@@ -246,9 +246,7 @@ class TopoGear(object):
 
 class TopoRouter(TopoGear):
     """
-    Router abstraction. Has the following properties:
-    * cls: router class that will be used to instantiate
-    * name: router name
+    Router abstraction.
     """
 
     # The default required directories by Quagga/FRR
@@ -283,6 +281,14 @@ class TopoRouter(TopoGear):
     }
 
     def __init__(self, tgen, cls, name, **params):
+        """
+        The constructor has the following parameters:
+        * tgen: Topogen object
+        * cls: router class that will be used to instantiate
+        * name: router name
+        * daemondir: daemon binary directory
+        * routertype: 'quagga' or 'frr'
+        """
         super(TopoRouter, self).__init__()
         self.tgen = tgen
         self.net = None