[tor-commits] [bridgedb/develop] Update bridgedb.runner.generateDescriptors to mention leekspin.

[isis at torproject.org]

commit a2f59909bdde9f5c31f1282ad028184eb3fe0a72
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed Apr 2 14:41:40 2014 +0000

    Update bridgedb.runner.generateDescriptors to mention leekspin.
---
 lib/bridgedb/runner.py |   19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/lib/bridgedb/runner.py b/lib/bridgedb/runner.py
index d067bd9..4b4564f 100644
--- a/lib/bridgedb/runner.py
+++ b/lib/bridgedb/runner.py
@@ -22,15 +22,16 @@ import sys
 def generateDescriptors(count=None, rundir=None):
     """Run a script which creates fake bridge descriptors for testing purposes.
 
-    This will run ``scripts/gen_bridge_descriptors`` to create bridge server
-    descriptors, bridge extra-info descriptors, and networkstatus document.
-
-    ** NOTE: **
-        This function can take a very long time to run, especially in headless
-        environments where entropy sources are minimal, because it creates the
-        keys for each mocked OR, which are embedded in the server descriptors,
-        used to calculate the OR fingerprints, and sign the descriptors, among
-        other things.
+    This will run Leekspin_ to create bridge server descriptors, bridge
+    extra-info descriptors, and networkstatus document.
+
+    .. warning: This function can take a very long time to run, especially in
+        headless environments where entropy sources are minimal, because it
+        creates the keys for each mocked OR, which are embedded in the server
+        descriptors, used to calculate the OR fingerprints, and sign the
+        descriptors, among other things.
+
+    .. _Leekspin: https://gitweb.torproject.org/user/isis/leekspin.git
 
     :param integer count: Number of mocked bridges to generate descriptor
         for. (default: 3)