Some epydoc fixes
authorIustin Pop <iustin@google.com>
Thu, 18 Mar 2010 13:23:48 +0000 (14:23 +0100)
committerIustin Pop <iustin@google.com>
Tue, 23 Mar 2010 08:35:05 +0000 (09:35 +0100)
Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

daemons/ganeti-confd
epydoc.conf
lib/cmdlib.py
lib/hypervisor/hv_base.py
lib/hypervisor/hv_chroot.py
lib/hypervisor/hv_fake.py

index 82734ef..c793159 100755 (executable)
@@ -94,7 +94,7 @@ class ConfdInotifyEventHandler(pyinotify.ProcessEvent):
                filename=constants.CLUSTER_CONF_FILE):
     """Constructor for ConfdInotifyEventHandler
 
-    @type watch_manager: L{pyinotify.WatchManager}
+    @type watch_manager: pyinotify.WatchManager
     @param watch_manager: ganeti-confd inotify watch manager
     @type callback: function accepting a boolean
     @param callback: function to call when an inotify event happens
index b10a844..11069a3 100644 (file)
@@ -8,7 +8,7 @@ output: html
 # note: the wildcards means the directories should be cleaned up after each
 # run, otherwise there will be stale '*c' (compiled) files that will not be
 # parsable and will break the epydoc run
-modules: ganeti, scripts/gnt-*, daemons/ganeti-*
+modules: ganeti, scripts/gnt-*, daemons/ganeti-confd, daemons/ganeti-masterd, daemons/ganeti-noded, daemons/ganeti-rapi, daemons/ganeti-watcher
 
 graph: all
 
index 787b9ec..9f604ee 100644 (file)
@@ -1095,7 +1095,7 @@ class LUVerifyCluster(LogicalUnit):
     """A class representing the logical and physical status of a node.
 
     @ivar volumes: a structure as returned from
-        L{ganeti.utils.GetVolumeList} (runtime)
+        L{ganeti.backend.GetVolumeList} (runtime)
     @ivar instances: a list of running instances (runtime)
     @ivar pinst: list of configured primary instances (config)
     @ivar sinst: list of configured secondary instances (config)
@@ -4000,7 +4000,7 @@ def _CheckNodesFreeDisk(lu, nodenames, requested):
   @type lu: C{LogicalUnit}
   @param lu: a logical unit from which we get configuration data
   @type nodenames: C{list}
-  @param node: the list of node names to check
+  @param nodenames: the list of node names to check
   @type requested: C{int}
   @param requested: the amount of disk in MiB to check for
   @raise errors.OpPrereqError: if the node doesn't have enough disk, or
index 86b85c9..db8bcb4 100644 (file)
@@ -237,7 +237,7 @@ class BaseHypervisor(object):
   def MigrateInstance(self, instance, target, live):
     """Migrate an instance.
 
-    @type instance: L{object.Instance}
+    @type instance: L{objects.Instance}
     @param instance: the instance to be migrated
     @type target: string
     @param target: hostname (usually ip) of the target node
index f033d5e..cf40c59 100644 (file)
@@ -272,7 +272,7 @@ class ChrootManager(hv_base.BaseHypervisor):
   def MigrateInstance(self, instance, target, live):
     """Migrate an instance.
 
-    @type instance: L{object.Instance}
+    @type instance: L{objects.Instance}
     @param instance: the instance to be migrated
     @type target: string
     @param target: hostname (usually ip) of the target node
index 850e568..d607d0d 100644 (file)
@@ -241,7 +241,7 @@ class FakeHypervisor(hv_base.BaseHypervisor):
   def MigrateInstance(self, instance, target, live):
     """Migrate an instance.
 
-    @type instance: L{object.Instance}
+    @type instance: L{objects.Instance}
     @param instance: the instance to be migrated
     @type target: string
     @param target: hostname (usually ip) of the target node