[GHC] #9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: Documentation | Version: 7.8.3 Keywords: | Operating System: MacOS X Architecture: Unknown/Multiple | Type of failure: Difficulty: Easy (less than 1 | Documentation bug hour) | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: -------------------------------------+------------------------------------- The Building/Preparation/MacOSX page suggests using Darin Morrison's brewtap to install ghc using Homebrew: 3. Use one of Fink, MacPorts or Brew. If using brew, we strongly recommend using Darin's brewtap for ghc Darin's brewtap, however, is deprecated: https://github.com/darinmorrison/homebrew-haskell For the most part, it seems that the default homebrew install works correctly, but `./configure` fails because Happy is not installed. We should either (1) remove the recommendation to use Homebrew or (2) explain how to install all of the necessary components to build GHC. (I couldn't figure out how to install Happy using Homebrew's cabal-install formula, so I used the GHC Platform instead.) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by ihmccreery): I've changed the wiki as best I can, with the knowledge I have, but my changes should probably be reviewed by someone who knows more than me: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/MacOSX?action=diff&version=10 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Changes (by ihmccreery): * priority: normal => low -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Changes (by carter): * status: new => closed * resolution: => fixed Comment: your changes looked good, I added some additional cleanup. Though theres a chance i've over looked something. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by ihmccreery): Glad to have all that updated. I'm brand new to working on GHC, so I'll trust your changes re gcc & llvm. Returning to this, I'm realizing that the main issue here is that nowhere on this page does it explain that you need Happy, (and maybe other tools included in the Haskell Platform?), not just a binary of GHC, to build GHC. Should we include that as a caveat to the binary, .app, and Homebrew instructions? And should we make the Haskell Platform item 1 and "recommended," since it installs Happy, etc. by default? I'm thinking something like:
Secondly, you need an installation of GHC, Happy, and other tools for use as your bootstrap compiler environment.
The easiest and recommended way to install all of the necessary components is to install the [https://www.haskell.org/platform/ Haskell Platform]. (If your OS X version predates 10.8, this build (currently of GHC 7.8.3) is known to support as far back as OS X 10.6.)
However, if you would prefer, you can also install a binary distribution of GHC in three other ways, (be warned: if you're using one of these methods, you'll also need to install cabal and properly configure it, and then install other necessary packages): 1. Install a binary distribution from GHC. 2. Get the relocatable .app bundle using ghcformacosx 3. Use one of Fink, MacPorts or Homebrew.
Thoughts? I'm not sure what all goes into installing GHC that doesn't come with the Haskell Platform, and I'm not familiar enough with `cabal` to give clear recommendations, so what is written above should probably be elaborated on. Thanks. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Changes (by ihmccreery): * status: closed => new * resolution: fixed => -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by ihmccreery): I made the changes recommended above, but they should probably be reviewed again. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by carter): I'm not keen on recommending haskell platform as the primary. `cabal install alex happy` should suffice. I will adjust your changes. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by carter): for subsequent changes, lets talk it out a teeny bit before doing any further edits? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:8 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: new Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by ihmccreery): Awesome, thanks, good to know about Haskell Platform. Yup, you got it. I was trying to be helpful and unload as much work as possible, but I know I'm new to this and don't really know what I'm doing. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Changes (by ihmccreery): * status: new => closed * resolution: => fixed -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:10 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by carter): no, this is great, and i certainly make more headway when i have someone to talk to. So happy to guide. That said, sometimes I say things that are opinion rather than fact :) Maybe we should have the rule that "the wiki docs on building GHC are ONLY for current GHC head"? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:11 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by ihmccreery): That makes sense to me. I have to admit that it's not really clear who should & shouldn't edit which Wiki pages. It seems a little odd that there would be such a strict rule for that section, with no rules for any other section: [https://ghc.haskell.org/trac/ghc/wiki]
Please help us improve the information on the GHC developer's wiki. You can easily do this by editing the wiki directly. Just register an account, and then edit away. Alternatively, log in as user guest with password guest (but we'd prefer you to create an account, because it enables us to contact you if necessary). The Help/Guide link at the top of every page gives a good description of the markup language and how to use Trac in general.
Please help us improve the information on the GHC developer's wiki. If you're not sure what edit to make, go ahead and submit a documentation bug ticket. Otherwise, you can easily edit the wiki directly. Just register an account, and then edit away. Alternatively, log in as user guest with
Maybe there is a better way? Maybe just a general rule: password guest (but we'd prefer you to create an account, because it enables us to contact you if necessary). The Help/Guide link at the top of every page gives a good description of the markup language and how to use Trac in general. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:12 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#9779: Darin Morrison's brewtap for ghc is deprecated, and should not be recommended -------------------------------------+------------------------------------- Reporter: ihmccreery | Owner: Type: bug | Status: closed Priority: low | Milestone: Component: | Version: 7.8.3 Documentation | Keywords: Resolution: fixed | Architecture: Unknown/Multiple Operating System: MacOS X | Difficulty: Easy (less than 1 Type of failure: | hour) Documentation bug | Blocked By: Test Case: | Related Tickets: Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- Comment (by carter): strict rule for which? by rule I meant: that the OS X section section should show only most current GHC HEAD and RELEASE build directions, and those wanting older versions should just look at the pages history. If only to make sure that the people who are reading it (likely first time GHC contributors almost exclusively) have clear simple directions. So more like an information policy to make it less confusing for folks to get started? not sure. That change in language is a good one, though maybe it should say something about "open a ticket or email ghc-devs if you're unsure and would like feedback before making the change". That said, theres definitely value in keeping the conversation history on Trac in a tracked (hah) way. If you know what youre doing, the WIKI, unlike ghc's git repo, doesnt have a code review process! Or at least, theres not so many people making general audience wiki edits, so that sort of review process isn't needed? IDK, i wonder how larger projects navigate this stuff. Either way, this is valuable stuff to do/ask about! Thank you! (and keep at it!) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/9779#comment:13 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC