hlrs-software-stack/spack
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add documentation on explicit param for do_install (#3823)

Browse source
This commit is contained in:
Adam J. Stewart 2017-04-14 10:13:14 -05:00 committed by Todd Gamblin
parent 0405505e21
commit bec6d99b15
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
lib/spack/spack/package.py
View file

@ -1145,22 +1145,24 @@ def do_install(self,
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."