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

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2013-05-15 11:44:28 -0500 (Wed, 15 May 2013)
New Revision: 6507

Modified:
   trunk/docs/designs/swiftwrap.txt
Log:
Some info on relative vs. absolute paths and how they are handled


Modified: trunk/docs/designs/swiftwrap.txt
===================================================================
--- trunk/docs/designs/swiftwrap.txt	2013-05-14 16:58:46 UTC (rev 6506)
+++ trunk/docs/designs/swiftwrap.txt	2013-05-15 16:44:28 UTC (rev 6507)
@@ -6,7 +6,7 @@
 |============================
 |Argument       | Description      
 | -a            | Command line arguments passed to app
-| -d            | DIRS?
+| -d            | List of directories to create
 | -e            | App to execute
 | -err          | Where to write stderr
 | -i            | Set stdin
@@ -21,10 +21,60 @@
 | -wt           | Wrapper log always transfer, true/false
 |============================
 
-Enabling wrapper staging
-------------------------
+Swift properties related to wrapper staging
+-------------------------------------------
+[options="header"]
+|============================
+|Setting	| Description
+| use.wrapper.staging | If set to true, enable wrapper staging. Defaults to false.
+| wrapper.staging.local.server | Swift passes a URL prefix to swiftwrap.wrapperstaging that determines how to access local files. This setting determines what the prefix is (for example, file://).
+|============================
+
+Protocols
+---------
+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.
+
+file://
+~~~~~~~
+TODO: How to set different modes of file staging?
+
+gsiftp://
+~~~~~~~~~
+GSIFTP files will be transferred using the globus-url-copy command.
+
+Examples of how swiftwrap is called
+-----------------------------------
+
+Using absolute pathnames
+~~~~~~~~~~~~~~~~~~~~~~~~
+In this example, Swift tries to map the file below using an absolute path
 -----
-use.wrapper.staging=true
-wrapper.staging.local.server=file://
+file data <"/home/davidkelly999/staging/dd-absolute/data.txt">;
 -----
+._swiftwrap.wrapperstaging arguments
+|====================================
+| -if | file://localhost//home/davidkelly999/staging/dd-absolute/data.txt
+| -of | catsn.0001.out
+| -urlprefix | file:///home/davidkelly999/staging/dd-absolute
+| -d | \__root__/home/davidkelly999/staging/dd-absolute\|.
+| -a | \__root__/home/davidkelly999/staging/dd-absolute/data.txt
+|====================================
 
+Using relative pathnames
+~~~~~~~~~~~~~~~~~~~~~~~~
+Here is an example using relative pathnames in Swift.
+-----
+file data <"data.txt">;
+-----
+._swiftwrap.wrapperstaging arguments
+|===================================
+| -if | file://localhost/data.txt
+| -of | catsn.0001.out
+| -urlprefix | file:///home/davidkelly999/staging/dd-relative
+| -d | \|.
+| -a | data.txt
+|===================================