From 27b929bfe2bdd0659a978ab3c289b54d0ade48e1 Mon Sep 17 00:00:00 2001 From: David Lukes Date: Wed, 29 Nov 2017 23:30:42 +0100 Subject: Improve docstring of spack.directives.extend (#6485) 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. --- lib/spack/spack/directives.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/spack/spack/directives.py b/lib/spack/spack/directives.py index 84404af095..df19e85d54 100644 --- a/lib/spack/spack/directives.py +++ b/lib/spack/spack/directives.py @@ -362,13 +362,14 @@ def depends_on(spec, when=None, type=default_deptype, patches=None): @directive(('extendees', 'dependencies')) 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 needs to be installed into the prefix of the Python installation. Spack handles this by installing modules into their own prefix, 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 packages can pass parameters to the extendee's extension -- cgit v1.2.3-70-g09d2