[commit: ghc] ghc-8.0: Add platform warning to Foreign.C.Types (14fb8ef)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : ghc-8.0
Link       : http://ghc.haskell.org/trac/ghc/changeset/14fb8ef376606a4dd873374a863863357d16ed95/ghc

>---------------------------------------------------------------

commit 14fb8ef376606a4dd873374a863863357d16ed95
Author: Tamar Christina <tamar at zhox.com>
Date:   Sat Sep 10 13:04:19 2016 +0100

    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
    
    (cherry picked from commit 710f21cc3a6f10dac1b31d089458e5fd16f6d3db)


>---------------------------------------------------------------

14fb8ef376606a4dd873374a863863357d16ed95
 libraries/base/Foreign/C/Types.hs    | 6 ++++++
 libraries/base/System/Posix/Types.hs | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/libraries/base/Foreign/C/Types.hs b/libraries/base/Foreign/C/Types.hs
index fef8e4a..7670f61 100644
--- a/libraries/base/Foreign/C/Types.hs
+++ b/libraries/base/Foreign/C/Types.hs
@@ -23,6 +23,12 @@ module Foreign.C.Types
         ( -- * Representations of C types
           -- $ctypes
 
+          -- ** Platform differences
+          -- | This module contains platform specific information about types.
+          --   __/As such the types presented on this page reflect the platform
+          --   on which the documentation was generated and may not coincide with
+          --   the types on your platform./__
+
           -- ** Integral types
           -- | These types are represented as @newtype at s of
           -- types in "Data.Int" and "Data.Word", and are instances of
diff --git a/libraries/base/System/Posix/Types.hs b/libraries/base/System/Posix/Types.hs
index c2ac65e..e1fc051 100644
--- a/libraries/base/System/Posix/Types.hs
+++ b/libraries/base/System/Posix/Types.hs
@@ -25,6 +25,12 @@
 module System.Posix.Types (
 
   -- * POSIX data types
+
+  -- ** Platform differences
+  -- | This module contains platform specific information about types.
+  --   __/As such the types presented on this page reflect the platform
+  --   on which the documentation was generated and may not coincide with
+  --   the types on your platform./__
 #if defined(HTYPE_DEV_T)
   CDev(..),
 #endif