13219: Adds documentation
authorLucas Di Pentima <ldipentima@veritasgenetics.com>
Thu, 5 Jul 2018 17:32:46 +0000 (14:32 -0300)
committerLucas Di Pentima <ldipentima@veritasgenetics.com>
Thu, 5 Jul 2018 17:32:46 +0000 (14:32 -0300)
Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <ldipentima@veritasgenetics.com>

doc/user/cwl/cwl-extensions.html.textile.liquid

index cf25639b14defda47456d6610458285a06aaecce..26feb9938a5344e4d7b7f9a2363ee9bd8c0f9fff 100644 (file)
@@ -38,6 +38,8 @@ hints:
     enableReuse: false
   cwltool:Secrets:
     secrets: [input1, input2]
+  cwltool:TimeLimit:
+    timelimit: 14400
 </pre>
 
 The one exception to this is @arv:APIRequirement@, see note below.
@@ -111,3 +113,11 @@ Indicate that one or more input parameters are "secret".  Must be applied at the
 table(table table-bordered table-condensed).
 |_. Field |_. Type |_. Description |
 |secrets|array<string>|Input parameters which are considered "secret".  Must be strings.|
+
+h2. cwltool:TimeLimit
+
+Set an upper limit on the execution time of a CommandLineTool or ExpressionTool.  A tool execution which exceeds the time limit may be preemptively terminated and considered failed.  May also be used by batch systems to make scheduling decisions.
+
+table(table table-bordered table-condensed).
+|_. Field |_. Type |_. Description |
+|timelimit|int|Execution time limit in seconds. If set to zero, no limit is enforced.|