[Swift-commit] r7423 - trunk/docs/designs

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2013-12-13 10:44:04 -0600 (Fri, 13 Dec 2013)
New Revision: 7423

Modified:
   trunk/docs/designs/swiftrun.txt
Log:
Make sure examples use new naming conventions


Modified: trunk/docs/designs/swiftrun.txt
===================================================================
--- trunk/docs/designs/swiftrun.txt	2013-12-13 16:17:27 UTC (rev 7422)
+++ trunk/docs/designs/swiftrun.txt	2013-12-13 16:44:04 UTC (rev 7423)
@@ -84,19 +84,24 @@
 Here is an example of a new swift.properties file.
 
 -----
+# Define sandyb site
+site.sandyb.tasksPerWorker=16
+site.sandyb.taskWalltime=00:05:00
+site.sandyb.jobManager=slurm
+site.sandyb.jobQueue=sandyb
+site.sandyb.maxJobs=1
+site.sandyb.workdirectory=/scratch/midway/$USER/work
+site.sandyb.filesystem=local
+
+# Define sandyb apps
+app.sandyb.echo=/bin/echo
+
+# Define swift properties
+sitedir.keep=true
 wrapperlog.always.transfer=true
-sitedir.keep=true
-file.gc.enabled=false
-status.mode=provider
-site=westmere
-site.westmere.provider=local:slurm
-site.westmere.jobsPerNode=12
-site.westmere.maxWalltime=00:05:00
-site.westmere.queue=westmere
-site.westmere.initialScore=10000
-site.westmere.filesystem=local
-site.westmere.workdirectory=/scratch/midway/davidkelly999
-app.westmere.cat=/bin/cat
+
+# Select which site to run on
+site=sandyb
 -----
 
 This single swift.properties file works identically to using the sites.xml,
@@ -220,7 +225,7 @@
 
 For example:
 -----
-site.westmere.queue=fast
+site.westmere.jobQueue=fast
 -----
 
 Before the site properties are listed, it's important to understand the
@@ -234,14 +239,18 @@
 A *job* is related to schedulers. It is the mechanism by which workers
 are launched.
 
-Below is the list of valid site properties, with links to the Swift User Guide
-which explanations of what they do, and an example swift.properties entry.
+Below is the list of valid site properties with brief explanations of what 
+they do, and an example swift.properties entry.
 
 .swift.properties site properties
 [options="header"]
 |================================
 |Property|Description|Example
 
+|filesystem|
+Defines how files should be accessed
+|site.westmere.filesystem=local
+
 |jobGranularity|
 Specifies the granularity of a job, in nodes
 |site.westmere.jobGranularity=2