zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docstring of spack.directives.extend (#6485)

Browse Source 
The original docstring had confusing wording re: what is going to
symlinked and where when using the `extend` directive, and how exactly
the symlinking is performed (not automatically on install, but using
`spack activate`). See #5559.
This commit is contained in:
David Lukes
2017-11-29 23:30:42 +01:00
committed by becker33
parent aa24858648
commit 27b929bfe2
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/spack/spack/directives.py
View File

@@ -362,13 +362,14 @@ def _execute_depends_on(pkg):
@directive(('extendees', 'dependencies')) @directive(('extendees', 'dependencies'))
def extends(spec, **kwargs): def extends(spec, **kwargs):
"""Same as depends_on, but dependency is symlinked into parent prefix. """Same as depends_on, but allows symlinking into dependency's
prefix tree.
This is for Python and other language modules where the module This is for Python and other language modules where the module
needs to be installed into the prefix of the Python installation. needs to be installed into the prefix of the Python installation.
Spack handles this by installing modules into their own prefix, Spack handles this by installing modules into their own prefix,
but allowing ONE module version to be symlinked into a parent but allowing ONE module version to be symlinked into a parent
Python install at a time. Python install at a time, using ``spack activate``.
keyword arguments can be passed to extends() so that extension keyword arguments can be passed to extends() so that extension
packages can pass parameters to the extendee's extension packages can pass parameters to the extendee's extension