From 2c0e4bc79856fce6ea87b72b9b2e5342c94dfdbe Mon Sep 17 00:00:00 2001 From: hpk Date: Fri, 2 Feb 2007 21:57:59 +0100 Subject: [PATCH] [svn r37830] better RSync docstring --HG-- branch : trunk --- py/execnet/rsync.py | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/py/execnet/rsync.py b/py/execnet/rsync.py index ab1fa5f4b..064c6ae10 100644 --- a/py/execnet/rsync.py +++ b/py/execnet/rsync.py @@ -3,18 +3,17 @@ from Queue import Queue class RSync(object): - """ This is an example usage of py.execnet - a sample RSync - protocol, which can perform syncing 1-to-n. + """ This class allows to synchronise files and directories + with one or multiple remote filesystems. - Sample usage: you instantiate this class, eventually providing a - callback when rsyncing is done, than add some targets - (gateway + destdir) by running add_target and finally - invoking send() which will send provided source tree remotely. + An RSync instance allows to dynamically add remote targets + and then synchronizes the remote filesystems with + any provided source directory. - There is limited support for symlinks, which means that symlinks - pointing to the sourcetree will be send "as is" while external - symlinks will be just copied (regardless of existance of such - a path on remote side) + There is limited support for symlinks, which means that symlinks + pointing to the sourcetree will be send "as is" while external + symlinks will be just copied (regardless of existance of such + a path on remote side). """ def __init__(self, callback=None, **options): for name in options: