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

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2014-04-23 15:49:27 -0500 (Wed, 23 Apr 2014)
New Revision: 7787

Modified:
   trunk/docs/userguide/configuration
Log:
Formatting


Modified: trunk/docs/userguide/configuration
===================================================================
--- trunk/docs/userguide/configuration	2014-04-23 20:36:28 UTC (rev 7786)
+++ trunk/docs/userguide/configuration	2014-04-23 20:49:27 UTC (rev 7787)
@@ -172,52 +172,52 @@
 |================================
 |Property|Description|Example
 
-|condor|
-Pass parameters directly through to the submit script generated for the condor
+|condor
+|Pass parameters directly through to the submit script generated for the condor
 scheduler. For example, the setting "site.osgconnect.condor.+projectname=Swift"
 will generate the line "+projectname = Swift".
 |site.osgconnect.condor.+projectname=Swift
 
-|filesystem|
-Defines how files should be accessed
+|filesystem
+|Defines how files should be accessed
 |site.westmere.filesystem=local
 
-|jobGranularity|
-Specifies the granularity of a job, in nodes
+|jobGranularity
+|Specifies the granularity of a job, in nodes
 |site.westmere.jobGranularity=2
 
-|jobManager|
-Specifies how jobs will be launched. The supported job managers are 
+|jobManager
+|Specifies how jobs will be launched. The supported job managers are 
 "cobalt", "slurm", "condor", "pbs", "lsf", "local", and "sge". 
 |site.westmere.jobManager=slurm
 
-|jobProject|
-Set the project name for the job scheduler
+|jobProject
+|Set the project name for the job scheduler
 |site.westmere.project=myproject
 
-|jobQueue|
-Set the name of the scheduler queue to use.
+|jobQueue
+|Set the name of the scheduler queue to use.
 |site.westmere.jobQueue=westmere
 
-|jobWalltime|
-The maximum number amount of time allocated in a scheduler job, in hh:mm:ss
+|jobWalltime
+|The maximum number amount of time allocated in a scheduler job, in hh:mm:ss
 format.
 |site.westmere.jobWalltime=01:00:00
 
-|maxJobs|
-Maximum number of scheduler jobs to submit
+|maxJobs
+|Maximum number of scheduler jobs to submit
 |site.westmere.maxJobs=20
 
-|maxNodesPerJob|
-The maximum number of nodes to request per scheduler job.
+|maxNodesPerJob
+|The maximum number of nodes to request per scheduler job.
 |site.westmere.maxNodesPerJob=2
 
 |pe
 |The parallel environment to use for SGE schedulers
 |site.sunhpc.pe=mpi
 
-|providerAttributes|
-Allows user to pass attributes through directly to scheduler submit script. Currently
+|providerAttributes
+|Allows user to pass attributes through directly to scheduler submit script. Currently
 only implemented for sites that use PBS.
 |site.beagle.providerAttributes=pbs.aprun;pbs.mpp;depth=24
 
@@ -227,36 +227,36 @@
 the line "#SBATCH --mail-user=username".
 |site.midway.slurm.mail-user=username
 
-|taskDir|
-Tasks will be run from this directory. In the absence of a taskDir definition, 
+|taskDir
+|Tasks will be run from this directory. In the absence of a taskDir definition, 
 Swift will run the task from workdir.
 |site.westmere.taskDir=/scratch/local/$USER/work
 
-|tasksPerWorker|
-The number of tasks that each worker can run simultaneously.
+|tasksPerWorker
+|The number of tasks that each worker can run simultaneously.
 |site.westmere.tasksPernode=12
 
-|taskThrottle|
-The maximum number of active tasks across all workers.
+|taskThrottle
+|The maximum number of active tasks across all workers.
 |site.westmere.taskThrottle=100
 
-|taskWalltime|
-The maximum amount of time a task may run, in hh:mm:ss.
+|taskWalltime
+|The maximum amount of time a task may run, in hh:mm:ss.
 |site.westmere.taskWalltime=01:00:00
 
-|site    |
-Name of site or sites to run on. This is the same as running with
+|site
+|Name of site or sites to run on. This is the same as running with
 swift -site <sitename>
 |site=westmere
 
-|userHomeOverride|
-Sets the Swift user home. This must be a shared filesystem. This defaults
+|userHomeOverride
+|Sets the Swift user home. This must be a shared filesystem. This defaults
 to $HOME. For clusters where $HOME is not accessible to the worker nodes,
 you may override the value to point to a shared directory that you own.
 |site.beagle.userHomeOverride=/lustre/beagle/username
 
-|workdir |
-The workdirectory element specifies where on the site files can be stored.
+|workdir
+|The workdirectory element specifies where on the site files can be stored.
 This directory must be available on all worker nodes that will be used for 
 execution. A shared cluster filesystem is appropriate for this. Note that 
 you need to specify absolute pathname for this field.
@@ -497,12 +497,16 @@
 |Progress:
 |String to prepend to ticker output
 
-
 |use.wrapper.staging
 |true, false
 |false
 |Determines if the Swift wrapper should do file staging.
 
+|use.provider.staging
+|true, false
+|false
+|If true, files will be staged by Swift over the network.
+
 |wrapper.invocation.mode
 |absolute, relative
 |absolute