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

Merge remote-tracking branch 'origin/features/SPACK-46' into develop

Conflicts:
	lib/spack/docs/packaging_guide.rst
parents daef78f5 2755171e
No related branches found
No related tags found
No related merge requests found
...@@ -35,7 +35,9 @@ ...@@ -35,7 +35,9 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys, os import sys
import os
import subprocess
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
...@@ -43,9 +45,13 @@ ...@@ -43,9 +45,13 @@
sys.path.insert(0, os.path.abspath('exts')) sys.path.insert(0, os.path.abspath('exts'))
# Add the Spack bin directory to the path so that we can use its output in docs. # Add the Spack bin directory to the path so that we can use its output in docs.
os.environ['SPACK_ROOT'] = '../../..' spack_root = '../../..'
os.environ['SPACK_ROOT'] = spack_root
os.environ['PATH'] += os.pathsep + '$SPACK_ROOT/bin' os.environ['PATH'] += os.pathsep + '$SPACK_ROOT/bin'
spack_version = subprocess.Popen(
['spack', '-V'], stderr=subprocess.PIPE).communicate()[1].strip().split('.')
# Set an environment variable so that colify will print output like it would to # Set an environment variable so that colify will print output like it would to
# a terminal. # a terminal.
os.environ['COLIFY_SIZE'] = '25x80' os.environ['COLIFY_SIZE'] = '25x80'
...@@ -95,9 +101,9 @@ ...@@ -95,9 +101,9 @@
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '1.0' version = '.'.join(spack_version[:2])
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0' release = '.'.join(spack_version[:2])
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
......
...@@ -2036,35 +2036,33 @@ this step if they have been. If Spack discovers that patches didn't ...@@ -2036,35 +2036,33 @@ this step if they have been. If Spack discovers that patches didn't
apply cleanly on some previous run, then it will restage the entire 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
......
...@@ -78,7 +78,7 @@ ...@@ -78,7 +78,7 @@
# Version information # Version information
from spack.version import Version from spack.version import Version
spack_version = Version("0.8") spack_version = Version("0.8.15")
# #
# Executables used by Spack # Executables used by Spack
......
...@@ -23,6 +23,7 @@ ...@@ -23,6 +23,7 @@
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
############################################################################## ##############################################################################
import re import re
import cgi
from StringIO import StringIO from StringIO import StringIO
import llnl.util.tty as tty import llnl.util.tty as tty
from llnl.util.tty.colify import * from llnl.util.tty.colify import *
...@@ -72,9 +73,9 @@ def print_rst_package_list(): ...@@ -72,9 +73,9 @@ def print_rst_package_list():
print print
print pkg.name print pkg.name
print "-" * len(pkg.name) print "-" * len(pkg.name)
print "Links" print "Links:"
print " * `Homepage <%s>`__" % pkg.homepage print " * `%s <%s>`__" % (cgi.escape(pkg.homepage), pkg.homepage)
print " * `%s/package.py <%s>`__" % (pkg.name, github_url(pkg)) print " * `%s/package.py <%s>`__" % (pkg.name, github_url(pkg))
print print
if pkg.versions: if pkg.versions:
print "Versions:" print "Versions:"
...@@ -84,7 +85,7 @@ def print_rst_package_list(): ...@@ -84,7 +85,7 @@ def print_rst_package_list():
print " " + ", ".join("`%s`_" % d if d != "mpi" else d print " " + ", ".join("`%s`_" % d if d != "mpi" else d
for d in pkg.dependencies) for d in pkg.dependencies)
print print
print "Description" print "Description:"
print pkg.format_doc(indent=2) print pkg.format_doc(indent=2)
print print
print "-----" print "-----"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment