summaryrefslogtreecommitdiff
path: root/lib/spack/docs
diff options
context:
space:
mode:
authorAndrew W Elble <aweits@rit.edu>2020-02-03 22:02:45 -0500
committerGitHub <noreply@github.com>2020-02-03 19:02:45 -0800
commit4accc78409da79dc5ed260505e942621dae691db (patch)
treedbc84e93225e5f858a92fe37943cb0b53c5e813f /lib/spack/docs
parent7d444f08e7fd3a03118f8a1eddfbcbc81142c914 (diff)
downloadspack-4accc78409da79dc5ed260505e942621dae691db.tar.gz
spack-4accc78409da79dc5ed260505e942621dae691db.tar.bz2
spack-4accc78409da79dc5ed260505e942621dae691db.tar.xz
spack-4accc78409da79dc5ed260505e942621dae691db.zip
Git fetching: add option to remove submodules (#14370)
Add an optional 'submodules_delete' field to Git versions in Spack packages that allows them to remove specific submodules. For example: the nervanagpu submodule has become unavailable for the PyTorch project (see issue 19457 at https://github.com/pytorch/pytorch/issues/). Removing this submodule allows 0.4.1 to build.
Diffstat (limited to 'lib/spack/docs')
-rw-r--r--lib/spack/docs/packaging_guide.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst
index e566cb4545..6e1271b12c 100644
--- a/lib/spack/docs/packaging_guide.rst
+++ b/lib/spack/docs/packaging_guide.rst
@@ -929,6 +929,9 @@ Git fetching supports the following parameters to ``version``:
* ``tag``: Name of a tag to fetch.
* ``commit``: SHA hash (or prefix) of a commit to fetch.
* ``submodules``: Also fetch submodules recursively when checking out this repository.
+* ``submodules_delete``: A list of submodules to forcibly delete from the repository
+ after fetching. Useful if a version in the repository has submodules that
+ have disappeared/are no longer accessible.
* ``get_full_repo``: Ensure the full git history is checked out with all remote
branch information. Normally (``get_full_repo=False``, the default), the git
option ``--depth 1`` will be used if the version of git and the specified