[Zope3-checkins] CVS: Zope3/src/zope/app/fssync - syncer.py:1.9

Guido van Rossum guido@python.org
Sat, 10 May 2003 17:09:57 -0400


Update of /cvs-repository/Zope3/src/zope/app/fssync
In directory cvs.zope.org:/tmp/cvs-serv15636

Modified Files:
	syncer.py 
Log Message:
Add some reverse-engineered documentation, still unsatisfactory.


=== Zope3/src/zope/app/fssync/syncer.py 1.8 => 1.9 ===
--- Zope3/src/zope/app/fssync/syncer.py:1.8	Thu May  8 15:48:26 2003
+++ Zope3/src/zope/app/fssync/syncer.py	Sat May 10 17:09:56 2003
@@ -59,7 +59,12 @@
 
     location -- The directory on the file system where the object will go
 
-    XXX what are mode and objpath?
+    mode -- 'C' for conflict objects,
+            'N' for new objects,
+            'D' for new directories, forces writing @@Zope and Entries.xml,
+            None for normal mode
+
+    objpath -- for mode 'N' or 'D', specify the object's path
 
     writeOriginals -- If True (the default), write 'Original' directory.
     """
@@ -195,6 +200,16 @@
 
 def fromFS(container, name, location, mode=None):
     """Synchromize a file from what's on the file system.
+
+    container -- parent of new object
+
+    name -- name of new object in container
+
+    location -- filesystem directory containing name
+
+    mode -- 'T' to skip updating the filesystem administration,
+            'F' to force updating the filesystem administration,
+            None default
     """
     msg =''
     objectPath = ''