From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Sat, 11 Sep 2010 04:14:42 +0000 (-0700)
Subject: misc: add docstring to bench_spans.py telling how to run it
X-Git-Tag: allmydata-tahoe-1.8.0c4~2
X-Git-Url: https://git.rkrishnan.org/components/com_hotproperty/css?a=commitdiff_plain;h=04fabe3a6984fe5cd7610893638b0a45f728066e;p=tahoe-lafs%2Ftahoe-lafs.git

misc: add docstring to bench_spans.py telling how to run it
ref #1182
---

diff --git a/misc/simulators/bench_spans.py b/misc/simulators/bench_spans.py
index 1855673f..e1e6e7eb 100644
--- a/misc/simulators/bench_spans.py
+++ b/misc/simulators/bench_spans.py
@@ -1,3 +1,13 @@
+"""
+To use this, get a trace file such as this one:
+
+wget http://tahoe-lafs.org/trac/tahoe-lafs/raw-attachment/ticket/1170/run-112-above28-flog-dump-sh8-on-nsziz.txt
+
+And run this command passing that trace file's name:
+
+python bench_spans.py run-112-above28-flog-dump-sh8-on-nsziz.txt
+"""
+
 from pyutil import benchutil
 
 from allmydata.util.spans import DataSpans