[GHC] #14144: Standardize binary distribution doc files

GHC ghc-devs at haskell.org
Tue Aug 22 02:13:07 UTC 2017


#14144: Standardize binary distribution doc files
-------------------------------------+-------------------------------------
           Reporter:  patrickdoc     |             Owner:  (none)
               Type:  feature        |            Status:  new
  request                            |
           Priority:  normal         |         Milestone:
          Component:  Build System   |           Version:  8.2.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:
-------------------------------------+-------------------------------------
 I'm making a pass at the documentation in general, and next up on my list
 is
 simplifying the building process a bit. I hope to create something like
 `docs/dist-install` that would collect and hold all of the generated
 documentation. This would help in writing the docs, as you could verify
 links,
 say, from the user's guide to the library documentation. This would also
 allow
 installation and distribution to mainly be a `cp`.

 While looking into this, I ran into some discrepancies between releases.
 The contents of !https://downloads.haskell.org/~ghc/VERSION/docs for
 [https://downloads.haskell.org/~ghc/7.10-latest/docs 7.10],
 [https://downloads.haskell.org/~ghc/8.0-latest/docs 8.0], and
 [https://downloads.haskell.org/~ghc/latest/docs 8.2] are all different.
 8.0
 dropped `*.ps` files and `haddock.pdf`. 8.2 now additionally holds a
 `windows`
 folder that has a wide array of binaries and documentation.

 Going back further, the `Cabal` user's guide used to be included. I
 searched
 around for a reason that it was dropped and only found a git commit citing
 the change from `docbook`. But now most sources use `Sphinx`, so we could
 generate and include them if we so wished.

 The `Cabal` guide can be found at:
 * https://www.haskell.org/cabal/users-guide/ (Version 1.24.2)
 * https://cabal.readthedocs.io/en/latest/ (Versions 2.0 and HEAD)

 The `Haddock` guide can be found at:
 * https://www.haskell.org/haddock/doc/html (Version 2.15.0)
 * https://haskell-haddock.readthedocs.io/en/latest/ (Versions 2.18.0 and
 HEAD)
 * https://downloads.haskell.org/~ghc/latest/docs/haddock.html.tar.xz (GHC
 release version)

 Unfortunately, the www.haskell.org links are the most prominent when
 Googled.

 To bring this back to a point, I would like to clean up the `docs` folder
 of
 the distribution. The `windows` folder inside seems like it might be a
 mistake.
 Additionally, `Cabal` and `Haddock` have ended up in strange positions,
 and I think they
 probably could both use the same solution.

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


More information about the ghc-tickets mailing list