Skip to content

Commit

Permalink
Update cylc clean docs slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
MetRonnie committed Oct 6, 2021
1 parent a52bdb0 commit 29c1825
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions src/user-guide/removing-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ Simple example of using ``cylc clean``:
.. code-block:: console
$ cylc clean myflow/run1
INFO - Cleaning on local filesystem: ~/cylc-run/myflow/run1
INFO - Removing directory: ~/cylc-run/myflow/run1
.. note::

Trying to clean a directory that contains more than one
run directory is not allowed, as a safety feature. You can override
this using the ``--force`` option, but this will not clean remote install
targets or follow symlink dirs as described above.
targets or follow symlink dirs as described below.


Cleaning on remote install targets
Expand All @@ -53,7 +53,9 @@ filesystem.
$ cylc clean remote-example
INFO - Cleaning on install target: enterprise1701
INFO - Cleaning on local filesystem: ~/cylc-run/remote-example/run1
INFO - [enterprise1701]
INFO - Removing directory: /home/user/cylc-run/remote-example/run1
INFO - Removing directory: ~/cylc-run/remote-example/run1
.. note::

Expand Down Expand Up @@ -96,12 +98,6 @@ beginning with ``2020``:

Make sure to place glob patterns in quotes.

.. tip::

Use the ``--debug`` option to see all the directories or files that get
removed.


.. _CleanSymlinkDirsNote:

A note on symlink directories
Expand Down

0 comments on commit 29c1825

Please sign in to comment.