Add notes for traffic_type argument

To make this gerrit comment permanently visible in code:
https://gerrit.fd.io/r/#/c/17811/50/resources/libraries/python/InterfaceUtil.py@1335

Change-Id: I2b763d88fcc8186c9479a0f0c3336d8eeb8aed95
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

diff --git a/resources/libraries/python/InterfaceUtil.py b/resources/libraries/python/InterfaceUtil.py
index df45e39..d78984b 100644 (file)
--- a/resources/libraries/python/InterfaceUtil.py
+++ b/resources/libraries/python/InterfaceUtil.py
@@ -1335,6 +1335,8 @@ class InterfaceUtil(object):
         :param traffic_type: Expected type of traffic, affects spoofing.
             Default value "L2" sets linux interface spoof off.
             Other values do not do that.
+            Note: This is NOT the usual traffic profile
+            (which is python module name to initialize TG with).
         :type node: dict
         :type ifc_key: str
         :type numvfs: int

diff --git a/resources/libraries/robot/shared/default.robot b/resources/libraries/robot/shared/default.robot
index 59fd83d..56f1340 100644 (file)
--- a/resources/libraries/robot/shared/default.robot
+++ b/resources/libraries/robot/shared/default.robot
@@ -108,6 +108,8 @@
 | | ... | (Optional). Type: integer, default value: ${1}
 | | ... | - traffic_type - A value affecting behavior, such as spoofing.
 | | ... | (Optional). Type: string, default value: L2
+| | ... | Note: This is NOT the usual traffic profile
+| | ... | (which is python module name to initialize TG with).
 | | ...
 | | ... | *Example:*
 | | ...