[Swift-commit] r6234 - in trunk/docs: cookbook userguide
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Mon Feb 4 13:37:36 CST 2013
Author: ketan
Date: 2013-02-04 13:37:36 -0600 (Mon, 04 Feb 2013)
New Revision: 6234
Modified:
trunk/docs/cookbook/debugging
trunk/docs/cookbook/swift_basics
trunk/docs/userguide/app_procedures
trunk/docs/userguide/commands
trunk/docs/userguide/configuration_properties
trunk/docs/userguide/language
trunk/docs/userguide/mappers
trunk/docs/userguide/overview
trunk/docs/userguide/reliability_mechanisms
trunk/docs/userguide/transformation_catalog
Log:
SwiftScript -> Swift script
Modified: trunk/docs/cookbook/debugging
===================================================================
--- trunk/docs/cookbook/debugging 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/cookbook/debugging 2013-02-04 19:37:36 UTC (rev 6234)
@@ -4,8 +4,8 @@
. All text from standard output and standard error produced by running the
swift command
-. The .log file from this run. It will be named swiftscript.uniqueID.log
-where "swiftscript" is the name of your *.swift script source file, and
+. The .log file from this run. It will be named script.uniqueID.log
+where "script" is the name of your *.swift script source file, and
uniqueID is a long unique id which starts with the date and time you ran the
swift command.
. $HOME/.globus/coasters directory on remote machines on which you are
Modified: trunk/docs/cookbook/swift_basics
===================================================================
--- trunk/docs/cookbook/swift_basics 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/cookbook/swift_basics 2013-02-04 19:37:36 UTC (rev 6234)
@@ -90,7 +90,7 @@
The _site_ field should correspond to a site name listed in the sites catalog.
The _transformation-name_ should correspond to the transformation name used in a
-SwiftScript app procedure.
+Swift script app procedure.
The _executable-path_ should specify where the particular executable is located
on that site.
@@ -141,9 +141,9 @@
</pool>
source~~~~~~
-First SwiftScript
+First Swift script
~~~~~~~~~~~~~~~~~
-Your first SwiftScript
+Your first Swift script
Hello Swift-World!
A good sanity check that Swift is set up and running OK locally is this:
@@ -163,7 +163,7 @@
Progress:
-SwiftScript trace: Hello, Swift world!
+Swift trace: Hello, Swift world!
Final status:
@@ -173,7 +173,7 @@
http://www.ci.uchicago.edu/swift/guides/tutorial.php. Follow the steps in that
tutorial to learn how to run a few simple scripts on the login host.
-second SwiftScript
+second Swift script
~~~~~~~~~~~~~~~~~~~
Following is a more involved Swift script.
[java]
@@ -438,14 +438,14 @@
RunID: 20100310-1105-4okarq08
Progress:
-SwiftScript trace: 1, output/myfile.h11v04.mytype
-SwiftScript trace: 2, home/wilde/bigdata/data/sample/h11v05.tif
-SwiftScript trace: 3, home/wilde/bigdata/data/sample/h12v04.tif
-SwiftScript trace: 0, output/myfile.h32v08.mytype
-SwiftScript trace: 0, home/wilde/bigdata/data/sample/h32v08.tif
-SwiftScript trace: 3, output/myfile.h12v04.mytype
-SwiftScript trace: 1, home/wilde/bigdata/data/sample/h11v04.tif
-SwiftScript trace: 2, output/myfile.h11v05.mytype
+Swift script trace: 1, output/myfile.h11v04.mytype
+Swift script trace: 2, home/wilde/bigdata/data/sample/h11v05.tif
+Swift script trace: 3, home/wilde/bigdata/data/sample/h12v04.tif
+Swift script trace: 0, output/myfile.h32v08.mytype
+Swift script trace: 0, home/wilde/bigdata/data/sample/h32v08.tif
+Swift script trace: 3, output/myfile.h12v04.mytype
+Swift script trace: 1, home/wilde/bigdata/data/sample/h11v04.tif
+Swift script trace: 2, output/myfile.h11v05.mytype
Final status:
login1$
----
Modified: trunk/docs/userguide/app_procedures
===================================================================
--- trunk/docs/userguide/app_procedures 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/app_procedures 2013-02-04 19:37:36 UTC (rev 6234)
@@ -15,7 +15,7 @@
mechanisms by which Swift performs that translation; that is described
in the next section.
-In this section, this example SwiftScript program is used for reference:
+In this section, this example Swift script is used for reference:
----
type file;
@@ -40,7 +40,7 @@
This application workspace directory will not be shared with any other
application procedure execution attempt; all application procedure
execution attempts will run with distinct application procedure
-workspaces. (for the avoidance of doubt: If a SwiftScript procedure
+workspaces. (for the avoidance of doubt: If a Swift script procedure
invocation is subject to multiple application procedure execution
attempts (due to Swift-level restarts, retries or replication) then each
of those application procedure execution attempts will be made in a
@@ -87,7 +87,7 @@
of the application executable), then the application executable
should exit with unix return code not equal to 0.
- * Each file mapped from an output parameter of the SwiftScript
+ * Each file mapped from an output parameter of the Swift script
procedure call must exist. Files will be mapped in the same way as
for input files.
@@ -212,7 +212,7 @@
information at execution time to aid in debugging and provenance capture.
-SwiftScript language compilation layer
+Swift script language compilation layer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Step i: text to XML intermediate form parser/processor. parser written
in ANTLR - see resources/VDL.g. The XML Schema Definition (XSD) for the
@@ -220,7 +220,7 @@
Step ii: XML intermediate form to Karajan workflow. Karajan.java - reads
the XML intermediate form. compiles to karajan workflow language - for
-example, expressions are converted from SwiftScript syntax into Karajan
+example, expressions are converted from Swift script syntax into Karajan
syntax, and function invocations become karajan function invocations
with various modifications to parameters to accomodate return parameters
and dataset handling.
@@ -261,7 +261,7 @@
Function reference
------------------
This section details functions that are available for use in the
-SwiftScript language.
+Swift scripting language.
@arg
~~~~
@@ -287,8 +287,8 @@
Swift v0.3-dev r1674 (modified locally)
RunID: 20080220-1548-ylc4pmda
-SwiftScript trace: defaultvalue
-SwiftScript trace: hello
+Swift trace: defaultvalue
+Swift trace: hello
----
@extractint
@@ -408,13 +408,13 @@
@toint
~~~~~~
@toint(input) will parse its input string into an integer. This can be
-used with @arg to pass input parameters to a SwiftScript program as
+used with @arg to pass input parameters to a Swift script as
integers.
@tofloat
~~~~~~
@tofloat(input) will parse its input string into a floating point number. This can be
-used with @arg to pass input parameters to a SwiftScript program as
+used with @arg to pass input parameters to a Swift script as
floating point numbers.
@length
@@ -428,7 +428,7 @@
Built-in procedure reference
----------------------------
This section details built-in procedures that are available for use in
-the SwiftScript language.
+the Swift scripting language.
readData
~~~~~~~~
Modified: trunk/docs/userguide/commands
===================================================================
--- trunk/docs/userguide/commands 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/commands 2013-02-04 19:37:36 UTC (rev 6234)
@@ -8,15 +8,15 @@
swift
~~~~~
The swift command is the main command line tool for executing
-SwiftScript programs.
+Swift scripts.
Command-line Syntax
^^^^^^^^^^^^^^^^^^^
The swift command is invoked as follows: swift [options]
-SwiftScript-program [SwiftScript-arguments]* with options taken from the
-following list, and SwiftScript-arguments made available to the
-SwiftScript program through the @arg function.
+Swifti script [Swift-arguments]* with options taken from the
+following list, and Swift script arguments made available to the
+Swift script through the @arg function.
Swift command-line options
@@ -26,11 +26,11 @@
-typecheck
- Does a typecheck of a SwiftScript program, instead of executing it.
+ Does a typecheck of a Swift script, instead of executing it.
-dryrun
- Runs the SwiftScript program without submitting any jobs (can be
+ Runs the Swift script without submitting any jobs (can be
used to get a graph)
-monitor
Modified: trunk/docs/userguide/configuration_properties
===================================================================
--- trunk/docs/userguide/configuration_properties 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/configuration_properties 2013-02-04 19:37:36 UTC (rev 6234)
@@ -173,12 +173,12 @@
value of this property. If set to false, Swift will report the
first error encountered and immediately stop execution. If set to
true, Swift will attempt to run as much as possible from a
- SwiftScript program before stopping execution and reporting all
+ Swift script before stopping execution and reporting all
errors encountered.
- When developing SwiftScript programs, using the default value of
+ When developing Swift scripts, using the default value of
false can make the program easier to debug. However in production
- runs, using true will allow more of a SwiftScript program to be
+ runs, using true will allow more of a Swift script to be
run before Swift aborts execution.
pgraph
@@ -188,7 +188,7 @@
Default value: false
Swift can generate a Graphviz <http://www.graphviz.org/> file
- representing the structure of the SwiftScript program it has run. If
+ representing the structure of the Swift script it has run. If
this property is set to true, Swift will save the provenance graph
in a file named by concatenating the program name and the instance
ID (e.g. helloworld-ht0adgi315l61.dot).
Modified: trunk/docs/userguide/language
===================================================================
--- trunk/docs/userguide/language 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/language 2013-02-04 19:37:36 UTC (rev 6234)
@@ -1,5 +1,5 @@
-The SwiftScript Language
-------------------------
+The Swift scripting Language
+----------------------------
Language basics
~~~~~~~~~~~~~~~
@@ -64,15 +64,15 @@
The examples above have used the type image without any definition of
that type. We can declare it as a marker type which has no structure
-exposed to SwiftScript:
+exposed to Swift script:
----
type image;
----
This does not indicate that the data is unstructured; but it indicates
-that the structure of the data is not exposed to SwiftScript. Instead,
-SwiftScript will treat variables of this type as individual opaque files.
+that the structure of the data is not exposed to Swift. Instead,
+Swift will treat variables of this type as individual opaque files.
With mechanisms to declare types, map variables to data files, and
declare and invoke procedures, we can build a complete (albeit simple)
@@ -172,7 +172,7 @@
z=q(y);
----
-Arrays in SwiftScript are more monotonic - a generalisation of being
+Arrays in Swift are more monotonic - a generalisation of being
assignment. Knowledge about the content of an array increases during
execution, but cannot otherwise change. Each element of the array is
itself single assignment or monotonic (depending on its type). During a
@@ -208,9 +208,9 @@
~~~~~~~~~~~~~~~~~~~
As with many other programming languages, procedures consisting of
-SwiftScript code can be defined. These differ from the previously
+Swift script can be defined. These differ from the previously
mentioned procedures declared with the app keyword, as they invoke
-other SwiftScript procedures rather than a component program.
+other Swift procedures rather than a component program.
----
(file output) process (file input) {
@@ -249,13 +249,13 @@
More about types
~~~~~~~~~~~~~~~~
-Each variable and procedure parameter in SwiftScript is strongly typed.
+Each variable and procedure parameter in Swift script is strongly typed.
Types are used to structure data, to aid in debugging and checking
program correctness and to influence how Swift interacts with data.
The image type declared in previous examples is a marker type.
Marker types indicate that data for a variable is stored in a single
-file with no further structure exposed at the SwiftScript level.
+file with no further structure exposed at the Swift script level.
Arrays have been mentioned above, in the arrays section. A code block
may be applied to each element of an array using foreach; or
Modified: trunk/docs/userguide/mappers
===================================================================
--- trunk/docs/userguide/mappers 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/mappers 2013-02-04 19:37:36 UTC (rev 6234)
@@ -24,7 +24,7 @@
The above example declares a dataset called f1, which uses a single file
mapper to map a file from a specific location.
-SwiftScript has a simplified syntax for this case, since
+Swift has a simplified syntax for this case, since
single_file_mapper is frequently used:
----
@@ -35,20 +35,20 @@
patterns. These are documented in the mappers section of this
guide.
-More technical details about SwiftScript
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The syntax of SwiftScript has a superficial resemblance to C and Java.
+More technical details about Swift script
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The syntax of Swift script has a superficial resemblance to C and Java.
For example, { and } characters are used to enclose blocks of statements.
-A SwiftScript program consists of a number of statements. Statements may
+A Swift script consists of a number of statements. Statements may
declare types, procedures and variables, assign values to variables, and
express operations over arrays.
Variables
^^^^^^^^^
-Variables in SwiftScript are declared to be of a specific type.
-Assignments to those variables must be data of that type. SwiftScript
+Variables in Swift scripts are declared to be of a specific type.
+Assignments to those variables must be data of that type. Swift script
variables are single-assignment - a value may be assigned to a variable
at most once. This assignment can happen at declaration time or later on
in execution. When an attempt to read from a variable that has not yet
@@ -98,10 +98,10 @@
~~~~~~~~~~
There are two kinds of procedure: An atomic procedure, which describes
how an external program can be executed; and compound procedures which
-consist of a sequence of SwiftScript statements.
+consist of a sequence of Swift script statements.
A procedure declaration defines the name of a procedure and its input
-and output parameters. SwiftScript procedures can take multiple inputs
+and output parameters. Swift script procedures can take multiple inputs
and produce multiple outputs. Inputs are specified to the right of the
function name, and outputs are specified to the left. For example:
@@ -155,7 +155,7 @@
Compound procedures
^^^^^^^^^^^^^^^^^^^
-A compound procedure contains a set of SwiftScript statements:
+A compound procedure contains a set of Swift script statements:
----
(type2 b) foo_bar (type1 a) {
@@ -167,7 +167,7 @@
Control Constructs
~~~~~~~~~~~~~~~~~~
-SwiftScript provides if, switch, foreach, and iterate
+Swift script provides if, switch, foreach, and iterate
constructs, with syntax and semantics similar to comparable constructs
in other high-level languages.
@@ -265,7 +265,7 @@
Operators
~~~~~~~~~
-The following infix operators are available for use in SwiftScript
+The following infix operators are available for use in Swift script
expressions.
[options="header, autowidth"]
@@ -286,7 +286,7 @@
Global constants
~~~~~~~~~~~~~~~~
-At the top level of a SwiftScript program, the global modified may be
+At the top level of a Swift script program, the global modified may be
added to a declaration so that it is visible throughout the program,
rather than only at the top level of the program. This allows global
constants (of any type) to be defined. (since Swift 0.10)
@@ -295,9 +295,9 @@
Imports
~~~~~~~
The import directive can be used to import definitions from another
-SwiftScript file. (since Swift 0.10)
+Swift file.
-For example, a SwiftScript program might contain this:
+For example, a Swift script might contain this:
----
import "defs";
@@ -337,7 +337,7 @@
is imported multiple times, for example in different files, then Swift
will only process the imports once.
-Imports may contain anything that is valid in a SwiftScript program,
+Imports may contain anything that is valid in a Swift script,
including the code that causes remote execution.
Mappers
@@ -754,9 +754,11 @@
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. 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.
+variable, in Swift script syntax (for example [2] means the 2nd element of an
+array) or the symbol $ to represent the root of the mapped 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"]
|=============
@@ -793,7 +795,12 @@
|stus[2]|qux
|===========
-Advanced Example: The following mapper.sh is an advanced example of an external mapper that maps a two-dimensional array to a directory of files. The files in the said directory are identified by their names appended by a number between 000 and 099. The first index of the array maps to the first part of the filename while the second index of the array maps to the second part of the filename.
+Advanced Example: The following mapper.sh is an advanced example of an external
+mapper that maps a two-dimensional array to a directory of files. The files in
+the said directory are identified by their names appended by a number between
+000 and 099. The first index of the array maps to the first part of the
+filename while the second index of the array maps to the second part of the
+filename.
----
#!/bin/sh
@@ -837,7 +844,9 @@
----
-Assuming there are 4 files with name aaa, bbb, ccc, ddd and a mod_index of 10, we will have 4x10=40 files mapped to a two-dimensional array in the following pattern:
+Assuming there are 4 files with name aaa, bbb, ccc, ddd and a mod_index of 10,
+we will have 4x10=40 files mapped to a two-dimensional array in the following
+pattern:
[options="header, autowidth"]
|============
Modified: trunk/docs/userguide/overview
===================================================================
--- trunk/docs/userguide/overview 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/overview 2013-02-04 19:37:36 UTC (rev 6234)
@@ -1,6 +1,6 @@
Overview
--------
-This manual provides reference material for Swift: the SwiftScript
+This manual provides reference material for Swift: the Swift
language and the Swift runtime system. For introductory material,
consult the Swift tutorial
<http://www.ci.uchicago.edu/swift/guides/tutorial.php>.
@@ -10,9 +10,9 @@
and procedural composition.
Swift programs (or workflows) are written in a language called
-SwiftScript.
+Swift scripts.
-SwiftScript programs are dataflow oriented - they are primarily
+Swift scripts are dataflow oriented - they are primarily
concerned with processing (possibly large) collections of data files, by
invoking programs to do that processing. Swift handles execution of such
programs on remote sites by choosing sites, handling the staging of
Modified: trunk/docs/userguide/reliability_mechanisms
===================================================================
--- trunk/docs/userguide/reliability_mechanisms 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/reliability_mechanisms 2013-02-04 19:37:36 UTC (rev 6234)
@@ -26,7 +26,7 @@
using the unique job ID and a .rlog extension. This restart log can
then be passed to a subsequent Swift invocation using the -resume
parameter. Swift will resume execution, avoiding execution of
-invocations that have previously completed successfully. The SwiftScript
+invocations that have previously completed successfully. The Swift
source file and input data files should not be modified between runs.
Every run creates a restart log file with a named composed of the file
@@ -38,7 +38,7 @@
fails, swift can use the restart log file to continue execution from a
point before the failure occurred. In order to restart from a restart
log file, the -resume logfile argument can be used after the
-SwiftScript program file name. Example:
+Swift script file name. Example:
----
$ swift -resume example-ht0adgi315l61.0.rlog example.swift.
Modified: trunk/docs/userguide/transformation_catalog
===================================================================
--- trunk/docs/userguide/transformation_catalog 2013-02-04 14:44:42 UTC (rev 6233)
+++ trunk/docs/userguide/transformation_catalog 2013-02-04 19:37:36 UTC (rev 6234)
@@ -22,7 +22,7 @@
The site field should correspond to a site name listed in the sites catalog.
The transformation name should correspond to the transformation name
-used in a SwiftScript app procedure.
+used in a Swift script app procedure.
The executable path should specify where the particular executable is
located on that site.
More information about the Swift-commit
mailing list