shellcheck: add comments about installing binary (#34877)

ShellCheck is installed with a downloaded binary instead of being
compiled from source, and there should be comments to point out this
unorthodox approach.
This commit is contained in:
Alex Hedges 2023-01-11 04:17:25 -05:00 committed by GitHub
parent 9d70f6e6c7
commit 74595de359
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,13 +18,23 @@
class Shellcheck(Package):
"""ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts."""
"""ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts.
Note: Spack does not have a Haskell toolchain, so a ShellCheck binary is downloaded instead of
being compiled from source.
"""
homepage = "https://www.shellcheck.net"
url = "https://github.com/koalaman/shellcheck/releases/download/v0.9.0/shellcheck-v0.9.0.linux.x86_64.tar.xz"
maintainers = ["aphedges"]
# The following installs the binaries for shellcheck. The reason for
# installing binaries is that shellcheck is a Haskell package and the
# Haskell framework is not yet in Spack. See #1408 for a discussion of the
# challenges with Haskell, and see the pandoc package for a precedent of
# downloading a Haskell-derived binary.
for ver, packages in _versions.items():
system = platform.system().lower()
machine = platform.machine().lower()