[Swift-commit] r6611 - in branches/faster: . docs/userguide

[hategan at ci.uchicago.edu]

Author: hategan
Date: 2013-07-08 00:44:24 -0500 (Mon, 08 Jul 2013)
New Revision: 6611

Modified:
   branches/faster/
   branches/faster/docs/userguide/mappers
Log:
merged 6206-6208 from trunk


Property changes on: branches/faster
___________________________________________________________________
Modified: svn:mergeinfo
   - /branches/release-0.93:4761-5122
/trunk:6172,6177,6182,6189-6190,6202-6203
   + /branches/release-0.93:4761-5122
/trunk:6172,6177,6182,6189-6190,6202-6203,6206-6208

Modified: branches/faster/docs/userguide/mappers
===================================================================
--- branches/faster/docs/userguide/mappers	2013-07-08 05:41:56 UTC (rev 6610)
+++ branches/faster/docs/userguide/mappers	2013-07-08 05:44:24 UTC (rev 6611)
@@ -338,7 +338,7 @@
 will only process the imports once.
 
 Imports may contain anything that is valid in a SwiftScript program,
-including code that causes remote execution.
+including the code that causes remote execution.
 
 Mappers
 -------
@@ -347,9 +347,9 @@
 remote sites for execution or to pass to applications.
 
 Swift provides a number of mappers that are useful in common cases. This
-section details those standard mappers. For more complex cases, it is
+section details those mappers. For more complex cases, it is
 possible to write application-specific mappers in Java and use them
-within a SwiftScript program.
+within a Swift script.
 
 
 The single file mapper
@@ -360,7 +360,7 @@
 |=======================
 |Swift variable|Filename
 |f|myfile
-|f[0]|INVALID
+|f [0]|INVALID
 |f.bar|INVALID
 |=======================
 
@@ -392,6 +392,7 @@
 |location|A directory that the files are located.
 |prefix|The prefix of the files
 |suffix|The suffix of the files, for instance: ".txt"
+|padding| The number of digits used to uniquely identify the mapped file. This is an optional parameter which defaults to 4.
 |pattern|A UNIX glob style pattern, for instance: "\*foo*" would match
 all file names that contain foo. When this mapper is used to specify
 output filenames, pattern is ignored.
@@ -438,7 +439,7 @@
     }
 }
 
-messagefile outfile[] <simple_mapper;prefix="baz",suffix=".txt">;
+messagefile outfile[] <simple_mapper;prefix="baz",suffix=".txt", padding=2>;
 
 outfile[0] = greeting("hello");
 outfile[1] = greeting("middle");
@@ -448,9 +449,9 @@
 [options="header, autowidth"]
 |=======================
 |Swift variable|Filename
-|outfile[0]|baz0000.txt
-|outfile[1]|baz0001.txt
-|outfile[2]|baz0002.txt
+|outfile[0]|baz00.txt
+|outfile[1]|baz01.txt
+|outfile[2]|baz02.txt
 |=======================
 
 simple_mapper can be used to map structures. It will map the name of
@@ -488,7 +489,7 @@
 
 concurrent mapper
 ~~~~~~~~~~~~~~~~~
-concurrent_mapper is almost the same as the simple mapper, except that
+The concurrent_mapper is almost the same as the simple mapper, except that
 it is used to map an output file, and the filename generated will
 contain an extract sequence that is unique. This mapper is the default
 mapper for variables when no mapper is specified.
@@ -516,12 +517,12 @@
 
 File system mapper
 ~~~~~~~~~~~~~~~~~~
-filesys_mapper is similar to the simple mapper, but maps a file or a
+The filesys_mapper is similar to the simple mapper, but maps a file or a
 list of files to an array. Each of the filename is mapped as an element
 in the array. The order of files in the resulting array is not defined.
 
 TODO: note on difference between location as a relative vs absolute path
-wrt staging to remote location - as mihael said: It's because you
+w.r.t. staging to remote location - as mihael said: It's because you
 specify that location in the mapper. Try location="." instead of
 location="/sandbox/..."