[GHC] #12586: Add types warning to Foreign.C.Types
#12586: Add types warning to Foreign.C.Types -------------------------------------+------------------------------------- Reporter: Phyx- | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: | Version: 8.0.1 libraries/base | Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: Documentation Unknown/Multiple | bug Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- Documentation for the base types in `Foreign.C` are incorrect on Hackage. Not really incorrect but only valid for the platform for which Haddock runs. As an example it says for `CLong` {{{ newtype CLong = CLong Int64 }}} Which is Incorrect on Windows. I don't know a technical solution for this, so I'm proposing a non-technical one: Add a warning on the top of the `Foreign-C-Types` to indicate that these types may differ on various platforms. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#12586: Add types warning to Foreign.C.Types -------------------------------------+------------------------------------- Reporter: Phyx- | Owner: Phyx- Type: bug | Status: new 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): Wiki Page: | -------------------------------------+------------------------------------- Changes (by Phyx-): * owner: => Phyx- -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#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: | -------------------------------------+------------------------------------- Changes (by Phyx-): * status: new => patch * differential: => Phab:D2523 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#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
#12586: Add types warning to Foreign.C.Types -------------------------------------+------------------------------------- Reporter: Phyx- | Owner: Phyx- Type: bug | Status: closed Priority: normal | Milestone: Component: libraries/base | Version: 8.0.1 Resolution: fixed | 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: | -------------------------------------+------------------------------------- Changes (by Phyx-): * status: patch => closed * resolution: => fixed -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#12586: Add types warning to Foreign.C.Types -------------------------------------+------------------------------------- Reporter: Phyx- | Owner: Phyx- Type: bug | Status: merge Priority: normal | Milestone: Component: libraries/base | Version: 8.0.1 Resolution: fixed | 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: | -------------------------------------+------------------------------------- Changes (by Phyx-): * status: closed => merge Comment: Merge if possible, just adds documentation. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#12586: Add types warning to Foreign.C.Types -------------------------------------+------------------------------------- Reporter: Phyx- | Owner: Phyx- Type: bug | Status: closed Priority: normal | Milestone: 8.0.2 Component: libraries/base | Version: 8.0.1 Resolution: fixed | 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: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * milestone: => 8.0.2 Comment: Merged to `ghc-8.0` as 14fb8ef376606a4dd873374a863863357d16ed95. Thanks Tamar! -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/12586#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC