Skip to content

Commit a8ad295

Browse files
committed
update doc
1 parent fa0ab92 commit a8ad295

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/recipes.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A recipe is comprised of the following yaml files in a directory:
77
* `compilers.yaml`: the compilers provided by the stack.
88
* `environments.yaml`: environments that contain all the software packages.
99
* `modules.yaml`: _optional_ module generation rules
10-
* follows the spec for [spack module configuration](https://spack.readthedocs.io/en/latest/module_file_support.html)
10+
* follows the spec for [spack module configuration](https://spack.readthedocs.io/en/latest/module_file_support.html#the-modules-yaml-config-file-and-module-sets) with small exceptions (see [Modules](#modules) for more details).
1111
* `packages.yaml`: _optional_ define external packages
1212
* follows the spec for [spack package configuration](https://spack.readthedocs.io/en/latest/build_settings.html)
1313
* `repo`: _optional_ custom spack package definitions.
@@ -445,7 +445,14 @@ The presence of a `modules.yaml` file in the recipe is a necessary and sufficien
445445
!!! warning
446446
`config:modules` field has been deprecated. It can still be specified, but it has to be consistent with the presence of `modules.yaml` file.
447447

448-
Modules are generated for the installed compilers and packages by spack. Rules for module generation in `modules.yaml` file should be provided as per the [spack documentation](https://spack.readthedocs.io/en/latest/module_file_support.html).
448+
Modules are generated for the installed compilers and packages by spack.
449+
450+
!!! info "Rules for module generation in `modules.yaml`"
451+
Stackinator relies on Spack's module generation capabilities, that's the reason why the `modules.yaml` file has to follow [Spack's specification](https://spack.readthedocs.io/en/latest/module_file_support.html#the-modules-yaml-config-file-and-module-sets).
452+
But, **there are some differences**:
453+
454+
- `modules:default:arch_folder` defaults to `false`. If set to `true` an error is raised, as Stackinator does not support this feature;
455+
- `modules:default:roots:tcl` must not be specified, as Stackinator automatically configures the module root to be inside the uenv mount point.
449456

450457
## Custom Spack Packages
451458

0 commit comments

Comments
 (0)