Commit 710f21cc authored by Tamar Christina's avatar Tamar Christina
Browse files

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
parent 7b4bb405
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment