[Xen-changelog] Added comment describing usage.

[Xen patchbot -unstable <patchbot-unstable@xxxxxxxxxxxxxxxxxxx>]

# HG changeset patch
# User emellor@xxxxxxxxxxxxxxxxxxxxxx
# Node ID b8bca5421d5c20ab6ca262613495938ac83d675c
# Parent  55aae13c9e0adc42320cb1bf4d751f8bc282034a
Added comment describing usage.

Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>

diff -r 55aae13c9e0a -r b8bca5421d5c tools/python/xen/xend/xenstore/xswatch.py
--- a/tools/python/xen/xend/xenstore/xswatch.py Wed Nov 23 19:19:24 2005
+++ b/tools/python/xen/xend/xenstore/xswatch.py Wed Nov 23 19:31:14 2005
@@ -13,6 +13,18 @@
 
 class xswatch:
 
+    ##
+    # Create a watch on the given path in the store.  The watch will fire
+    # immediately, then subsequently each time the watched path is changed,
+    # until the watch is deregistered, either by the return value from the
+    # watch callback being False, or by an explicit call to unwatch.
+    #
+    # @param fn The function to be called when the watch fires.  This function
+    # should take the path that has changed as its first argument, followed by
+    # the extra arguments given to this constructor, if any.  It should return
+    # True if the watch is to remain registered, or False if it is to be
+    # deregistered.
+    #
     def __init__(self, path, fn, *args, **kwargs):
         self.path = path
         self.fn = fn

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog