Opened 6 years ago

Closed 6 years ago

#4825 closed bug (fixed)

DLLs not documented consistently

Reported by: Orphi Owned by: igloo
Priority: high Milestone: 7.2.1
Component: Documentation Version: 7.0.1
Keywords: Cc: haskell.org@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

Currently half of the GHC 7.0.1 User Guide claims that dynamic linking works on Windows now, and the other half of the User Guide still claims that it doesn't work.

That's the general problem. Now here is the hard data:

  • Section 1.5.4: Correctly status that DLLs work now.
  • Section 4.12 (top): Incorrectly claims that you can't build packages as DLLs.
  • Section 4.12.4: Describes how dynamic libraries are searched for, but only for Unix and Mac OS. It mentions that Windows is the third alternative, but omits actually describing it.
  • Section 11.6 (top): Incorrectly claims that you can't build packages as DLLs. (The rest of this section talks about building DLLs callable from other languages, which is presumably still correct.)

I believe this list is complete, but I may be wrong.

Attachments (1)

fix4825 (20.4 KB) - added by Orphi 6 years ago.
My documentation updates.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 6 years ago by Orphi

PS. Section 4.12.4 says that -dynload has 3 modes: "sysdep" and "deploy". Unless I'm mistaken, that's actually two modes, not three. (I don't know whether there's a mode missing from the documentation, or somebody just typed "three" by mistake...)

comment:2 Changed 6 years ago by Orphi

Owner: set to Orphi

I've got a GHC source repository on my PC and I've fixed the User Guide. I just need to work out how to pull a patch out of Darcs. Hopefully tomorrow...

Changed 6 years ago by Orphi

Attachment: fix4825 added

My documentation updates.

comment:3 Changed 6 years ago by Orphi

Status: newpatch

Assuming I did this right, I've attached a Darcs patch that fixes the inconsistencies in the User Guide. (Section 4.12.4 still has two modes but claims there are three; somebody else will have to fix that.)

Let me know what you think...

comment:4 Changed 6 years ago by simonmar

Milestone: 7.0.2
Priority: normalhigh

Thanks for the patch! We'll review, and try to get it into 7.0.2.

comment:5 Changed 6 years ago by Orphi

Just a small additional note: It appears that fixing trac #4275 involved removing a -dynload wrapper option. This is presumably the phantom third option that 4.12.4 still refers to. If somebody wants to correct the "three" to "two" while they're in there...

comment:6 Changed 6 years ago by igloo

Milestone: 7.0.27.2.1

comment:7 Changed 6 years ago by litoh

Cc: haskell.org@… added

comment:8 Changed 6 years ago by igloo

Owner: changed from Orphi to igloo

comment:9 Changed 6 years ago by duncan

Resolution: fixed
Status: patchclosed

Thanks Orphi. I've applied your changes plus a bit of extra editing to both ghc-7.0.x and ghc head branches.

Tue May 17 16:31:11 BST 2011  Duncan Coutts <duncan@well-typed.com>
  * FIX #4825: Update User Guide info on DLLs.
  Original patch by Orphi <MathematicalOrchid@hotmail.com>
  Plus a few miscellaneous updates from me.
Note: See TracTickets for help on using tickets.