= The Haddock Development Wiki and Bug Tracker =

Haddock is a tool for automatically generating documentation from annotated Haskell source code. This is its developer wiki and bug tracker. If you want to help out by adding information to the wiki, or by sending bug reports or requests requests, just [/register register] an account and edit away!

= Offical Source Code Repository =

All official branches of Haddock reside in the following Git repository:

  `http://darcs.haskell.org/haddock.git`

It contains the following branches:

 * `ghc-7.6` - Main development branch.  Compatible with latest GHC release. If you want to contribute to Haddock, base your work on this branch.
 * `master` - In synch with development of GHC HEAD. May not compile with latest GHC release. Changes from `ghc-7.6` are merged in from time to time.

It may also contains other branches, most often corresponding to other development branches of GHC.

= Development Topics =

 * [wiki:CrossPackageDocumentation Cross-package documentation]
 * [wiki:MarkupConventions Markup Conventions in generated pages]
 * [wiki:NewFileFormat New file format]

= Contributing =

All new code needs tests.  Currently we manly use golden tests for testing Haddock (see {{{tests/html-tests/}}}).  We also have some unit tests
(see {{{tests/unit-tests/}}}), in the future we want more of those.

State clearly what the purpose/scope of a test is.  For historical reasons, not all existing tests do so.  But it is mandatory for new tests.  Here are some examples:

 * [https://github.com/ghc/haddock/blob/ghc-7.6/html-test/src/DeprecatedReExport.hs html-test/src/DeprecatedReExport.hs]
 * [https://github.com/ghc/haddock/blob/ghc-7.6/html-test/src/PruneWithWarning.hs html-test/src/PruneWithWarning.hs]
 * [https://github.com/ghc/haddock/blob/ghc-7.6/html-test/src/DeprecationMessageParseError.hs html-test/src/DeprecationMessageParseError.hs]
 * [https://github.com/ghc/haddock/blob/ghc-7.6/html-test/src/SpuriousSuperclassConstraints.hs html-test/src/SpuriousSuperclassConstraints.hs]

= Links =

 * [http://www.haskell.org/haddock The official homepage]. For general information about Haddock and how to use it.

 * [http://projects.haskell.org/cgi-bin/mailman/listinfo/haddock The Haddock mailing list]. Receives notifications about updates to tickets, and can be used for developer discussion.