File tree Expand file tree Collapse file tree 1 file changed +28
-2
lines changed Expand file tree Collapse file tree 1 file changed +28
-2
lines changed Original file line number Diff line number Diff line change 370
370
''' ,
371
371
'restart timeout' : '''
372
372
How long to wait for intervention on restarting a completed workflow.
373
- The timer stops if any task is triggered.
373
+
374
+ When a workflow reaches the end of the :term:`graph`, it will
375
+ :term:`shut down <shutdown>` automatically. We call such workflows
376
+ :ref:`completed <workflow completion>` as there are no more tasks for
377
+ Cylc to run.
378
+
379
+ Completed workflows can be caused by:
380
+
381
+ * Cylc reaching the end of the :term:`graph`.
382
+ * The workflow reaching the
383
+ :cylc:conf:`flow.cylc[scheduling]final cycle point`.
384
+ * The workflow reaching the
385
+ :cylc:conf:`flow.cylc[scheduling]stop after cycle point`.
386
+ * Tasks being manually removed :ref:`interventions.remove_tasks`.
387
+
388
+ When you restart a completed workflow, it will detect that there are no
389
+ more tasks to run, and shut itself down again. The ``restart timeout``
390
+ delays this shutdown for a configured period allowing you to trigger
391
+ more task(s) to run.
374
392
375
393
.. seealso::
376
394
377
- :ref:`user_guide.scheduler.workflow_events`
395
+ * :ref:`user_guide.scheduler.workflow_events`
396
+ * :ref:`workflow completion`
397
+ * :ref:`examples.extending-workflow`
378
398
379
399
.. versionadded:: 8.2.0
380
400
401
+ .. versionchanged:: 8.5.2
402
+
403
+ The ``restart timeout`` is now also activated for workflows that
404
+ have hit the
405
+ :cylc:conf:`flow.cylc[scheduling]stop after cycle point`.
406
+
381
407
'''
382
408
}
383
409
You can’t perform that action at this time.
0 commit comments