From 74595de359696395609d42d5a4bc4026290f1d07 Mon Sep 17 00:00:00 2001 From: Alex Hedges Date: Wed, 11 Jan 2023 04:17:25 -0500 Subject: 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. --- var/spack/repos/builtin/packages/shellcheck/package.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/var/spack/repos/builtin/packages/shellcheck/package.py b/var/spack/repos/builtin/packages/shellcheck/package.py index 993a782c2a..bb130c8178 100644 --- a/var/spack/repos/builtin/packages/shellcheck/package.py +++ b/var/spack/repos/builtin/packages/shellcheck/package.py @@ -18,13 +18,23 @@ _versions = { 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() -- cgit v1.2.3-60-g2f50