Merge "Ensure etcd is in developer and driver docs"

This commit is contained in:
Jenkins 2016-06-09 07:16:02 +00:00 committed by Gerrit Code Review
commit 6daa485eeb
2 changed files with 17 additions and 1 deletions

View File

@ -9,7 +9,7 @@ Interfaces
:members:
Etcd
~~~
~~~~
.. autoclass:: tooz.drivers.etcd.EtcdDriver
:members:

View File

@ -183,11 +183,27 @@ Considerations
- Does **not** work when MySQL replicates from one server to another (locks
are local to the server that they were created from).
Etcd
----
**Driver:** :py:class:`tooz.drivers.etcd.EtcdDriver`
**Characteristics:** :py:attr:`tooz.drivers.etcd.EtcdDriver.CHARACTERISTICS`
**Entrypoint name:** ``etcd``
**Summary:**
The etcd driver is a driver providing only distributed locks (for now)
and is based on the `etcd server`_ supported key/value storage and
associated primitives.
Characteristics
---------------
.. autoclass:: tooz.coordination.Characteristics
.. _etcd server: https://coreos.com/etcd/
.. _advisory locks: http://www.postgresql.org/docs/8.2/interactive/\
explicit-locking.html#ADVISORY-LOCKS
.. _get_lock: http://dev.mysql.com/doc/refman/5.5/en/\