Skip to content

Please document supported OS/ghc versions clearly #1121

@mcclure

Description

@mcclure

Hello. Last night I spent some time unsuccessfully attempting to install Purescript. My machine is running fairly out of date software: Mac OS X 10.6.8 on 64-bit Intel, and I have a copy of GHC 7.6.3 (w/ Cabal 1.16.0.2) installed since I don't even remember when. Running the OS X binaries from your github "release page" failed (running any one simply resulted in the message "illegal instruction") and cloning git and building master (by running cabal install in directory) failed with a cryptic message ( https://pbs.twimg.com/media/CFlh4K_VEAA8coU.png:large ).

I understand you cannot necessarily support old operating system versions or old GHC versions; my point is not to ask that be changed, and I am not asking for help installing (a friend with a newer GHC helped and I now have purescript running). However, I think your messaging about which software versions are supported can and should be improved. Doing so would have saved me a bunch of time. It seems labeling "supported" operating system version for binaries is especially important on Linux and OS X (where Apple routinely introduces backward-incompatible changes to the dev tools, although I do not know how sensitive Haskell programs are to this).

Here are some places a brief message about supported versions could have been, but aren't:

  • The "release" page on Github says nothing https://github.com/purescript/purescript/releases/tag/v0.6.9.5 (this is just a commit message, but since it is linked from "latest release page on GitHub" on your website it would be reasonable to expect it to contain this information)
  • The README in macos.tar.gz says nothing
  • Nor the README in linux64.tar.gz
  • The README.md in git does not mention it either in master (which effectively is your "front page" for anyone who happens to stumble onto your github project instead of going to purescript.org first) or the v0.6.9.5 source release, incidentally it is not in the release notes either
  • The build could have detected early that it was in an unsupported GHC version, but didn't (note: I did build master, maybe a build from v0.6.9.5 or directly from cabal is better-behaved)
  • http://www.purescript.org/download/ does not mention this information-- looking now, oops, I do see that the "Cabal" install section says it wants "Haskell Platform 2014 or GHC 7.8"!, although this is maybe a vague statement (does it refer to building the source or installing via cabal?).

Expected behavior: Brief statements saying which OS versions are supported by the binaries, and which OS/GHC versions are supported when building from source, should be accessible. I think your release page (or if that's hard, the READMEs in the binary packages) would be a sensible place for this information, and README.md would be a sensible place for source compatibility information. Somewhere on http://www.purescript.org/download/ (maybe more prominently than a subsection) would also make sense. If you do not know exactly which versions are supported, a brief statement about "these binaries were tested on/this source was built on…" would still be useful.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions