[Haddock] [haddock] #255: Rework the test method to prevent failing tests due to interface file version changes.

[haddock]

#255: Rework the test method to prevent failing tests due to interface file
version changes.
--------------------+-------------------------------------------------------
Reporter:  Fūzetsu  |       Owner:     
    Type:  defect   |      Status:  new
Priority:  major    |   Milestone:     
 Version:           |    Keywords:     
--------------------+-------------------------------------------------------
 Bumping up the interface version during development to something
 incompatible with the interface file of the developer's GHC causes Haddock
 to be unable to link to basic things like String. While this is expected,
 the HTML test-suite fails because of it: links don't get generated,
 formatting changes (no line breaks for `<a>` tags) and the tests fail.

 Either stripping the file comparison has to be made smarter (strip links
 AND tags AND reformat the file) or tests somehow made fully independent of
 what's on the developer's system, including base documentation.

 First option is easier and most likely what will be done. Second option is
 hard but we don't lose the ability to do link comparisons. Currently link
 comparisons aren't done due to stripping anyway (which causes problems
 when trying to test something like ticket #253).

 A quick and effective solution would be to simply not refer to any types
 defined in any external modules (those not in the testing directory).

 A long term solution would be to strip + reformat for tests where we don't
 care about links AND improve the way testing is done so that we can do
 fully self-contained tests with links when we do care.

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/255>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool