summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTodd Willey <todd@ansolabs.com>2010-10-29 11:58:57 -0400
committerTodd Willey <todd@ansolabs.com>2010-10-29 11:58:57 -0400
commit133cd9973e17458bea3594490e70ccd3c524cf12 (patch)
tree677fd3bcd9c120680d4eccd2e82f0d85527b6173
parentee4ce8a55194be3fcb1e861e4206451cc7812d46 (diff)
Document Fakes
-rw-r--r--doc/source/development.guide.rst1
-rw-r--r--doc/source/fakes.rst34
-rw-r--r--nova/auth/fakeldap.py4
3 files changed, 34 insertions, 5 deletions
diff --git a/doc/source/development.guide.rst b/doc/source/development.guide.rst
index 61a664171..0d852a098 100644
--- a/doc/source/development.guide.rst
+++ b/doc/source/development.guide.rst
@@ -39,6 +39,7 @@ Contents
compute
network
auth
+ fakes
Older Contents
diff --git a/doc/source/fakes.rst b/doc/source/fakes.rst
index eccd4ab43..72e5c287b 100644
--- a/doc/source/fakes.rst
+++ b/doc/source/fakes.rst
@@ -15,8 +15,13 @@
License for the specific language governing permissions and limitations
under the License.
-Nova Fakes
-==========
+Fakes Programming Guide
+=======================
+
+::
+
+ TODO(todd): * document general info about fakes
+
The :mod:`virt.fake` Module
---------------------------
@@ -41,3 +46,28 @@ The :mod:`fakerabbit` Module
:members:
:undoc-members:
:show-inheritance:
+
+The :class:`FakeAOEDriver` Class
+--------------------------------
+
+.. autoclass:: nova.volume.driver.FakeAOEDriver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :class:`service_unittest.FakeManager` Class
+-----------------------------------------------
+
+.. autoclass:: nova.tests.service_unittest.FakeManager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`api.openstack.fakes` Module
+------------------------------------------------
+
+.. automodule:: nova.tests.api.openstack.fakes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/nova/auth/fakeldap.py b/nova/auth/fakeldap.py
index 176a00f06..46e0135b4 100644
--- a/nova/auth/fakeldap.py
+++ b/nova/auth/fakeldap.py
@@ -15,9 +15,7 @@
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
-
-"""
-Fake LDAP server for test harness, backs to ReDIS.
+"""Fake LDAP server for test harness, backs to ReDIS.
This class does very little error checking, and knows nothing about ldap
class definitions. It implements the minimum emulation of the python ldap