[Swift-commit] r4656 - trunk/docs/userguide

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2011-06-22 17:11:29 -0500 (Wed, 22 Jun 2011)
New Revision: 4656

Modified:
   trunk/docs/userguide/mappers
Log:
added content for external mapper

Modified: trunk/docs/userguide/mappers
===================================================================
--- trunk/docs/userguide/mappers	2011-06-22 19:27:21 UTC (rev 4655)
+++ trunk/docs/userguide/mappers	2011-06-22 22:11:29 UTC (rev 4656)
@@ -722,12 +722,22 @@
 |*|Other parameters are passed to the executable prefixed with a - symbol
 |==============
 
-The output of the executable should consist of two columns of data,
+The output (stdout) of the executable should consist of two columns of data,
 separated by a space. The first column should be the path of the mapped
 variable, in SwiftScript syntax (for example [2] means the 2nd element
 of an array) or the symbol $ to represent the root of the mapped
-variable.
+variable. The following table shows the symbols that should appear in the first column corresponding to the mapping of different types of swift constructs such as scalars, arrays and structs.
 
+[option="header, autowidth"]
+|=============
+|Swift construct|first column|second column
+|scalar|$|file_name
+|anarray[]|[]|file_name
+|2dimarray[][]|[][]|file_name
+|astruct.fld|fld|file_name
+|astructarray[].fldname|[].fldname|file_name
+|==============
+
 Example: With the following in mapper.sh,
 
 ----