[Swift-commit] r6513 - trunk/docs/designs

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2013-05-20 10:17:13 -0500 (Mon, 20 May 2013)
New Revision: 6513

Modified:
   trunk/docs/designs/swiftwrap.txt
Log:
Examples of using direct:// and stage://


Modified: trunk/docs/designs/swiftwrap.txt
===================================================================
--- trunk/docs/designs/swiftwrap.txt	2013-05-20 06:00:24 UTC (rev 6512)
+++ trunk/docs/designs/swiftwrap.txt	2013-05-20 15:17:13 UTC (rev 6513)
@@ -34,18 +34,42 @@
 ---------
 Below is a list of protocols supported by _swiftwrap.wrapperstaging and a brief explanation of how they are implemented.
 
-http://
-~~~~~~~
-HTTP is implemented in _swiftwrap.wrapperstaging via the wget command.
+direct://
+~~~~~~~~~
+The direct protocol allows you to bypass file staging to the swift created
+work directory. Instead of making a copy of the file, a symlink will be
+created which points to the original location of the file. 
+-----
+file data <"direct:///home/davidkelly999/staging/absolute/direct/data.txt">;
+-----
 
 file://
 ~~~~~~~
-TODO: How to set different modes of file staging?
+By default, files that use the file:// URI, or files that specify no URI at
+all, will act in a way that is similar to the behavior or direct://. A symlink
+will be created in the Swift work directory that points to the original
+location of the file.
+-----
+file data <"file:///home/davidkelly999/staging/absolute/file/data.txt">;
+file data2 <"/home/davidkelly999/staging/absolute/normal/data.txt">;
+-----
 
 gsiftp://
 ~~~~~~~~~
 GSIFTP files will be transferred using the globus-url-copy command.
 
+http://
+~~~~~~~
+HTTP is implemented in _swiftwrap.wrapperstaging via the wget command.
+
+stage://
+~~~~~~~~
+If a file begins with stage://, a copy of the file will be made in the work
+directory. Files get copied using dd with a 10MB block size.
+-----
+file data <"stage:///home/davidkelly999/staging/absolute/stage/data.txt">;
+-----
+
 Examples of how swiftwrap is called
 -----------------------------------