Opened 16 months ago

Last modified 16 months ago

#7505 new bug

Commentary shipped with GHC sources is outdated

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

Description

Commentary that comes with GHC sources is outdated. It contains incorrect links:

All these pages 404.

The document says it was last updated in 2005 so I guess that information from it has been moved to the wiki. Perhaps it's time to either update or remove this commentary from the sources? Right now it's a bit confusing: should I read this commentary or the wiki?

Change History (6)

comment:1 Changed 16 months ago by shelarcy

I think that we should update source:compiler/DEPEND-NOTES to refer wiki:Commentary/ModuleStructure page, if we remove commentary from GHC sources.

comment:2 Changed 16 months ago by simonmar

  • Difficulty set to Unknown

This is the old commentary before we moved it to the wiki. I think there might still be bits that never got copied over, which is why it's still in the tree.

comment:3 follow-up: Changed 16 months ago by jstolarek

If I verified that everything in the commentary is in the wiki would you agree to remove it from the source distribution?

comment:4 in reply to: ↑ 3 Changed 16 months ago by simonmar

Replying to jstolarek:

If I verified that everything in the commentary is in the wiki would you agree to remove it from the source distribution?

Absolutely! Or at the least, we can remove the parts that have moved to the wiki.

comment:5 Changed 16 months ago by jstolarek

I just noticed that there is yet another version of the old commentary here. It is linked to from the bottom of the Commentary page. This version of comm is not shipped with the sources. Somebody already started to verify which information is in the wiki and which is not. This should make the task easier.

comment:6 Changed 16 months ago by igloo

  • Milestone set to 7.8.1
Note: See TracTickets for help on using tickets.