Opened 6 years ago

Closed 3 weeks ago

#5546 closed bug (fixed)

Documentation errors in Control.Exception.Base

Reported by: bit Owned by:
Priority: high Milestone: 8.2.1
Component: libraries/base Version: 8.0.1
Keywords: Cc:
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

I found the following 2 errors in the documentation of Control.Exception.Base

catch

From the documentation for the catch function:

... see the previous section "Catching all exceptions"

There is no such section!

mask

From the documentation for the mask function:

... the only way is to create a new thread; see Control.Concurrent.forkIOUnmasked.

But forkIOUnmasked is deprecated!

Change History (6)

comment:1 Changed 6 years ago by simonmar

Milestone: 7.4.1
Owner: set to simonmar
Priority: normalhigh

Thanks for the report; fix coming.

comment:2 Changed 6 years ago by simonmar

Resolution: fixed
Status: newclosed
commit 530fa0b23ed414ef3442803baf107d7a646b35f2
Author: Simon Marlow <marlowsd@gmail.com>
Date:   Tue Oct 18 10:42:04 2011 +0100

    fix cross-ref to "Catching all exceptions" section (#5546)
commit 1dd55b30cdbcd13d581ee533e527b9098b770e96
Author: Simon Marlow <marlowsd@gmail.com>
Date:   Tue Oct 18 10:42:31 2011 +0100

    update ref to deprecated function forkIOUnmasked -> forkIOWithUnmask (#5546)

comment:3 Changed 3 weeks ago by bezirg

In the documentation of Control.Exception of base 4.9.10 there is still a link to non-existing forkIOUnmasked function:

To create a a new thread in an unmasked state use forkIOUnmasked.

comment:4 Changed 3 weeks ago by bezirg

Milestone: 7.4.1
Owner: simonmar deleted
Resolution: fixed
Status: closednew
Version: 7.2.18.0.1

comment:5 Changed 3 weeks ago by Ben Gamari <ben@…>

In 1840121/ghc:

base: Fix documentation for forkIOWithUnmask

forkIOUnmasked has been deprecated for several years now. Update reference to
it. See #4858 and #5546.

comment:6 Changed 3 weeks ago by bgamari

Milestone: 8.2.1
Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.