Skip to content

Commit 64d70bb

Browse files
committed
Tweak runahead docs.
1 parent fd1d131 commit 64d70bb

File tree

6 files changed

+21
-13
lines changed

6 files changed

+21
-13
lines changed

src/7-to-8/major-changes/scheduling.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ Cylc can manage infinite workflows of repeating tasks:
2323

2424
Cylc 8 has a new scheduling algorithm that:
2525

26-
- Is much more efficient because it only has to manage :term:`active tasks`.
26+
- Is much more efficient because it only has to manage
27+
:term:`active tasks <active task>`.
2728

2829
- Tasks are not loaded into memory before they are needed.
2930
- Tasks are not retained in memory once they complete.

src/glossary.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,8 @@ Glossary
982982
This refers to starting a new instance of the Cylc :term:`scheduler`
983983
program to manage a particular :term:`workflow`. This can be from
984984
scratch, for installed workflows that haven't run previously, or to
985-
restart one that shut down prior to :ref:`completion <workflow completion>`.
985+
restart one that shut down prior to
986+
:ref:`completion <workflow completion>`.
986987

987988
.. seealso::
988989

@@ -1691,7 +1692,7 @@ Glossary
16911692

16921693

16931694
flow front
1694-
:term:`Active tasks <active task>`` with a common :term:`flow number`
1695+
:term:`Active tasks <active task>` with a common :term:`flow number`
16951696
comprise the active front of the flow.
16961697

16971698

src/user-guide/running-workflows/reflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Triggering with No Active Flows
122122
task in it. The task's flow number will be the same as if you
123123
had triggered it just before the workflow completed.
124124

125-
Special Case: Triggering ``n=0`` (:term:`active tasks <active task`)
125+
Special Case: Triggering ``n=0`` (:term:`active tasks <active task>`)
126126
Active tasks already have flow membership assigned.
127127
Flow numbers are inherited, on entering the active wndow, from parent
128128
(upstream) tasks in the graph.

src/user-guide/running-workflows/tasks-jobs-ui.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ it displays all tasks a configurable :term:`n-window` around the current
117117

118118

119119
n=0:
120-
The ``n=0`` window contains current :term:`active tasks`: those that are
121-
near ready to run, running, or which require user intervention.
120+
The ``n=0`` window contains current :term:`active tasks <active task>`: those
121+
that are near ready to run, running, or which require user intervention.
122122
n=1:
123123
The ``n=1`` window contains the ``n=0`` tasks plus those out
124124
to *one* graph edge around them in the graph.

src/user-guide/running-workflows/workflow-completion.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Workflow Completion
55

66
A workflow can :term:`shut down <shutdown>` once all
77
:term:`active tasks <active task>` complete without spawning further
8-
downstream activity - i.e., when :term:`n=0 window` empties out.
8+
downstream activity - i.e., when :term:`n=0 window <n-window>` empties out.
99

1010
.. _scheduler stall:
1111

src/user-guide/writing-workflows/scheduling.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1534,7 +1534,7 @@ So, in the cycle ``2000-01-01T00:00Z``:
15341534
* ``foo`` would expire at ``2000-01-01T00:00Z``.
15351535
* ``bar`` would expire at ``2000-01-01T01:00Z``.
15361536

1537-
Only waiting tasks can expire, :term:`active tasks <active>` will not be
1537+
Only waiting tasks can expire, :term:`active tasks <active task>` will not be
15381538
killed if they pass their configured ``clock-expire`` time.
15391539

15401540
When a task expires, it produces the ``expired`` :term:`output`.
@@ -2219,17 +2219,23 @@ executing, e.g:
22192219
Runahead Limiting
22202220
-----------------
22212221

2222-
Runahead limiting prevents workflow activity from getting too far ahead of the
2223-
earliest :term:`active cycle`, by holding back tasks in cycles beyond a
2224-
configurable limit.
2222+
Runahead limiting restricts workflow activity to a configurable number of
2223+
cycles beyond the earliest :term:`active cycle`.
22252224

2226-
Tasks in cycles beyond the runahead limit are called "runahead limited" and are
2227-
displayed in the GUI/Tui with small circle above them:
2225+
.. TODO - update this after https://github.com/cylc/cylc-flow/issues/5580:
2226+
2227+
Tasks in the :term:`n=0 window <n-window>` at the runahead limit are actively
2228+
held back, and are displayed in the GUI/Tui with a small circle above them.
22282229

22292230
.. image:: ../../img/task-job-icons/task-isRunahead.png
22302231
:width: 60px
22312232
:height: 60px
22322233

2234+
.. note::
2235+
2236+
Tasks in the :term:`n=1 window <n-window>` are not displayed as runahead
2237+
limited; they form the future graph and are not yet being actively limited.
2238+
22332239
As the workflow advances and active cycles complete, the runahead limit moves
22342240
forward allowing tasks in later cycles to run.
22352241

0 commit comments

Comments
 (0)