From c4c1d37fcdeb17680a85af25431314dae4fa3584 Mon Sep 17 00:00:00 2001 From: Todd Gamblin Date: Fri, 23 Mar 2018 23:16:37 -0700 Subject: refactor: move templates from root to share/spack - This complies with the unix directory hierarchy standard (which Spack attempts to follow) - Also unclutters the repo root directory. --- lib/spack/docs/module_file_support.rst | 18 +++++++++--------- lib/spack/docs/tutorial_modules.rst | 11 ++++++----- lib/spack/spack/test/data/config.yaml | 2 +- 3 files changed, 16 insertions(+), 15 deletions(-) (limited to 'lib') diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst index 6b874fbe97..d7ef18f290 100644 --- a/lib/spack/docs/module_file_support.rst +++ b/lib/spack/docs/module_file_support.rst @@ -290,15 +290,15 @@ installation of a package. The table below summarizes the essential information associated with the different file formats that can be generated by Spack: - +-----------------------------+--------------------+-------------------------------+----------------------------------+----------------------+ - | | **Hook name** | **Default root directory** | **Default template file** | **Compatible tools** | - +=============================+====================+===============================+==================================+======================+ - | **Dotkit** | ``dotkit`` | share/spack/dotkit | templates/modules/modulefile.dk | DotKit | - +-----------------------------+--------------------+-------------------------------+----------------------------------+----------------------+ - | **TCL - Non-Hierarchical** | ``tcl`` | share/spack/modules | templates/modules/modulefile.tcl | Env. Modules/LMod | - +-----------------------------+--------------------+-------------------------------+----------------------------------+----------------------+ - | **Lua - Hierarchical** | ``lmod`` | share/spack/lmod | templates/modules/modulefile.lua | LMod | - +-----------------------------+--------------------+-------------------------------+----------------------------------+----------------------+ + +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ + | | **Hook name** | **Default root directory** | **Default template file** | **Compatible tools** | + +=============================+====================+===============================+==============================================+======================+ + | **Dotkit** | ``dotkit`` | share/spack/dotkit | share/spack/templates/modules/modulefile.dk | DotKit | + +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ + | **TCL - Non-Hierarchical** | ``tcl`` | share/spack/modules | share/spack/templates/modules/modulefile.tcl | Env. Modules/LMod | + +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ + | **Lua - Hierarchical** | ``lmod`` | share/spack/lmod | share/spack/templates/modules/modulefile.lua | LMod | + +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ Spack ships with sensible defaults for the generation of module files, but diff --git a/lib/spack/docs/tutorial_modules.rst b/lib/spack/docs/tutorial_modules.rst index 21e1e5e886..7ed60c934f 100644 --- a/lib/spack/docs/tutorial_modules.rst +++ b/lib/spack/docs/tutorial_modules.rst @@ -1385,11 +1385,12 @@ Module file templates ^^^^^^^^^^^^^^^^^^^^^ The templates that Spack uses to generate module files are stored in the -``templates/module`` directory, and they all share the same common structure. -Usually, they start with a header that identifies the type of -module being generated. In the case of hierarchical module files it's: +``share/spack/templates/module`` directory within the Spack prefix, and +they all share the same common structure. Usually, they start with a +header that identifies the type of module being generated. In the case of +hierarchical module files it's: -.. literalinclude:: ../../../templates/modules/modulefile.lua +.. literalinclude:: ../../../share/spack/templates/modules/modulefile.lua :language: jinja :lines: 1-6 @@ -1403,7 +1404,7 @@ that can be overridden or extended by users, if need be. , delimited by ``{% ... %}``, are also permitted in the template language: -.. literalinclude:: ../../../templates/modules/modulefile.lua +.. literalinclude:: ../../../share/spack/templates/modules/modulefile.lua :language: jinja :lines: 73-88 diff --git a/lib/spack/spack/test/data/config.yaml b/lib/spack/spack/test/data/config.yaml index ab925f4f6b..2fcd10ad97 100644 --- a/lib/spack/spack/test/data/config.yaml +++ b/lib/spack/spack/test/data/config.yaml @@ -1,7 +1,7 @@ config: install_tree: $spack/opt/spack template_dirs: - - $spack/templates + - $spack/share/spack/templates - $spack/lib/spack/spack/test/data/templates - $spack/lib/spack/spack/test/data/templates_again build_stage: -- cgit v1.2.3-60-g2f50