Ticket #4825 (closed bug: fixed)

Opened 2 years ago

Last modified 2 years ago

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 Difficulty:
Test Case: Blocked By:
Blocking: Related Tickets:

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

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

Change History

Changed 2 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...)

Changed 2 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 2 years ago by Orphi

My documentation updates.

Changed 2 years ago by Orphi

  • status changed from new to patch

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...

Changed 2 years ago by simonmar

  • priority changed from normal to high
  • milestone set to 7.0.2

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

Changed 2 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...

Changed 2 years ago by igloo

  • milestone changed from 7.0.2 to 7.2.1

Changed 2 years ago by litoh

  • cc haskell.org@… added

Changed 2 years ago by igloo

  • owner changed from Orphi to igloo

Changed 2 years ago by duncan

  • status changed from patch to closed
  • resolution set to fixed

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.