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

resources : added docs fixes #1551 (#1627)

Browse Source
This commit is contained in:
Massimiliano Culpo 2016-08-30 07:40:50 +02:00 committed by Todd Gamblin
parent 8ab47537c7
commit 3ecf4ef8c9
2 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/spack/docs/packaging_guide.rst
View File

@ -759,6 +759,26 @@ Fetching a revision
Subversion branches are handled as part of the directory structure, so Subversion branches are handled as part of the directory structure, so
you can check out a branch or tag by changing the ``url``. you can check out a branch or tag by changing the ``url``.
Expanding additional resources in the source tree
-------------------------------------------------
Some packages (most notably compilers) provide optional features if additional
resources are expanded within their source tree before building. In Spack it is
possible to describe such a need with the ``resource`` directive :
.. code-block:: python
resource(
name='cargo',
git='https://github.com/rust-lang/cargo.git',
tag='0.10.0',
destination='cargo'
)
Based on the keywords present among the arguments the appropriate ``FetchStrategy``
will be used for the resource. The keyword ``destination`` is relative to the source
root of the package and should point to where the resource is to be expanded.
Automatic caching of files fetched during installation Automatic caching of files fetched during installation
------------------------------------------------------ ------------------------------------------------------

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

@ -292,17 +292,17 @@ def resource(pkg, **kwargs):
Define an external resource to be fetched and staged when building the Define an external resource to be fetched and staged when building the
package. Based on the keywords present in the dictionary the appropriate package. Based on the keywords present in the dictionary the appropriate
FetchStrategy will be used for the resource. Resources are fetched and FetchStrategy will be used for the resource. Resources are fetched and
staged in their own folder inside spack stage area, and then linked into staged in their own folder inside spack stage area, and then moved into
the stage area of the package that needs them. the stage area of the package that needs them.
List of recognized keywords: List of recognized keywords:
* 'when' : (optional) represents the condition upon which the resource is * 'when' : (optional) represents the condition upon which the resource is
needed needed
* 'destination' : (optional) path where to link the resource. This path * 'destination' : (optional) path where to move the resource. This path
must be relative to the main package stage area. must be relative to the main package stage area.
* 'placement' : (optional) gives the possibility to fine tune how the * 'placement' : (optional) gives the possibility to fine tune how the
resource is linked into the main package stage area. resource is moved into the main package stage area.
""" """
when = kwargs.get('when', pkg.name) when = kwargs.get('when', pkg.name)
destination = kwargs.get('destination', "") destination = kwargs.get('destination', "")