Skip to content
Snippets Groups Projects
Commit 2755171e authored by Todd Gamblin's avatar Todd Gamblin
Browse files

Update documentation to reflect new restage/clean behavior.

parent e67655c3
No related branches found
No related tags found
No related merge requests found
...@@ -1964,35 +1964,33 @@ apply cleanly on some previous run, then it will restage the entire ...@@ -1964,35 +1964,33 @@ apply cleanly on some previous run, then it will restage the entire
package before patching. package before patching.
``spack clean`` ``spack restage``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Restores the source code to pristine state, as it was before building.
There are several variations of ``spack clean``. With no arguments, Does this in one of two ways:
``spack clean`` runs ``make clean`` in the expanded archive directory.
This is useful if an attempted build failed, and something needs to be 1. If the source was fetched as a tarball, deletes the entire build
changed to get a package to build. If a particular package does not directory and re-expands the tarball.
have a ``make clean`` target, this will do nothing.
2. If the source was checked out from a repository, this deletes the
build directory and checks it out again.
``spack clean -w / --work``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Deletes the entire build directory and re-expands it from the downloaded
archive. This is useful if a package does not support a proper ``make clean``
target.
``spack clean -d / --dist`` ``spack clean``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Deletes the build directory *and* the downloaded archive. If Cleans up temporary files for a particular package, by deleting the
``fetch``, ``stage``, or ``install`` are run again after this, the expanded/checked out source code *and* any downloaded archive. If
process will start from scratch, and the archive archive will be ``fetch``, ``stage``, or ``install`` are run again after this, Spack's
downloaded again. Useful if somehow a bad archive is downloaded build process will start from scratch.
accidentally and needs to be cleaned out of the staging area.
``spack purge`` ``spack purge``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Cleans up all of Spack's temporary files. Use this to recover disk
Cleans up *everything* in the build directory. You can use this to space if temporary files from interrupted or failed installs
recover disk space if temporary files from interrupted or failed accumulate in the staging area. This is equivalent to running ``spack
installs accumulate in the staging area. clean`` for every package you have fetched or staged.
Keeping the stage directory on success Keeping the stage directory on success
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment