Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#2518 closed bug (fixed)

hard-to-find .hs-boot docs

Reported by: Isaac Dupree Owned by:
Priority: normal Milestone:
Component: Documentation Version: 6.8.3
Keywords: Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Difficulty: Unknown
Test Case: Blocked By:
Blocking: Related Tickets:

Description

I can never find the User's Guide's documentation on .hs-boot files... and this documentation section is wrong:

http://www.haskell.org/ghc/docs/latest/html/users_guide/bugs-and-infelicities.html#infelicities-Modules

The lack of implementing mutually recursive modules directly as specified by Haskell98 is at least an infelicity I think :-) ... that section should summarize and link to http://www.haskell.org/ghc/docs/latest/html/users_guide/separate-compilation.html#mutual-recursion

Change History (6)

comment:1 Changed 6 years ago by malcolm.wallace@…

The Haskell'98 Report specifies in Section 5.7:

"Depending on the Haskell implementation used, separate compilation of mutually recursive modules may require that imported modules contain additional information so that they may be referenced before they are compiled. The precise details of separate compilation are not defined by this report."

comment:2 Changed 6 years ago by Isaac Dupree

Well, I don't think that .hs-boot files are information that "imported modules contain", because it's in a separate file, which is a nuisance to me in practice. And there's no inherent reason that ghc --make has to use separate compilation, so it's not completely obvious that that paragraph -as written- should apply. But I don't think the details matter so much as that the documentation should point out in that location what's going on, because users regularly get confused about it. If it really doesn't even count as an infelicity, then it should go in the "undefined behavior in Haskell 98" section of that page, <http://www.haskell.org/ghc/docs/latest/html/users_guide/bugs-and-infelicities.html#haskell98-undefined>, a section that unfortunately is harder to read due to the lack of sub-headings in the table of contents.

comment:3 Changed 6 years ago by simonpj

  • Difficulty set to Unknown

OK I'll add it as an infelicity.

Simon

comment:4 Changed 6 years ago by simonpj

  • Resolution set to fixed
  • Status changed from new to closed

Fixed by

Tue Aug 19 13:30:16 BST 2008  simonpj@microsoft.com
  * Fix Trac #2518: add hs-boot files as an infelicty

Simon

comment:5 Changed 6 years ago by simonmar

  • Architecture changed from Unknown to Unknown/Multiple

comment:6 Changed 6 years ago by simonmar

  • Operating System changed from Unknown to Unknown/Multiple
Note: See TracTickets for help on using tickets.