[Swift-commit] r4657 - trunk/docs/tutorial
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Wed Jun 22 22:45:35 CDT 2011
Author: ketan
Date: 2011-06-22 22:45:35 -0500 (Wed, 22 Jun 2011)
New Revision: 4657
Modified:
trunk/docs/tutorial/hello_world
trunk/docs/tutorial/introduction
trunk/docs/tutorial/language_features
trunk/docs/tutorial/runtime_features
Log:
Made some changes in tutorial for better readability and added some todo items
Modified: trunk/docs/tutorial/hello_world
===================================================================
--- trunk/docs/tutorial/hello_world 2011-06-22 22:11:29 UTC (rev 4656)
+++ trunk/docs/tutorial/hello_world 2011-06-23 03:45:35 UTC (rev 4657)
@@ -12,7 +12,7 @@
************
We can run this program as follows:
-
+note: Make sure the bin directory of swift-installation is in your path.
----
$ cd examples/swift/
$ swift first.swift
Modified: trunk/docs/tutorial/introduction
===================================================================
--- trunk/docs/tutorial/introduction 2011-06-22 22:11:29 UTC (rev 4656)
+++ trunk/docs/tutorial/introduction 2011-06-23 03:45:35 UTC (rev 4657)
@@ -1,20 +1,18 @@
Introduction
------------
This tutorial is intended to introduce new users to the basics of Swift.
-It is structured as a series of small exercise/examples which you can
+It is structured as a series of simple exercises/examples which you can
try for yourself as you read along. After the first 'hello world'
-example, there are two tracks - the language track (which introduces
-features of the SwiftScript language) and the runtime track (which
-introduces features of the Swift runtime environment, such as running
-jobs on different sites).
+example, there are two tracks - the language track (which introduces the SwiftScript language) and the runtime track (which introduces features of the Swift runtime environment, such as running
+jobs on different computational 'sites').
For information on getting an installation of Swift running, consult the
Swift Quickstart Guide <http://www.ci.uchicago.edu/swift/guides/quickstartguide.php>, and
return to this document when you have successfully run the test
-SwiftScript program mentioned there.
+SwiftScript program mentioned there. _suggest_ _which_ _version_.
There is also a Swift User's Guide
<http://www.ci.uchicago.edu/swift/guides/userguide.php> which contains
-more detailed reference material on topics covered in this manual. All
+a more detailed reference material on topics covered in this manual. All
of the programs included in this tutorial can be found in your Swift
-distribution in the examples/swift directory.
+distribution in the +examples/swift+ directory.
Modified: trunk/docs/tutorial/language_features
===================================================================
--- trunk/docs/tutorial/language_features 2011-06-22 22:11:29 UTC (rev 4656)
+++ trunk/docs/tutorial/language_features 2011-06-23 03:45:35 UTC (rev 4657)
@@ -11,7 +11,7 @@
to the greeting function.
The code changes from first.swift are highlighted below.
-
+ToDo: Highlight the differences!
----
include::../../examples/parameter.swift[]
@@ -57,6 +57,7 @@
In addition to specifying parameters positionally, parameters can be
named, and if desired a default value can be specified - see <<named_parameters, Named and Optional Parameters>>.
+ToDo: link not working.
Adding another application
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -73,11 +74,13 @@
----
.There are several steps
-- transformation catalog
-- application block
+- Updating the transformation catalog
+- Updating the application block
+ToDo: What is transformation catalog? One line explanation.
+
First we need to modify the transformation catalog to define a logical
-transformation for the tc utility. The transformation catalog can be
+transformation for the tr utility. The transformation catalog can be
found in etc/tc.data. There are already several entries specifying
where programs can be found. Add a new line to the file, specifying
where *tr* can be found (usually in /usr/bin/tr but it may differ on
@@ -153,7 +156,7 @@
- string - this is a built-in type for storing strings of text in
memory, much like in other programming languages
- - messagefile - this is a user-defined type used to mark files as
+ - messagefile - this is a user-defined type used to mark disc resident files as
containing messages
SwiftScript has the additional built-in types: boolean, integer and
@@ -306,8 +309,8 @@
foreach
~~~~~~~
-SwiftScript provides a control structure, foreach, to operate on each
-element of an array.
+SwiftScript provides a control structure, foreach, to operate on each
+element of an array in parallel.
In this example, we will run the previous word counting example over
each file in an array without having to explicitly list the array
@@ -327,6 +330,7 @@
~~
Decisions can be made using 'if', like this:
+TODO: More examples of if required.
----
if(morning) {
@@ -343,8 +347,7 @@
Sequential iteration
~~~~~~~~~~~~~~~~~~~~
-A development version of Swift after 0.2 (revision 1230) introduces a
-sequential iteration construct.
+A serial execution of instructions can be carried out using the sequential iteration construct.
The following example demonstrates a simple application: each step of
the iteration is a string representation of the byte count of the
@@ -358,11 +361,10 @@
include::../../examples/iterate.swift[]
----
-echo is the standard unix echo.
+Where, echo is the standard unix echo utility.
-wcl is our application code - it counts the number of bytes in the one
+_wcl_ is our application code - it counts the number of bytes in the one
file and writes that count out to another, like this:
-
----
$ cat ../wcl
@@ -376,8 +378,9 @@
----
Install the above wcl script somewhere and add a transformation catalog
-entry for it. Then run the example program like this:
+(tc) entry for it. Then run the example program like this:
+TODO: Show the tc entry.
----
$ swift iterate.swift
Modified: trunk/docs/tutorial/runtime_features
===================================================================
--- trunk/docs/tutorial/runtime_features 2011-06-22 22:11:29 UTC (rev 4656)
+++ trunk/docs/tutorial/runtime_features 2011-06-23 03:45:35 UTC (rev 4657)
@@ -1,7 +1,7 @@
Runtime features
----------------
-Visualising the workflow as a graph
+Visualizing the workflow as a graph
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When running a workflow, its possible to generate a provenance graph at
More information about the Swift-commit
mailing list