-
Notifications
You must be signed in to change notification settings - Fork 95
Fix terminology used to describe "auto-restart" functionality. #6677
Description
(Mainly documentation changes, for cylc-flow and cylc-doc)
After a host is condemned a host, we need to drain it by:
- (a) telling workflows to migrate, or
- (b) telling workflows to stop
For historical reasons (a) is called "normal mode" and (b) is called "force mode", and has occasionally been referred to as "force condemned" which is just wrong use of the word condemned (this host is already condemned, no forcing required).
For clarity, these should be called something more descriptive: "migrate mode" and "stop mode", and we also need to document exactly what these modes do (e.g. what might cause migration not to happen) and how they should typically be used (e.g., try migrate mode first, then use stop mode to clean up the stragglers).
This was under discussion in a PR that got superseded by a smaller-scoped bug fix.
See also cylc-doc cylc/cylc-doc#809
Refs: