diff options
| author | Todd Gamblin <tgamblin@llnl.gov> | 2016-07-11 12:17:30 -0700 |
|---|---|---|
| committer | Todd Gamblin <tgamblin@llnl.gov> | 2016-07-11 13:27:37 -0700 |
| commit | 283d621b6e6016b57d12fba11db5f3be9b473204 (patch) | |
| tree | 9af563783c7c88d9ff597a4cb02238b137fe7cd5 | |
| parent | 86b1b289065a0dd37a20ebc35ff5bd2b7dfa5662 (diff) | |
| download | spack-283d621b6e6016b57d12fba11db5f3be9b473204.tar.gz spack-283d621b6e6016b57d12fba11db5f3be9b473204.tar.bz2 spack-283d621b6e6016b57d12fba11db5f3be9b473204.tar.xz spack-283d621b6e6016b57d12fba11db5f3be9b473204.zip | |
Add documentation for fetching submodules.
| -rw-r--r-- | lib/spack/docs/packaging_guide.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst index e616581ca4..0f549e2957 100644 --- a/lib/spack/docs/packaging_guide.rst +++ b/lib/spack/docs/packaging_guide.rst @@ -604,6 +604,7 @@ Git fetching is enabled with the following parameters to ``version``: * ``tag``: name of a tag to fetch. * ``branch``: name of a branch to fetch. * ``commit``: SHA hash (or prefix) of a commit to fetch. + * ``submodules``: Also fetch submodules when checking out this repository. Only one of ``tag``, ``branch``, or ``commit`` can be used at a time. @@ -660,6 +661,17 @@ Commits could just use the abbreviated commit hash. It's up to the package author to decide what makes the most sense. +Submodules + + You can supply ``submodules=True`` to cause Spack to fetch submodules + along with the repository at fetch time. + + .. code-block:: python + + version('1.0.1', git='https://github.com/example-project/example.git', + tag='v1.0.1', submdoules=True) + + Installing ^^^^^^^^^^^^^^ |