summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMassimiliano Culpo <massimiliano.culpo@googlemail.com>2016-10-16 00:51:49 +0200
committerTodd Gamblin <tgamblin@llnl.gov>2016-10-15 15:51:49 -0700
commit8d5961ecaf562e6fcd5ad015852988927df24130 (patch)
treef502e670ab00357353f3a13a9d7d45567c3f0218
parent9726574846500becfa64528a88b3ec37e658c0cb (diff)
downloadspack-8d5961ecaf562e6fcd5ad015852988927df24130.tar.gz
spack-8d5961ecaf562e6fcd5ad015852988927df24130.tar.bz2
spack-8d5961ecaf562e6fcd5ad015852988927df24130.tar.xz
spack-8d5961ecaf562e6fcd5ad015852988927df24130.zip
spack purge : updated documentation fixes #1938 (#2025)
-rw-r--r--lib/spack/docs/packaging_guide.rst13
1 files changed, 9 insertions, 4 deletions
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst
index 155bbcdb08..efd4c459a2 100644
--- a/lib/spack/docs/packaging_guide.rst
+++ b/lib/spack/docs/packaging_guide.rst
@@ -3004,13 +3004,18 @@ Cleans up all of Spack's temporary and cached files. This can be used to
recover disk space if temporary files from interrupted or failed installs
accumulate in the staging area.
-When called with ``--stage`` or ``--all`` (or without arguments, in which case
-the default is ``--all``) this removes all staged files; this is equivalent to
-running ``spack clean`` for every package you have fetched or staged.
+When called with ``--stage`` or without arguments this removes all staged
+files and will be equivalent to running ``spack clean`` for every package
+you have fetched or staged.
-When called with ``--cache`` or ``--all`` this will clear all resources
+When called with ``--downloads`` this will clear all resources
:ref:`cached <caching>` during installs.
+When called with ``--user-cache`` this will remove caches in the user home
+directory, including cached virtual indices.
+
+To remove all of the above, the command can be called with ``--all``.
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Keeping the stage directory on success
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^