@@ -34,13 +34,6 @@ Simple example of using ``cylc clean``:
34
34
$ cylc clean myflow/run1
35
35
INFO - Removing directory: ~/cylc-run/myflow/run1
36
36
37
- .. note ::
38
-
39
- Trying to clean a directory that contains more than one
40
- run directory is not allowed, as a safety feature. You can override
41
- this using the ``--force `` option, but this will not clean remote install
42
- targets or follow symlink dirs as described below.
43
-
44
37
45
38
Cleaning on remote install targets
46
39
----------------------------------
@@ -60,8 +53,9 @@ filesystem.
60
53
.. note ::
61
54
62
55
This relies on determining which platforms were used from the workflow
63
- database. If the database is missing, you will have to manually remove the
64
- files on remote install targets.
56
+ database. If the platforms recorded in the database are out of date with
57
+ the global configuration, or if the database is missing altogether, you will
58
+ have to manually remove the files on remote install targets.
65
59
66
60
You can also clean on just the local filesystem using the ``--local `` option,
67
61
or just the remote install target using the ``--remote `` option.
@@ -110,12 +104,13 @@ A note on symlink directories
110
104
:cylc:conf: `global.cylc[install][symlink dirs] `, you might want to read
111
105
this explanation of how Cylc handles them during cleaning.
112
106
113
- If you manually delete a run directory (e.g., using ``rm `` or the file
114
- manager), only the symlinks themselves will be deleted, not the actual targets.
115
- In contrast, ``cylc clean `` follows the symlinks and deletes the targets.
107
+ If you manually delete a run directory (e.g., using the ``rm `` command or the
108
+ file manager), only the symlinks themselves will be deleted, not the actual
109
+ targets. In contrast, ``cylc clean `` follows the symlinks and deletes the
110
+ targets.
116
111
117
- - It does this for the symlinks that can be set in
118
- :cylc:conf: `global.cylc[install][symlink dirs] ` only , not any custom
112
+ - It only does this for the symlinks that can be set in
113
+ :cylc:conf: `global.cylc[install][symlink dirs] `, not any custom
119
114
user-created symlinks.
120
115
- It does not actually look up the global configuration at time of cleaning;
121
116
it simply detects what symlinks are present out of the possible ones.
0 commit comments