[Swift-commit] r6285 - in trunk/docs: . merged merged/userguide

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2013-02-16 10:38:43 -0600 (Sat, 16 Feb 2013)
New Revision: 6285

Modified:
   trunk/docs/build_docs.sh
   trunk/docs/merged/build_docs.sh
   trunk/docs/merged/userguide/coasters
Log:
minor updates

Modified: trunk/docs/build_docs.sh
===================================================================
--- trunk/docs/build_docs.sh	2013-02-15 20:10:43 UTC (rev 6284)
+++ trunk/docs/build_docs.sh	2013-02-16 16:38:43 UTC (rev 6285)
@@ -48,8 +48,6 @@
   exit 1
 fi
 
-INSTALLATION_DIRECTORY=$1
-
 # Create installation directory if needed
 if [ ! -d "$INSTALLATION_DIRECTORY" ]; then
    mkdir $INSTALLATION_DIRECTORY || crash "Unable to create directory $INSTALLATION_DIRECTORY"

Modified: trunk/docs/merged/build_docs.sh
===================================================================
--- trunk/docs/merged/build_docs.sh	2013-02-15 20:10:43 UTC (rev 6284)
+++ trunk/docs/merged/build_docs.sh	2013-02-16 16:38:43 UTC (rev 6285)
@@ -113,3 +113,4 @@
 
 find $INSTALLATION_DIRECTORY/$VERSION -type f -exec chgrp $GROUP {} \; -exec chmod $CHMOD_FILE_MODE {} \; > /dev/null 2>&1
 find $INSTALLATION_DIRECTORY/$VERSION -type d -exec chgrp $GROUP {} \; -exec chmod $CHMOD_DIRECTORY_MODE {} \; > /dev/null 2>&1
+

Modified: trunk/docs/merged/userguide/coasters
===================================================================
--- trunk/docs/merged/userguide/coasters	2013-02-15 20:10:43 UTC (rev 6284)
+++ trunk/docs/merged/userguide/coasters	2013-02-16 16:38:43 UTC (rev 6285)
@@ -3,7 +3,7 @@
 
 Introduction
 ~~~~~~~~~~~~
-Coasters are the Swift's implementation of _pilot job abstraction_.
+Coasters are the Swift's implementation of the _pilot job abstraction_.
 
 In many applications, Swift performance can be greatly enhanced by the use of
 coasters. Coasters provide a low-overhead job submission and file transfer
@@ -39,7 +39,7 @@
 To use for job execution, specify a sites.xml execution element like this:
 
 ----
-<execution provider="coaster" jobmanager="gt2:gt2:pbs" url="grid.myhost.org">
+<execution provider="coaster" jobmanager="local:pbs" url="grid.myhost.org">
 ----
 
 The jobmanager string contains more detail than with other providers. It
@@ -55,7 +55,7 @@
 To use for file transfer, specify a sites.xml filesystem element like this:
 
 ----
-<filesystem provider="coaster" url="gt2://grid.myhost.org" />
+<filesystem provider="coaster" url="gftp://grid.myhost.org" />
 ----
 
 The url parameter should be a pseudo-URI formed with the URI scheme
@@ -93,10 +93,11 @@
 Coasters
 --------
 Coasters were introduced in Swift v0.6 as an experimental feature. In many
-applications, Swift performance can be greatly enhanced by the use of
-coasters. Coasters provide a low-overhead job submission and file transfer
-mechanism suited for the execution of short jobs (on the order of a few
-seconds). A detailed information on coasters can be found at http://www.ci.uchicago.edu/swift/guides/userguide.php#coasters.
+applications, Swift performance can be greatly enhanced by the use of coasters.
+Coasters provide a low-overhead job submission and file transfer mechanism
+suited for the execution of short jobs (on the order of a few seconds). A
+detailed information on coasters can be found at
+http://www.ci.uchicago.edu/swift/guides/userguide.php#coasters.
 //**Include neat diagrams.**
 
 Following is a coasters setup case-study for a PBS underlying provider where sites.xml coaster settings were:
@@ -129,7 +130,7 @@
 <profile namespace="karajan" key="initialScore">10000</profile>
 source~~~~
 
-The following table briefly describes the elements on the coasters setup:
+The following table briefly describes the elements of the coasters setup:
 [width="70%", cols="^3,10", options="header"]
 |=============================================================================================
 |profile key | brief description
@@ -144,36 +145,19 @@
 |jobThrottle |the number of concurrent jobs allowed on a site
 |==============================================================================================
 
-//
-//For Beginners
-//~~~~~~~~~~~~~~
-//Coasters for beginners. Usage of existing, prebuilt templates.
-//
-//For Intermediate Users
-//~~~~~~~~~~~~~~~~~~~~~~~
-//Coasters for intermediate users. 
-//
-//Using gensites
-//^^^^^^^^^^^^^^^
-//Usage of gensites to generate your own sites
-//configurations.
-//
-//
-//
-
 For Advanced Users
 ~~~~~~~~~~~~~~~~~~
 
 //Coasters for advanced users. Getting your hands dirty.
 
-One of the main reason that one would initially deviate from coaster
-defaults into more complex pool entries is to force jobs to fit into some
-site-imposed constraint. For instance a typical submission to the experimental
-queue requires a user to request upto 3 nodes for under 1 hour. This setup
-could be achieved with a careful tuning of coaters parameters.
+One of the main reason that one would initially deviate from coaster defaults
+into more complex pool entries is to force jobs to fit into some site-imposed
+constraint. For instance a typical submission to a fast PBS queue requires a
+user to request upto 3 nodes for under 1 hour. This setup could be achieved
+with a careful tuning of coaters parameters.
 
-//How to run Swift under different Coasters configurations
-//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Coasters configurations
+~~~~~~~~~~~~~~~~~~~~~~~
 //
 //Manual
 //^^^^^^^