diff --git a/src/user-guide/cheat-sheet.rst b/src/user-guide/cheat-sheet.rst index 5f9a0fbffe..51c90bf96c 100644 --- a/src/user-guide/cheat-sheet.rst +++ b/src/user-guide/cheat-sheet.rst @@ -132,7 +132,7 @@ First, make your required changes to the files in the workflow's cylc vr If you want to quickly edit a task's configuration, e.g. while developing a -workflow or testing changes, the +workflow or testing changes, the :ref:`"Edit Runtime" feature ` in the GUI can be convenient. @@ -221,7 +221,7 @@ Run or re-run a task (:ref:`more info `):: Mark a task as "succeeded" (:ref:`more info `):: - cylc set /// + cylc set /// --out=succeeded Kill a running job:: diff --git a/src/user-guide/interventions/index.rst b/src/user-guide/interventions/index.rst index 3de007fe5d..202a586473 100644 --- a/src/user-guide/interventions/index.rst +++ b/src/user-guide/interventions/index.rst @@ -165,8 +165,10 @@ Set Task Outputs .. image:: set-task-outputs.gui.gif :width: 75% - By default this sets the "succeeded" output, press the pencil icon next - to the trigger command to specify a different output. + By default, this sets all :term:`required outputs ` for + the task, which usually includes ``succeeded``. + To specify the output(s) you would like to set, + press the pencil icon next to the "Set" command . .. tab-item:: Tui :sync: tui @@ -174,8 +176,10 @@ Set Task Outputs .. image:: set-task-outputs.tui.gif :width: 75% - By default, this sets the "succeeded" output. Use ``cylc set --output`` - to specify a different output. + By default, this sets all :term:`required outputs ` for + the task, which usually includes ``succeeded``. + To specify the output(s) you would like to set, + use ``cylc set --output``. .. tab-item:: CLI :sync: cli @@ -184,8 +188,10 @@ Set Task Outputs $ cylc set // - By default, this sets the "succeeded" output. Use the ``--output`` option - to specify a different output. + By default, this sets all :term:`required outputs ` for + the task, which usually includes ``succeeded``. + To specify the output(s) you would like to set, + use the ``--output`` option. You can also :ref:`set task prerequisites `. Should I set task outputs or prerequisites? @@ -203,7 +209,7 @@ Set Task Prerequisites [scheduler] allow implicit tasks = True - + [scheduling] [[graph]] R1 = """ @@ -214,7 +220,7 @@ Set Task Prerequisites # set prereqs "1/b2:succeeded" and "1/c:succeeded" on 1/z1 # set prereqs "all" on 1/z2 """ - + [runtime] [[b1]] script = sleep 600 @@ -274,10 +280,10 @@ Set a Switch Task switch:normal? => normal switch:alternate? => alternate normal | alternate => end - + end[-P1] => start """ - + [runtime] [[start]] script = """ @@ -298,15 +304,15 @@ Set a Switch Task take a particular path ahead of time: .. code-block:: cylc-graph - + start => switch - + # by default, the workflow follows the "normal" path switch:normal? => normal - + # but it can follow an alternate route if desired switch:alternate? => alternate - + normal | alternate => end :Solution: @@ -314,7 +320,7 @@ Set a Switch Task ``-wait`` option. Cylc will follow the desired path when it gets there. .. note:: - + We set the "succeeded" output to prevent the task from being re-run when the flow approaches it. diff --git a/src/user-guide/running-workflows/retrying-tasks.rst b/src/user-guide/running-workflows/retrying-tasks.rst index 363f5b1cfe..530c65d970 100644 --- a/src/user-guide/running-workflows/retrying-tasks.rst +++ b/src/user-guide/running-workflows/retrying-tasks.rst @@ -26,7 +26,7 @@ state, with a new clock trigger to handle the configured retry delay. Aborting a Retry Sequence ------------------------- -To prevent a waiting task from retrying, remove it from the scheduler's +To prevent a task from retrying, remove it from the scheduler's :term:`active window`. For a task ``3/foo`` in workflow ``brew``: .. code-block:: console @@ -45,6 +45,7 @@ sequence, or remove it. If you want trigger downstream tasks despite ``3/foo`` being removed before it -could succeed, use ``cylc set`` to artificially mark its ``succeeded`` -output as complete (and with the ``--flow`` option, to make the :term:`flow` -continue on from there). +could succeed, use ``cylc set`` to artificially mark its +:term:`required outputs ` +as complete (and with the ``--flow`` option, if needed to make a specific +:term:`flow` continue on from there).