From d7768ab22884f9abeb21dec634b50bd05da9ef0d Mon Sep 17 00:00:00 2001
From: Brandon Heller <brandonh@stanford.edu>
Date: Tue, 13 Nov 2012 23:28:19 -0800
Subject: [PATCH] examples/simpleperf: Warn in docstring about effects of link
 settings

These include dropped pings and iperf hanging.
---
 examples/simpleperf.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/examples/simpleperf.py b/examples/simpleperf.py
index 3dad32c..1da4b66 100755
--- a/examples/simpleperf.py
+++ b/examples/simpleperf.py
@@ -2,6 +2,11 @@
 
 """
 Simple example of setting network and CPU parameters
+
+NOTE: link params limit BW, add latency, and loss.
+There is a high chance that pings WILL fail and that
+iperf will hang indefinitely if the TCP handshake fails
+to complete.
 """
 
 from mininet.topo import Topo