[GHC] #12619: Allow users guide to be built independently from GHC
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: Component: Compiler | Version: 8.0.1 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- At HIW 2016 it was suggested that this would greatly reduce the friction to contributing users guide fixes. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * milestone: => 8.2.1 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): The only real sticky spot in this task is `utils/mkUserGuideParts`. It is a utility compiled by stage1 which takes a Haskell data structure containing bits of ReST and outputs ReST sources for the manpage and flags table. Ideally we would have a Sphinx extension to handle this but my previous attempts at this have been thwarted by various annoying technical limitations of Sphinx. The alternative would be to simply build `mkUserGuideParts` with the stage0 compiler (either by default or with a build system setting). -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Description changed by bgamari: @@ -3,0 +3,3 @@ + + Moreover, this would make our [http://ghc.readthedocs.org/|readthedocs] + mirror significantly easier to maintain. New description: At HIW 2016 it was suggested that this would greatly reduce the friction to contributing users guide fixes. Moreover, this would make our [http://ghc.readthedocs.org/|readthedocs] mirror significantly easier to maintain. -- -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by simonpj): Indeed! Why not ''always'' build `mkUserGuideParts` with stage0? It's just a utility, right? Absolutely no need to build it with stage1. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by thomie): The reason we don't build `mkUserGuideParts` with stage0 currently is that it depends on the `ghc` library. `Main.hs` import `DynFlags`, although currently only to get to `glasgowExtsFlags`. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- @@ -4,1 +4,1 @@ - Moreover, this would make our [http://ghc.readthedocs.org/|readthedocs] + Moreover, this would make our [[http://ghc.readthedocs.org/|readthedocs]] New description: At HIW 2016 it was suggested that this would greatly reduce the friction to contributing users guide fixes. Moreover, this would make our [[http://ghc.readthedocs.org/|readthedocs]] mirror significantly easier to maintain. -- Comment (by bgamari): This would perhaps be made easier by #11654. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#12619: Allow users guide to be built independently from GHC -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: task | Status: new Priority: normal | Milestone: 8.8.1 Component: Compiler | Version: 8.0.1 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * keywords: => newcomer * milestone: 8.6.1 => 8.8.1 Comment: For the record, I believe this should now be much easier as `mkUserGuideParts` has been removed. It would likely be best (and easiest!) to start with Hadrian, however. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12619#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC