[svn r37830] better RSync docstring

--HG--
branch : trunk
This commit is contained in:
hpk 2007-02-02 21:57:59 +01:00
parent e0a1612d51
commit 2c0e4bc798
1 changed files with 9 additions and 10 deletions

View File

@ -3,18 +3,17 @@ from Queue import Queue
class RSync(object): class RSync(object):
""" This is an example usage of py.execnet - a sample RSync """ This class allows to synchronise files and directories
protocol, which can perform syncing 1-to-n. with one or multiple remote filesystems.
Sample usage: you instantiate this class, eventually providing a An RSync instance allows to dynamically add remote targets
callback when rsyncing is done, than add some targets and then synchronizes the remote filesystems with
(gateway + destdir) by running add_target and finally any provided source directory.
invoking send() which will send provided source tree remotely.
There is limited support for symlinks, which means that symlinks There is limited support for symlinks, which means that symlinks
pointing to the sourcetree will be send "as is" while external pointing to the sourcetree will be send "as is" while external
symlinks will be just copied (regardless of existance of such symlinks will be just copied (regardless of existance of such
a path on remote side) a path on remote side).
""" """
def __init__(self, callback=None, **options): def __init__(self, callback=None, **options):
for name in options: for name in options: