From 601fb264c56e642f4c3ba3448dbbce9d070fa83d Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Thu, 12 May 2016 22:32:30 -0700 Subject: [PATCH] Ensure etcd is in developer and driver docs Change-Id: I2da690a7ea93646e38d86f90168571abaab69067 --- doc/source/developers.rst | 2 +- doc/source/drivers.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/source/developers.rst b/doc/source/developers.rst index b6ece9e6..e6d549bb 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -9,7 +9,7 @@ Interfaces :members: Etcd -~~~ +~~~~ .. autoclass:: tooz.drivers.etcd.EtcdDriver :members: diff --git a/doc/source/drivers.rst b/doc/source/drivers.rst index 01294831..43efa3bc 100644 --- a/doc/source/drivers.rst +++ b/doc/source/drivers.rst @@ -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/\