From df97827a7b9e7feafd6c7435f947925c6062068a Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Sun, 19 Mar 2023 02:42:50 +0100 Subject: Fix case spelling for Lmod and Tcl (#36215) --- lib/spack/docs/basic_usage.rst | 2 +- lib/spack/docs/binary_caches.rst | 2 +- .../docs/build_systems/inteloneapipackage.rst | 2 +- lib/spack/docs/build_systems/intelpackage.rst | 4 ++-- lib/spack/docs/build_systems/pythonpackage.rst | 2 +- lib/spack/docs/configuration.rst | 2 +- lib/spack/docs/developer_guide.rst | 2 +- lib/spack/docs/getting_started.rst | 6 ++--- lib/spack/docs/module_file_support.rst | 28 +++++++++++----------- lib/spack/docs/packaging_guide.rst | 4 ++-- lib/spack/spack/modules/__init__.py | 2 +- lib/spack/spack/modules/tcl.py | 4 ++-- lib/spack/spack/test/environment_modifications.py | 2 +- lib/spack/spack/test/modules/common.py | 2 +- lib/spack/spack/test/modules/lmod.py | 2 +- lib/spack/spack/test/modules/tcl.py | 4 ++-- lib/spack/spack/util/module_cmd.py | 4 ++-- share/spack/templates/modules/modulefile.lua | 2 +- share/spack/templates/modules/modulefile.tcl | 2 +- .../packages/override-context-templates/package.py | 2 +- var/spack/repos/builtin/packages/ds/package.py | 2 +- .../repos/builtin/packages/heasoft/package.py | 2 +- var/spack/repos/builtin/packages/namd/package.py | 2 +- var/spack/repos/builtin/packages/plplot/package.py | 2 +- var/spack/repos/builtin/packages/srilm/package.py | 2 +- .../repos/builtin/packages/weechat/package.py | 2 +- 26 files changed, 46 insertions(+), 46 deletions(-) diff --git a/lib/spack/docs/basic_usage.rst b/lib/spack/docs/basic_usage.rst index adf0f273a1..cf1a9ec673 100644 --- a/lib/spack/docs/basic_usage.rst +++ b/lib/spack/docs/basic_usage.rst @@ -942,7 +942,7 @@ first ``libelf`` above, you would run: $ spack load /qmm4kso -To see which packages that you have loaded to your enviornment you would +To see which packages that you have loaded to your environment you would use ``spack find --loaded``. .. code-block:: console diff --git a/lib/spack/docs/binary_caches.rst b/lib/spack/docs/binary_caches.rst index af8d9d35e8..47f062595c 100644 --- a/lib/spack/docs/binary_caches.rst +++ b/lib/spack/docs/binary_caches.rst @@ -18,7 +18,7 @@ your Spack mirror and then downloaded and installed by others. Whenever a mirror provides prebuilt packages, Spack will take these packages into account during concretization and installation, making ``spack install`` -signficantly faster. +significantly faster. .. note:: diff --git a/lib/spack/docs/build_systems/inteloneapipackage.rst b/lib/spack/docs/build_systems/inteloneapipackage.rst index 6cc0b33192..410294c1b0 100644 --- a/lib/spack/docs/build_systems/inteloneapipackage.rst +++ b/lib/spack/docs/build_systems/inteloneapipackage.rst @@ -124,7 +124,7 @@ Using oneAPI Tools Installed by Spack ===================================== Spack can be a convenient way to install and configure compilers and -libaries, even if you do not intend to build a Spack package. If you +libraries, even if you do not intend to build a Spack package. If you want to build a Makefile project using Spack-installed oneAPI compilers, then use spack to configure your environment:: diff --git a/lib/spack/docs/build_systems/intelpackage.rst b/lib/spack/docs/build_systems/intelpackage.rst index f565f205ef..d64fd46971 100644 --- a/lib/spack/docs/build_systems/intelpackage.rst +++ b/lib/spack/docs/build_systems/intelpackage.rst @@ -397,7 +397,7 @@ for specifics and examples for ``packages.yaml`` files. .. If your system administrator did not provide modules for pre-installed Intel tools, you could do well to ask for them, because installing multiple copies - of the Intel tools, as is wont to happen once Spack is in the picture, is + of the Intel tools, as is won't to happen once Spack is in the picture, is bound to stretch disk space and patience thin. If you *are* the system administrator and are still new to modules, then perhaps it's best to follow the `next section `_ and install the tools @@ -653,7 +653,7 @@ follow `the next section `_ instead. * If you specified a custom variant (for example ``+vtune``) you may want to add this as your preferred variant in the packages configuration for the ``intel-parallel-studio`` package as described in :ref:`package-preferences`. Otherwise you will have to specify - the variant everytime ``intel-parallel-studio`` is being used as ``mkl``, ``fftw`` or ``mpi`` + the variant every time ``intel-parallel-studio`` is being used as ``mkl``, ``fftw`` or ``mpi`` implementation to avoid pulling in a different variant. * To set the Intel compilers for default use in Spack, instead of the usual ``%gcc``, diff --git a/lib/spack/docs/build_systems/pythonpackage.rst b/lib/spack/docs/build_systems/pythonpackage.rst index 807af44ed9..17295a457f 100644 --- a/lib/spack/docs/build_systems/pythonpackage.rst +++ b/lib/spack/docs/build_systems/pythonpackage.rst @@ -582,7 +582,7 @@ libraries. Make sure not to add modules/packages containing the word "test", as these likely won't end up in the installation directory, or may require test dependencies like pytest to be installed. -Instead of defining the ``import_modules`` explicity, only the subset +Instead of defining the ``import_modules`` explicitly, only the subset of module names to be skipped can be defined by using ``skip_modules``. If a defined module has submodules, they are skipped as well, e.g., in case the ``plotting`` modules should be excluded from the diff --git a/lib/spack/docs/configuration.rst b/lib/spack/docs/configuration.rst index c6355d8373..021ae84136 100644 --- a/lib/spack/docs/configuration.rst +++ b/lib/spack/docs/configuration.rst @@ -296,7 +296,7 @@ String Concatenation Above, the user ``config.yaml`` *completely* overrides specific settings in the default ``config.yaml``. Sometimes, it is useful to add a suffix/prefix to a path or name. To do this, you can use the ``-:`` notation for *append* -string concatentation at the end of a key in a configuration file. For example: +string concatenation at the end of a key in a configuration file. For example: .. code-block:: yaml :emphasize-lines: 1 diff --git a/lib/spack/docs/developer_guide.rst b/lib/spack/docs/developer_guide.rst index cc8365ebea..4dc8d1249d 100644 --- a/lib/spack/docs/developer_guide.rst +++ b/lib/spack/docs/developer_guide.rst @@ -472,7 +472,7 @@ use my new hook as follows: .. code-block:: python def post_log_write(message, level): - """Do something custom with the messsage and level every time we write + """Do something custom with the message and level every time we write to the log """ print('running post_log_write!') diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst index b2193fe1fd..3c847b876e 100644 --- a/lib/spack/docs/getting_started.rst +++ b/lib/spack/docs/getting_started.rst @@ -1597,8 +1597,8 @@ in a Windows CMD prompt. .. note:: If you chose to install Spack into a directory on Windows that is set up to require Administrative - Privleges, Spack will require elevated privleges to run. - Administrative Privleges can be denoted either by default such as + Privileges, Spack will require elevated privileges to run. + Administrative Privileges can be denoted either by default such as ``C:\Program Files``, or aministrator applied administrative restrictions on a directory that spack installs files to such as ``C:\Users`` @@ -1694,7 +1694,7 @@ Spack console via: spack install cpuinfo -If in the previous step, you did not have CMake or Ninja installed, running the command above should boostrap both packages +If in the previous step, you did not have CMake or Ninja installed, running the command above should bootstrap both packages """"""""""""""""""""""""""" Windows Compatible Packages diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst index 8c1fd50b8d..f92583246f 100644 --- a/lib/spack/docs/module_file_support.rst +++ b/lib/spack/docs/module_file_support.rst @@ -13,7 +13,7 @@ The use of module systems to manage user environment in a controlled way is a common practice at HPC centers that is often embraced also by individual programmers on their development machines. To support this common practice Spack integrates with `Environment Modules -`_ and `LMod +`_ and `Lmod `_ by providing post-install hooks that generate module files and commands to manipulate them. @@ -88,9 +88,9 @@ the different file formats that can be generated by Spack: +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ | | **Hook name** | **Default root directory** | **Default template file** | **Compatible tools** | +=============================+====================+===============================+==============================================+======================+ - | **TCL - Non-Hierarchical** | ``tcl`` | share/spack/modules | share/spack/templates/modules/modulefile.tcl | Env. Modules/LMod | + | **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 | + | **Lua - Hierarchical** | ``lmod`` | share/spack/lmod | share/spack/templates/modules/modulefile.lua | Lmod | +-----------------------------+--------------------+-------------------------------+----------------------------------------------+----------------------+ @@ -391,13 +391,13 @@ name and version for all packages that depend on mpi. When specifying module names by projection for Lmod modules, we recommend NOT including names of dependencies (e.g., MPI, compilers) -that are already in the LMod hierarchy. +that are already in the Lmod hierarchy. .. note:: - TCL modules - TCL modules also allow for explicit conflicts between modulefiles. + Tcl modules + Tcl modules also allow for explicit conflicts between modulefiles. .. code-block:: yaml @@ -421,9 +421,9 @@ that are already in the LMod hierarchy. .. note:: - LMod hierarchical module files + Lmod hierarchical module files When ``lmod`` is activated Spack will generate a set of hierarchical lua module - files that are understood by LMod. The hierarchy will always contain the + files that are understood by Lmod. The hierarchy will always contain the two layers ``Core`` / ``Compiler`` but can be further extended to any of the virtual dependencies present in Spack. A case that could be useful in practice is for instance: @@ -445,7 +445,7 @@ that are already in the LMod hierarchy. that will generate a hierarchy in which the ``lapack`` and ``mpi`` layer can be switched independently. This allows a site to build the same libraries or applications against different - implementations of ``mpi`` and ``lapack``, and let LMod switch safely from one to the + implementations of ``mpi`` and ``lapack``, and let Lmod switch safely from one to the other. All packages built with a compiler in ``core_compilers`` and all @@ -455,12 +455,12 @@ that are already in the LMod hierarchy. .. warning:: Consistency of Core packages The user is responsible for maintining consistency among core packages, as ``core_specs`` - bypasses the hierarchy that allows LMod to safely switch between coherent software stacks. + bypasses the hierarchy that allows Lmod to safely switch between coherent software stacks. .. warning:: Deep hierarchies and ``lmod spider`` For hierarchies that are deeper than three layers ``lmod spider`` may have some issues. - See `this discussion on the LMod project `_. + See `this discussion on the Lmod project `_. """""""""""""""""""""" Select default modules @@ -529,7 +529,7 @@ installed to ``/spack/prefix/foo``, if ``foo`` installs executables to update ``MANPATH``. The default list of environment variables in this config section -inludes ``PATH``, ``MANPATH``, ``ACLOCAL_PATH``, ``PKG_CONFIG_PATH`` +includes ``PATH``, ``MANPATH``, ``ACLOCAL_PATH``, ``PKG_CONFIG_PATH`` and ``CMAKE_PREFIX_PATH``, as well as ``DYLD_FALLBACK_LIBRARY_PATH`` on macOS. On Linux however, the corresponding ``LD_LIBRARY_PATH`` variable is *not* set, because it affects the behavior of @@ -629,7 +629,7 @@ by its dependency; when the dependency is autoloaded, the executable will be in PATH. Similarly for scripting languages such as Python, packages and their dependencies have to be loaded together. -Autoloading is enabled by default for LMod, as it has great builtin support for through +Autoloading is enabled by default for Lmod, as it has great builtin support for through the ``depends_on`` function. For Environment Modules it is disabled by default. Autoloading can also be enabled conditionally: @@ -650,7 +650,7 @@ The allowed values for the ``autoload`` statement are either ``none``, ``direct`` or ``all``. .. note:: - TCL prerequisites + Tcl prerequisites In the ``tcl`` section of the configuration file it is possible to use the ``prerequisites`` directive that accepts the same values as ``autoload``. It will produce module files that have a ``prereq`` diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst index 5da5ae0b9c..125384763f 100644 --- a/lib/spack/docs/packaging_guide.rst +++ b/lib/spack/docs/packaging_guide.rst @@ -2998,12 +2998,12 @@ follows: def libs(self): return find_libraries("libFoo", root=self.home, recursive=True) - # The header provided by the bar virutal package + # The header provided by the bar virtual package @property def bar_headers(self): return find_headers("bar/bar.h", root=self.home.include, recursive=False) - # The libary provided by the bar virtual package + # The library provided by the bar virtual package @property def bar_libs(self): return find_libraries("libFooBar", root=sef.home, recursive=True) diff --git a/lib/spack/spack/modules/__init__.py b/lib/spack/spack/modules/__init__.py index 04ce8f6074..4c56929a05 100644 --- a/lib/spack/spack/modules/__init__.py +++ b/lib/spack/spack/modules/__init__.py @@ -4,7 +4,7 @@ # SPDX-License-Identifier: (Apache-2.0 OR MIT) """This package contains code for creating environment modules, which can -include TCL non-hierarchical modules, LUA hierarchical modules, and others. +include Tcl non-hierarchical modules, Lua hierarchical modules, and others. """ from __future__ import absolute_import diff --git a/lib/spack/spack/modules/tcl.py b/lib/spack/spack/modules/tcl.py index d3d83f4172..765e7f7b2f 100644 --- a/lib/spack/spack/modules/tcl.py +++ b/lib/spack/spack/modules/tcl.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: (Apache-2.0 OR MIT) -"""This module implements the classes necessary to generate TCL +"""This module implements the classes necessary to generate Tcl non-hierarchical modules. """ import posixpath @@ -19,7 +19,7 @@ import spack.tengine as tengine from .common import BaseConfiguration, BaseContext, BaseFileLayout, BaseModuleFileWriter -#: TCL specific part of the configuration +#: Tcl specific part of the configuration def configuration(module_set_name): config_path = "modules:%s:tcl" % module_set_name config = spack.config.get(config_path, {}) diff --git a/lib/spack/spack/test/environment_modifications.py b/lib/spack/spack/test/environment_modifications.py index 9b743b6728..d4e1eded46 100644 --- a/lib/spack/spack/test/environment_modifications.py +++ b/lib/spack/spack/test/environment_modifications.py @@ -479,7 +479,7 @@ def test_from_environment_diff(before, after, search_list): assert item in mod -@pytest.mark.skipif(sys.platform == "win32", reason="LMod not supported on Windows") +@pytest.mark.skipif(sys.platform == "win32", reason="Lmod not supported on Windows") @pytest.mark.regression("15775") def test_exclude_lmod_variables(): # Construct the list of environment modifications diff --git a/lib/spack/spack/test/modules/common.py b/lib/spack/spack/test/modules/common.py index 691a50dd54..3f1ed9ec6e 100644 --- a/lib/spack/spack/test/modules/common.py +++ b/lib/spack/spack/test/modules/common.py @@ -55,7 +55,7 @@ def test_modules_written_with_proper_permissions( spec = spack.spec.Spec("mpileaks").concretized() # The code tested is common to all module types, but has to be tested from - # one. TCL picked at random + # one. Tcl picked at random generator = spack.modules.tcl.TclModulefileWriter(spec, "default") generator.write() diff --git a/lib/spack/spack/test/modules/lmod.py b/lib/spack/spack/test/modules/lmod.py index a43c4f8c7b..6e172acbf2 100644 --- a/lib/spack/spack/test/modules/lmod.py +++ b/lib/spack/spack/test/modules/lmod.py @@ -88,7 +88,7 @@ class TestLmod(object): assert provides["compiler"] == spack.spec.CompilerSpec("oneapi@3.0") def test_simple_case(self, modulefile_content, module_configuration): - """Tests the generation of a simple TCL module file.""" + """Tests the generation of a simple Tcl module file.""" module_configuration("autoload_direct") content = modulefile_content(mpich_spec_string) diff --git a/lib/spack/spack/test/modules/tcl.py b/lib/spack/spack/test/modules/tcl.py index 145e5e6156..1ce927be8e 100644 --- a/lib/spack/spack/test/modules/tcl.py +++ b/lib/spack/spack/test/modules/tcl.py @@ -24,7 +24,7 @@ pytestmark = pytest.mark.skipif(sys.platform == "win32", reason="does not run on @pytest.mark.usefixtures("config", "mock_packages", "mock_module_filename") class TestTcl(object): def test_simple_case(self, modulefile_content, module_configuration): - """Tests the generation of a simple TCL module file.""" + """Tests the generation of a simple Tcl module file.""" module_configuration("autoload_direct") content = modulefile_content(mpich_spec_string) @@ -318,7 +318,7 @@ class TestTcl(object): assert 'puts stderr "sentence from package"' in content - short_description = 'module-whatis "This package updates the context for TCL modulefiles."' + short_description = 'module-whatis "This package updates the context for Tcl modulefiles."' assert short_description in content @pytest.mark.regression("4400") diff --git a/lib/spack/spack/util/module_cmd.py b/lib/spack/spack/util/module_cmd.py index 41de8f847e..c05115768f 100644 --- a/lib/spack/spack/util/module_cmd.py +++ b/lib/spack/spack/util/module_cmd.py @@ -98,7 +98,7 @@ def get_path_args_from_module_line(line): words_and_symbols = line.split(lua_quote) path_arg = words_and_symbols[-2] else: - # The path arg is the 3rd "word" of the line in a TCL module + # The path arg is the 3rd "word" of the line in a Tcl module # OPERATION VAR_NAME PATH_ARG words = line.split() if len(words) > 2: @@ -111,7 +111,7 @@ def get_path_args_from_module_line(line): def path_from_modules(modules): - """Inspect a list of TCL modules for entries that indicate the absolute + """Inspect a list of Tcl modules for entries that indicate the absolute path at which the library supported by said module can be found. Args: diff --git a/share/spack/templates/modules/modulefile.lua b/share/spack/templates/modules/modulefile.lua index e4b589d7dc..146a8e882d 100644 --- a/share/spack/templates/modules/modulefile.lua +++ b/share/spack/templates/modules/modulefile.lua @@ -83,5 +83,5 @@ unsetenv("{{ cmd.name }}") {% endblock %} {% block footer %} -{# In case the module needs to be extended with custom LUA code #} +{# In case the module needs to be extended with custom Lua code #} {% endblock %} diff --git a/share/spack/templates/modules/modulefile.tcl b/share/spack/templates/modules/modulefile.tcl index 0c11f7c106..0970a1e594 100644 --- a/share/spack/templates/modules/modulefile.tcl +++ b/share/spack/templates/modules/modulefile.tcl @@ -78,5 +78,5 @@ unsetenv {{ cmd.name }} {% endblock %} {% block footer %} -{# In case the module needs to be extended with custom TCL code #} +{# In case the module needs to be extended with custom Tcl code #} {% endblock %} diff --git a/var/spack/repos/builtin.mock/packages/override-context-templates/package.py b/var/spack/repos/builtin.mock/packages/override-context-templates/package.py index 0e781baadb..004104b26e 100644 --- a/var/spack/repos/builtin.mock/packages/override-context-templates/package.py +++ b/var/spack/repos/builtin.mock/packages/override-context-templates/package.py @@ -7,7 +7,7 @@ from spack.package import * class OverrideContextTemplates(Package): - """This package updates the context for TCL modulefiles. + """This package updates the context for Tcl modulefiles. And additional lines that shouldn't be in the short description. """ diff --git a/var/spack/repos/builtin/packages/ds/package.py b/var/spack/repos/builtin/packages/ds/package.py index 5579a34987..294f029c0b 100644 --- a/var/spack/repos/builtin/packages/ds/package.py +++ b/var/spack/repos/builtin/packages/ds/package.py @@ -31,7 +31,7 @@ class Ds(AutotoolsPackage): depends_on("tk") def patch(self): - # the package provides it's own TCL utilities + # the package provides it's own Tcl utilities # compiling and manually setting paths for all of them is contrived # (most of the utilities are small and not included in spack) diff --git a/var/spack/repos/builtin/packages/heasoft/package.py b/var/spack/repos/builtin/packages/heasoft/package.py index 2e0d146ef5..96b975ad17 100644 --- a/var/spack/repos/builtin/packages/heasoft/package.py +++ b/var/spack/repos/builtin/packages/heasoft/package.py @@ -53,7 +53,7 @@ class Heasoft(AutotoolsPackage): # headers in different directories # # xspec: The HEASOFT project provides a tarball of replacement files for - # Xspec, along with a TCL patch utility. This is meant for updating a + # Xspec, along with a Tcl patch utility. This is meant for updating a # source tree in place with minimal rebuilding. This does not fit Spack's # model so convert those to patches. These are kept in sync with what is on # https://heasarc.gsfc.nasa.gov/docs/software/lheasoft/xanadu/xspec/issues/issues.html diff --git a/var/spack/repos/builtin/packages/namd/package.py b/var/spack/repos/builtin/packages/namd/package.py index 1d85881bb7..e0e8c8c640 100644 --- a/var/spack/repos/builtin/packages/namd/package.py +++ b/var/spack/repos/builtin/packages/namd/package.py @@ -42,7 +42,7 @@ class Namd(MakefilePackage, CudaPackage): "interface", default="none", values=("none", "tcl", "python"), - description="Enables TCL and/or python interface", + description="Enables Tcl and/or python interface", ) # init_tcl_pointers() declaration and implementation are inconsistent diff --git a/var/spack/repos/builtin/packages/plplot/package.py b/var/spack/repos/builtin/packages/plplot/package.py index d210cadc8c..835dd8a9db 100644 --- a/var/spack/repos/builtin/packages/plplot/package.py +++ b/var/spack/repos/builtin/packages/plplot/package.py @@ -22,7 +22,7 @@ class Plplot(CMakePackage): variant("lua", default=False, description="Enable Lua binding") variant("pango", default=False, description="Enable Pango") variant("qt", default=False, description="Enable QT binding") - variant("tcl", default=True, description="Enable TCL binding") + variant("tcl", default=True, description="Enable Tcl binding") variant("wx", default=False, description="Enable WxWidgets") variant("wxold", default=False, description="Use WxWidgets old interface") diff --git a/var/spack/repos/builtin/packages/srilm/package.py b/var/spack/repos/builtin/packages/srilm/package.py index 9c0e5ddc9e..41613fba6e 100644 --- a/var/spack/repos/builtin/packages/srilm/package.py +++ b/var/spack/repos/builtin/packages/srilm/package.py @@ -71,7 +71,7 @@ class Srilm(MakefilePackage): makefile_machine.filter(r"PIC_FLAG\s*=.*", "") with open(makefile_machine_fn, "a") as makefile_machine: - # TCL is only needed for tests so disable it + # Tcl is only needed for tests so disable it makefile_machine.write("\nNO_TCL = 1\n") if "+pic" in spec: makefile_machine.write("MAKE_PIC = 1\n") diff --git a/var/spack/repos/builtin/packages/weechat/package.py b/var/spack/repos/builtin/packages/weechat/package.py index eaff72f76a..ff34b175d6 100644 --- a/var/spack/repos/builtin/packages/weechat/package.py +++ b/var/spack/repos/builtin/packages/weechat/package.py @@ -19,7 +19,7 @@ class Weechat(CMakePackage): variant("perl", default=False, description="Include perl support") variant("lua", default=False, description="Include lua support") variant("ruby", default=False, description="Include ruby support") - variant("tcl", default=False, description="Include TCL support") + variant("tcl", default=False, description="Include Tcl support") variant("guile", default=False, description="Include guile support") variant("php", default=False, description="Include php support") -- cgit v1.2.3-60-g2f50