[GHC] #12586: Add types warning to Foreign.C.Types

[GHC]

#12586: Add types warning to Foreign.C.Types
-------------------------------------+-------------------------------------
        Reporter:  Phyx-             |                Owner:  Phyx-
            Type:  bug               |               Status:  patch
        Priority:  normal            |            Milestone:
       Component:  libraries/base    |              Version:  8.0.1
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D2523
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by Tamar Christina <tamar@…>):

 In [changeset:"710f21cc3a6f10dac1b31d089458e5fd16f6d3db/ghc" 710f21c/ghc]:
 {{{
 #!CommitTicketReference repository="ghc"
 revision="710f21cc3a6f10dac1b31d089458e5fd16f6d3db"
 Add platform warning to Foreign.C.Types

 Summary:
 The generated documentation for thhe Foreign.C.Types
 module is generated based on the platform which ran Haddock.

 This is generating incorrect types for e.g. Windows.

 Add a disclaimer to the top of the page to ask people to
 keep this in mind.

 Test Plan: make documentation and inspect Haddock

 Reviewers: erikd, austin, hvr, bgamari

 Reviewed By: erikd

 Subscribers: RyanGlScott, #ghc_windows_task_force, thomie

 Differential Revision: https://phabricator.haskell.org/D2523

 GHC Trac Issues: #12586
 }}}

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