diff options
| author | Tamar Christina <tamar@zhox.com> | 2016-09-10 13:04:19 +0100 |
|---|---|---|
| committer | Tamar Christina <tamar@zhox.com> | 2016-09-10 20:32:57 +0100 |
| commit | 710f21cc3a6f10dac1b31d089458e5fd16f6d3db (patch) | |
| tree | a1931db61f76ce48832f8091a317af8cc2fcd63d /libraries/base/Foreign | |
| parent | 7b4bb40555eb19b528a976ff1f1b43c8bded6373 (diff) | |
| download | haskell-710f21cc3a6f10dac1b31d089458e5fd16f6d3db.tar.gz | |
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
Diffstat (limited to 'libraries/base/Foreign')
| -rw-r--r-- | libraries/base/Foreign/C/Types.hs | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/libraries/base/Foreign/C/Types.hs b/libraries/base/Foreign/C/Types.hs index a16f838eed..6d084bfe43 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@s of -- types in "Data.Int" and "Data.Word", and are instances of |