commit f6122a12f2de36116419e9953065ea8aaa983491 Author: Damian Johnson atagar@torproject.org Date: Fri Dec 5 13:12:40 2014 -0800

Updating gitweb urls

Our new version of gitweb use a different scheme for its urls. --- docs/conf.py | 4 ++-- docs/faq.rst | 4 ++-- docs/index.rst | 2 +- docs/roles.py | 4 ++-- docs/tutorials.rst | 2 +- docs/tutorials/double_double_toil_and_trouble.rst | 2 +- docs/tutorials/down_the_rabbit_hole.rst | 4 ++-- stem/__init__.py | 2 +- stem/descriptor/extrainfo_descriptor.py | 4 ++-- stem/descriptor/microdescriptor.py | 2 +- stem/descriptor/remote.py | 8 ++++---- stem/descriptor/server_descriptor.py | 2 +- stem/exit_policy.py | 4 ++-- stem/response/events.py | 2 +- stem/version.py | 2 +- 15 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py index 756bd20..e778923 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -229,5 +229,5 @@ man_pages = [ ['%s (%s)' % (__author__, __contact__)], 1) ]

-trac_url = 'https://trac.torproject.org' -spec_url = 'https://gitweb.torproject.org/torspec.git/commitdiff' +trac_url = 'https://trac.torproject.org/%7Bslug%7D' +spec_url = 'https://gitweb.torproject.org/torspec.git/commit/?id=%7Bslug%7D' diff --git a/docs/faq.rst b/docs/faq.rst index b235961..d622f42 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -36,7 +36,7 @@ What is Stem?

Stem is a Python controller library that you can use to interact with `Tor https://www.torproject.org/`_. With it you can write scripts and applications with capabilities similar to `Vidalia https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia`_ and `arm https://www.atagar.com/arm/`_.

-From a technical standpoint, Stem is a Python implementation of Tor's `directory https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_ and `control specifications https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_. `To get started see our tutorials! <tutorials.html>`_ +From a technical standpoint, Stem is a Python implementation of Tor's `directory https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_ and `control specifications https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_. `To get started see our tutorials! <tutorials.html>`_

.. _does_stem_have_any_dependencies:

@@ -65,7 +65,7 @@ Can I interact with Tor's controller interface directly? --------------------------------------------------------

Yup. You don't need a library to interact with Tor's `controller interface -https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_, and +https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_, and interacting with it directly is a great way to learn about what it can do. The exact details for how you connect to Tor depend on two things...

diff --git a/docs/index.rst b/docs/index.rst index 022a74d..78920bc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ Welcome to Stem! ================

-Stem is a Python controller library for `Tor https://www.torproject.org/`_. Like its predecessor, `TorCtl https://gitweb.torproject.org/pytorctl.git`_, it uses Tor's `control protocol https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_ to help developers program against the Tor process, enabling them to build things similar to `Vidalia https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia`_ and `arm https://www.atagar.com/arm/`_. Stem's latest version is **1.2.2** (released June 7th, 2014). +Stem is a Python controller library for `Tor https://www.torproject.org/`_. Like its predecessor, `TorCtl https://gitweb.torproject.org/pytorctl.git`_, it uses Tor's `control protocol https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_ to help developers program against the Tor process, enabling them to build things similar to `Vidalia https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia`_ and `arm https://www.atagar.com/arm/`_. Stem's latest version is **1.2.2** (released June 7th, 2014).

.. Main Stem Logo Source: http://www.wpclipart.com/plants/assorted/P/plant_stem.png.html diff --git a/docs/roles.py b/docs/roles.py index 67e944c..27b4d4a 100644 --- a/docs/roles.py +++ b/docs/roles.py @@ -41,7 +41,7 @@ def role_trac(name, rawtext, text, lineno, inliner, options={}, content=[]):

def role_spec(name, rawtext, text, lineno, inliner, options={}, content=[]): """ - Aliases :spec:`25b0d43` to 'https://gitweb.torproject.org/torspec.git/commitdiff/25b0d43'. + Aliases :spec:`25b0d43` to 'https://gitweb.torproject.org/torspec.git/commit/?id=25b0d43'. """

# checking if the input is a valid short commit id @@ -77,7 +77,7 @@ def make_link_node(rawtext, app, url_type, link_text, slug, options): if not base_url: raise ValueError("'%s' isn't set in our config" % url_type)

- ref = base_url.rstrip('/') + '/' + slug + ref = base_url.format(slug = slug) set_classes(options)

return reference(rawtext, link_text, refuri = ref, **options) diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 40b5439..271ccea 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -107,7 +107,7 @@ feet wet by jumping straight in with some tutorials...

Interactive interpreter for Tor that provides you with direct access to Tor's `control interface - https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_ + https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_ via either python or direct requests. This is an easy way of experimenting with Stem and learning what Tor can do.

diff --git a/docs/tutorials/double_double_toil_and_trouble.rst b/docs/tutorials/double_double_toil_and_trouble.rst index ce6c58a..e131d0c 100644 --- a/docs/tutorials/double_double_toil_and_trouble.rst +++ b/docs/tutorials/double_double_toil_and_trouble.rst @@ -60,7 +60,7 @@ Applications `BeagleBone for Secret Agents https://github.com/jbdatko/beagle-bone-for-secret-agents`_ Bridge with a `bandwidth monitor https://github.com/jbdatko/beagle-bone-for-secret-agents/blob/master/ch2/beaglebridge.py`_ on a BeagleBoard. `RTT Prober https://bitbucket.org/ra_/tor-rtt/`_ Measures round-trip times for Tor circuits. `TorPS https://www.torproject.org/getinvolved/volunteer.html.en#project-torps`_ Tor path simulator. -`Metrics Tasks https://gitweb.torproject.org/metrics-tasks.git/tree`_ One-off tasks related to Tor metrics. These mostly involve using descriptor information to answer a particular question. Tasks that involve Stem are: `1854 https://gitweb.torproject.org/metrics-tasks.git/blob/HEAD:/task-1854/pylinf.py`_, `6232 https://gitweb.torproject.org/metrics-tasks.git/blob/HEAD:/task-6232/pyentropy.py`_, and `7241 https://gitweb.torproject.org/metrics-tasks.git/blob/HEAD:/task-7241/first_pass.py`_. +`Metrics Tasks https://gitweb.torproject.org/metrics-tasks.git/tree`_ One-off tasks related to Tor metrics. These mostly involve using descriptor information to answer a particular question. Tasks that involve Stem are: `1854 https://gitweb.torproject.org/metrics-tasks.git/blob/HEAD:/task-1854/pylinf.py`_, `6232 https://gitweb.torproject.org/metrics-tasks.git/tree/task-6232/pyentropy.py`_, and `7241 https://gitweb.torproject.org/metrics-tasks.git/tree/task-7241/first_pass.py`_. `check_tor http://anonscm.debian.org/gitweb/?p=users/lunar/check_tor.git;a=blob;f=check_tor.py;hb=HEAD`_ Nagios check to verify that a relay is participating in the Tor network. `munin-tor https://github.com/mweinelt/munin-tor`_ Plugin to provide Munin graphs. `tbbscraper https://github.com/zackw/tbbscraper/blob/master/controller/controller.py`_ Automated website scraper over Tor. diff --git a/docs/tutorials/down_the_rabbit_hole.rst b/docs/tutorials/down_the_rabbit_hole.rst index 21569d0..709f596 100644 --- a/docs/tutorials/down_the_rabbit_hole.rst +++ b/docs/tutorials/down_the_rabbit_hole.rst @@ -2,9 +2,9 @@ Down the Rabbit Hole ====================

Underneath it all Stem is a Python implementation of Tor's `control -https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_ and +https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_ and `directory specifications -https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_. +https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_. Anything you can do with Stem you can also do `with telnet <../faq.html#can-i-interact-with-tors-controller-interface-directly>`_ (albeit with quite a bit of extra work). diff --git a/stem/__init__.py b/stem/__init__.py index c034f4f..640cdff 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -55,7 +55,7 @@ Library for working with the tor process. Flag assigned to tor relays by the authorities to indicate various characteristics.

- **Note:** The BADDIRECTORY flag was `removed from tor https://gitweb.torproject.org/torspec.git/commitdiff/2f012f1`_. + **Note:** The BADDIRECTORY flag was `removed from tor https://gitweb.torproject.org/torspec.git/commit/dir-spec.txt?id=2f012f1`_.

================= =========== Flag Description diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index b677888..b260888 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -8,7 +8,7 @@ server descriptors these don't contain information that Tor clients require to function and as such aren't fetched by default.

Defined in section 2.2 of the `dir-spec -https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_, +https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_, extra-info descriptors contain interesting but non-vital information such as usage statistics. Tor clients cannot request these documents for bridges.

@@ -861,7 +861,7 @@ class RelayExtraInfoDescriptor(ExtraInfoDescriptor): """ Relay extra-info descriptor, constructed from data such as that provided by 'GETINFO extra-info/digest/*', cached descriptors, and metrics - (`specification https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_). + (`specification https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_).

:var str signature: ***** signature for this extrainfo descriptor

diff --git a/stem/descriptor/microdescriptor.py b/stem/descriptor/microdescriptor.py index addb495..c3d3db9 100644 --- a/stem/descriptor/microdescriptor.py +++ b/stem/descriptor/microdescriptor.py @@ -154,7 +154,7 @@ def _parse_file(descriptor_file, validate = True, **kwargs): class Microdescriptor(Descriptor): """ Microdescriptor (`descriptor specification - https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_) + https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_)

:var str digest: ***** hex digest for this microdescriptor, this can be used to match against the corresponding digest attribute of a diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py index 0e912aa..d70c059 100644 --- a/stem/descriptor/remote.py +++ b/stem/descriptor/remote.py @@ -158,7 +158,7 @@ class Query(object):

Tor provides quite a few different descriptor resources via its directory protocol (see section 4.2 and later of the `dir-spec - https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_). + https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_). Commonly useful ones include...

===================================== =========== @@ -520,7 +520,7 @@ class DescriptorDownloader(object):

:param str authority_v3ident: fingerprint of the authority key for which to get the consensus, see `'v3ident' in tor's config.c - https://gitweb.torproject.org/tor.git/blob/f631b73:/src/or/config.c#l816`_ + https://gitweb.torproject.org/tor.git/tree/src/or/config.c#n819`_ for the values. :param query_args: additional arguments for the :class:`~stem.descriptor.remote.Query` constructor @@ -563,7 +563,7 @@ class DescriptorDownloader(object):

:param str authority_v3idents: fingerprint or list of fingerprints of the authority keys, see `'v3ident' in tor's config.c - https://gitweb.torproject.org/tor.git/blob/f631b73:/src/or/config.c#l816`_ + https://gitweb.torproject.org/tor.git/tree/src/or/config.c#n819`_ for the values. :param query_args: additional arguments for the :class:`~stem.descriptor.remote.Query` constructor @@ -620,7 +620,7 @@ class DescriptorDownloader(object): class DirectoryAuthority(object): """ Tor directory authority, a special type of relay `hardcoded into tor - https://gitweb.torproject.org/tor.git/blob/f631b73:/src/or/config.c#l816`_ + https://gitweb.torproject.org/tor.git/tree/src/or/config.c#n819`_ that enumerates the other relays within the network.

At a very high level tor works as follows... diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index e92f0e0..40c6a27 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -649,7 +649,7 @@ class ServerDescriptor(Descriptor): class RelayDescriptor(ServerDescriptor): """ Server descriptor (`descriptor specification - https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_) + https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_)

:var str onion_key: ***** key used to encrypt EXTEND cells :var str ntor_onion_key: base64 key used to encrypt EXTEND in the ntor protocol diff --git a/stem/exit_policy.py b/stem/exit_policy.py index 9adb699..0b7bea7 100644 --- a/stem/exit_policy.py +++ b/stem/exit_policy.py @@ -534,7 +534,7 @@ class MicroExitPolicy(ExitPolicy):

Since these policies are a subset of the exit policy information (lacking IP ranges) clients can only use them to guess if a relay will accept traffic or - not. To quote the `dir-spec https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_ (section 3.2.1)... + not. To quote the `dir-spec https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_ (section 3.2.1)...

::

@@ -611,7 +611,7 @@ class ExitPolicyRule(object): traffic to exit.

The format of these rules are formally described in the `dir-spec - https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt`_ as an + https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt`_ as an 'exitpattern'. Note that while these are similar to tor's man page entry for ExitPolicies, it's not the exact same. An exitpattern is better defined and stricter in what it'll accept. For instance, ports are not optional and it diff --git a/stem/response/events.py b/stem/response/events.py index 92dd281..49a0779 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -26,7 +26,7 @@ class Event(stem.response.ControlMessage): """ Base for events we receive asynchronously, as described in section 4.1 of the `control-spec - https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt`_. + https://gitweb.torproject.org/torspec.git/tree/control-spec.txt`_.

:var str type: event type :var int arrived_at: unix timestamp for when the message arrived diff --git a/stem/version.py b/stem/version.py index be971fb..531c363 100644 --- a/stem/version.py +++ b/stem/version.py @@ -136,7 +136,7 @@ class Version(object): """ Comparable tor version. These are constructed from strings that conform to the 'new' style in the `tor version-spec - https://gitweb.torproject.org/torspec.git/blob/HEAD:/version-spec.txt`_, + https://gitweb.torproject.org/torspec.git/tree/version-spec.txt`_, such as "0.1.4" or "0.2.2.23-alpha (git-7dcd105be34a4f44)".

:var int major: major version