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

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2013-08-19 15:09:18 -0500 (Mon, 19 Aug 2013)
New Revision: 6884

Modified:
   trunk/docs/designs/swiftwrap.txt
Log:
Add note about setting file provider aliases


Modified: trunk/docs/designs/swiftwrap.txt
===================================================================
--- trunk/docs/designs/swiftwrap.txt	2013-08-19 18:03:27 UTC (rev 6883)
+++ trunk/docs/designs/swiftwrap.txt	2013-08-19 20:09:18 UTC (rev 6884)
@@ -70,6 +70,22 @@
 file data <"stage:///home/davidkelly999/staging/absolute/stage/data.txt">;
 -----
 
+Adding new protocols
+~~~~~~~~~~~~~~~~~~~~
+The file cog/modules/provider-local/resources/cog-provider.properties allows you to set aliases.
+Define your new file protocol as an alias to "local". Suppose you would like
+to add a new protocol called "megaftp", you could add a line that looks like
+this:
+
+-----
+alias=megaftp:local
+-----
+
+In your swift script, you would reference the file as
+megaftp://path/to/file.txt.
+
+NOTE: You will need to recompile after making this change.
+
 Examples of how swiftwrap is called
 -----------------------------------