[Pkg-privacy-commits] [txtorcon] 59/96: documentation updates

[Jérémy Bobbio]

This is an automated email from the git hooks/post-receive script.

lunar pushed a commit to branch master
in repository txtorcon.

commit 25ce0e14823748b02eb3d6e40234e46cea44f3dd
Author: meejah <meejah at meejah.ca>
Date:   Fri Feb 6 01:38:23 2015 -0700

    documentation updates
---
 docs/releases.rst              | 5 +++++
 txtorcon/torconfig.py          | 2 ++
 txtorcon/torcontrolprotocol.py | 8 ++++++--
 3 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/docs/releases.rst b/docs/releases.rst
index b244eb3..45ab7bf 100644
--- a/docs/releases.rst
+++ b/docs/releases.rst
@@ -12,6 +12,11 @@ unreleased
 
 `git master <https://github.com/meejah/txtorcon>`_ *will likely become v0.13.0*
 
+ * 2x speedup for TorState parsing (mostly by lazy-parsing timestamps)
+ * can now parse ~75000 microdescriptors/second per core of 3.4GHz Xeon E3
+ * ``launch_tor`` now doesn't use a temporary ``torrc`` (command-line options instead)
+ * tons of pep8 cleanups
+
 
 v0.12.0
 -------
diff --git a/txtorcon/torconfig.py b/txtorcon/torconfig.py
index 6f30e18..ef3cfe5 100644
--- a/txtorcon/torconfig.py
+++ b/txtorcon/torconfig.py
@@ -820,6 +820,8 @@ class TorConfig(object):
 
         self.__dict__['_setup_'] = None
 
+    # FIXME should re-name this to "tor_protocol" to be consistent
+    # with other things? Or rename the other things?
     """
     read-only access to TorControlProtocol. Call attach_protocol() to
     set it, which can only be done if we don't already have a
diff --git a/txtorcon/torcontrolprotocol.py b/txtorcon/torcontrolprotocol.py
index cdd3930..fb4c921 100644
--- a/txtorcon/torcontrolprotocol.py
+++ b/txtorcon/torcontrolprotocol.py
@@ -437,8 +437,7 @@ class TorControlProtocol(LineOnlyReceiver):
         return self.queue_command('SIGNAL %s' % nm)
 
     def add_event_listener(self, evt, callback):
-        """
-        :param evt: event name, see also
+        """:param evt: event name, see also
         :var:`txtorcon.TorControlProtocol.events` .keys()
 
         Add a listener to an Event object. This may be called multiple
@@ -449,6 +448,10 @@ class TorControlProtocol(LineOnlyReceiver):
         argument, that is the text collected for the event from the
         tor control protocol.
 
+        For more information on the events supported, see
+        `control-spec section 4.1
+        <https://gitweb.torproject.org/torspec.git/tree/control-spec.txt#n1260>`_
+
         .. note::
             this is a low-level interface; if you want to follow
             circuit or stream creation etc. see TorState and methods
@@ -459,6 +462,7 @@ class TorControlProtocol(LineOnlyReceiver):
         .. todo::
             need an interface for the callback
             show how to tie in Stem parsing if you want
+
         """
 
         if evt not in self.valid_events.values():

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/txtorcon.git