[tor-commits] [chutney/master] README: rewrite the bandwidth tests section

[teor at torproject.org]

commit 8ddd5efff908bcd5998a8149418af7f06e5a30cb
Author: teor <teor at torproject.org>
Date:   Sat Apr 6 13:14:55 2019 +1000

    README: rewrite the bandwidth tests section
---
 README | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/README b/README
index 9fdee93..0cc5a1e 100644
--- a/README
+++ b/README
@@ -99,15 +99,18 @@ Bandwidth Tests:
   ./chutney configure networks/basic-min
   ./chutney start networks/basic-min
   ./chutney status networks/basic-min
-  CHUTNEY_DATA_BYTES=104857600 ./chutney verify networks/basic-min
   # Send 100MB of data per client connection
-  # verify produces performance figures for:
-  # Single Stream Bandwidth: the speed of the slowest stream, end-to-end
-  # Overall tor Bandwidth: the sum of the bandwidth across each tor instance
-  # This approximates the CPU-bound tor performance on the current machine,
-  # assuming everything is multithreaded and network performance is infinite.
+  CHUTNEY_DATA_BYTES=104857600 ./chutney verify networks/basic-min
   ./chutney stop networks/basic-min
 
+If chutney sends at least 5 MB of data, and it takes at least one second,
+verify produces performance figures for:
+ - Single Stream Bandwidth: the speed of the slowest stream, end-to-end
+ - Overall tor Bandwidth: the sum of the bandwidth across each tor instance
+The overall bandwidth approximates the CPU-bound tor performance on the
+current machine, assuming tor, chutney, and the OS are multithreaded, and
+network performance is infinite.
+
 Connection Tests:
   ./chutney configure networks/basic-025
   ./chutney start networks/basic-025