[GHC] #14144: Standardize binary distribution doc files

GHC ghc-devs at haskell.org
Tue Aug 22 14:24:04 UTC 2017


#14144: Standardize binary distribution doc files
-------------------------------------+-------------------------------------
        Reporter:  patrickdoc        |                Owner:  (none)
            Type:  feature request   |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Build System      |              Version:  8.2.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):

 Yes, the documentation preparation infrastructure is a disaster. Here are
 a few notes that may be of interest,

  * I use https://github.com/bgamari/ghc-utils/blob/master/rel-
 eng/upload.sh#L139 to prepare the documentation that is uploaded to
 `downloads.haskell.org`.
  * This script uses the `distrib/mkDocs/mkDocs` script in the GHC tree;
 this script requires both a Windows and Linux bindist tarball, from which
 it extracts Haddock and user guide documentation
  * The `windows` folder in the 8.2 downloads folder appears to be a stale
 artifact from a failed run of the above script; I have deleted it.
  * Ultimately we want to have binary distributions and documentation
 snapshots generated by our continuous integration infrastructure. Building
 something like `docs/dist-install` would make this much easier.

-- 
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14144#comment:1>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list