summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAdam J. Stewart <ajstewart426@gmail.com>2017-04-14 10:13:14 -0500
committerTodd Gamblin <tgamblin@llnl.gov>2017-04-14 08:13:14 -0700
commitbec6d99b15750a8dcf01bbae7ea79d66e17b91ac (patch)
treeea8bb5bab56030bbc345eb661ea93da121ba1219 /lib
parent0405505e21115bb0d4c3cbf24f834418c2fb7c46 (diff)
downloadspack-bec6d99b15750a8dcf01bbae7ea79d66e17b91ac.tar.gz
spack-bec6d99b15750a8dcf01bbae7ea79d66e17b91ac.tar.bz2
spack-bec6d99b15750a8dcf01bbae7ea79d66e17b91ac.tar.xz
spack-bec6d99b15750a8dcf01bbae7ea79d66e17b91ac.zip
Add documentation on explicit param for do_install (#3823)
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/spack/package.py28
1 files changed, 15 insertions, 13 deletions
diff --git a/lib/spack/spack/package.py b/lib/spack/spack/package.py
index 177b4c908b..d2494939d7 100644
--- a/lib/spack/spack/package.py
+++ b/lib/spack/spack/package.py
@@ -1145,22 +1145,24 @@ class PackageBase(with_metaclass(PackageMeta, object)):
Package implementations should override install() to describe
their build process.
- :param keep_prefix: Keep install prefix on failure. By default, \
+ :param bool keep_prefix: Keep install prefix on failure. By default,
destroys it.
- :param keep_stage: By default, stage is destroyed only if there are \
- no exceptions during build. Set to True to keep the stage
+ :param bool keep_stage: By default, stage is destroyed only if there
+ are no exceptions during build. Set to True to keep the stage
even with exceptions.
- :param install_deps: Install dependencies before installing this \
+ :param bool install_deps: Install dependencies before installing this
package
- :param fake: Don't really build; install fake stub files instead.
- :param skip_patch: Skip patch stage of build if True.
- :param verbose: Display verbose build output (by default, suppresses \
- it)
- :param dirty: Don't clean the build environment before installing.
- :param make_jobs: Number of make jobs to use for install. Default is \
- ncpus
- :param force: Install again, even if already installed.
- :param run_tests: Run tests within the package's install()
+ :param bool skip_patch: Skip patch stage of build if True.
+ :param bool verbose: Display verbose build output (by default,
+ suppresses it)
+ :param int make_jobs: Number of make jobs to use for install. Default
+ is ncpus
+ :param bool run_tests: Run tests within the package's install()
+ :param bool fake: Don't really build; install fake stub files instead.
+ :param bool explicit: True if package was explicitly installed, False
+ if package was implicitly installed (as a dependency).
+ :param bool dirty: Don't clean the build environment before installing.
+ :param bool force: Install again, even if already installed.
"""
if not self.spec.concrete:
raise ValueError("Can only install concrete packages: %s."