[Git][ghc/ghc][wip/fine-grained-unused-warnings] 4071 commits: [haddock @ 2002-04-04 16:23:43 by simonmar]

Jade (@Jade) gitlab at gitlab.haskell.org
Sun Jun 2 19:33:00 UTC 2024



Jade pushed to branch wip/fine-grained-unused-warnings at Glasgow Haskell Compiler / GHC


Commits:
2b39cd94 by Simon Marlow at 2002-04-04T16:23:43+00:00
[haddock @ 2002-04-04 16:23:43 by simonmar]
This is Haddock, my stab at a Haskell documentation tool.  It's not
quite ready for release yet, but I'm putting it in the repository so
others can take a look.

It uses a locally modified version of the hssource parser, extended
with support for GHC extensions and documentation annotations.

- - - - -
99ede94f by Simon Marlow at 2002-04-04T16:24:10+00:00
[haddock @ 2002-04-04 16:24:10 by simonmar]
forgot one file

- - - - -
8363294c by Simon Marlow at 2002-04-05T13:58:15+00:00
[haddock @ 2002-04-05 13:58:15 by simonmar]
Remap names in the exported declarations to be "closer" to the current
module.  eg. if an exported declaration mentions a type 'T' which is
imported from module A then re-exported from the current module, then
links from the type or indeed the documentation will point to the
current module rather than module A.

This is to support better hiding: module A won't be referred to in the
generated output.

- - - - -
1570cbc1 by Simon Marlow at 2002-04-05T13:58:23+00:00
[haddock @ 2002-04-05 13:58:23 by simonmar]
update the TODO list

- - - - -
3a62f96b by Simon Marlow at 2002-04-05T14:11:51+00:00
[haddock @ 2002-04-05 14:11:51 by simonmar]
Fix the anchor for a class declaration

- - - - -
c5d9a471 by Simon Marlow at 2002-04-05T14:18:41+00:00
[haddock @ 2002-04-05 14:18:41 by simonmar]
remove underlines on visited links

- - - - -
97280525 by Simon Marlow at 2002-04-05T16:11:47+00:00
[haddock @ 2002-04-05 16:11:47 by simonmar]
- Update to generate more correct HTML.

- Use our own non-overloaded table combinators, as the overloaded
  versions were giving me a headache.  The improved type safety
  caught several errors in the HTML generation.

- - - - -
9acd3a4d by Simon Marlow at 2002-04-05T16:32:19+00:00
[haddock @ 2002-04-05 16:32:19 by simonmar]
Add width property to the title, and add TD.children for the module
contents page.

- - - - -
ec9a0847 by Simon Marlow at 2002-04-08T16:39:56+00:00
[haddock @ 2002-04-08 16:39:56 by simonmar]
Fix a problem with exports of the form T(..).

- - - - -
e4627dc8 by Simon Marlow at 2002-04-08T16:41:38+00:00
[haddock @ 2002-04-08 16:41:37 by simonmar]
- Add our own versions of Html & BlockTable for the time being.
- Add support for generating an index to the HTML backend

- - - - -
2d73fd75 by Simon Marlow at 2002-04-09T11:23:24+00:00
[haddock @ 2002-04-09 11:23:24 by simonmar]
Add '-- /' as a synonym for '-- |', for compatibility with IDoc.

- - - - -
3675464e by Simon Marlow at 2002-04-09T11:33:55+00:00
[haddock @ 2002-04-09 11:33:54 by simonmar]
- add the <...> syntax for marking up URLs in documentation

- Make the output for data & class declarations more compact when
  there aren't any documentation annotations on the individual
  methods or constructors respectively.

- - - - -
5077f5b1 by Simon Marlow at 2002-04-09T11:36:04+00:00
[haddock @ 2002-04-09 11:36:04 by simonmar]
Update the TODO list

- - - - -
9e83c54d by Simon Marlow at 2002-04-10T10:50:06+00:00
[haddock @ 2002-04-10 10:50:06 by simonmar]
Use explicit 'px' suffix on pixel sizes; IE seems to prefer them

- - - - -
052de51c by Simon Marlow at 2002-04-10T13:23:13+00:00
[haddock @ 2002-04-10 13:23:13 by simonmar]
Lex URLs as a single token to avoid having to escape special
characters inside the URL string.

- - - - -
47187edb by Simon Marlow at 2002-04-10T13:23:55+00:00
[haddock @ 2002-04-10 13:23:55 by simonmar]
Not sure why I made the constructor name for a record declaration into
a TyCls name, but change it back into a Var name anyhow.

- - - - -
3dc6aa81 by Simon Marlow at 2002-04-10T13:26:10+00:00
[haddock @ 2002-04-10 13:26:09 by simonmar]
Lots of changes, including:

- add index support to the HTML backend
- clean up the renamer, put it into a monad
- propogate unresolved names to the top level and report them in a nicer way
- various bugfixes

- - - - -
c2a70a72 by Simon Marlow at 2002-04-10T13:32:39+00:00
[haddock @ 2002-04-10 13:32:39 by simonmar]
Skeleton documentation

- - - - -
50c98d17 by Simon Marlow at 2002-04-10T13:37:23+00:00
[haddock @ 2002-04-10 13:37:23 by simonmar]
Update the TODO list, separate into pre-1.0 and post-1.0 items

- - - - -
f3778be6 by Simon Marlow at 2002-04-10T14:30:58+00:00
[haddock @ 2002-04-10 14:30:58 by simonmar]
Add an introduction

- - - - -
cfbaf9f7 by Simon Marlow at 2002-04-10T14:59:51+00:00
[haddock @ 2002-04-10 14:59:51 by simonmar]
Sort the module tree

- - - - -
76bd7b34 by Simon Marlow at 2002-04-10T15:50:11+00:00
[haddock @ 2002-04-10 15:50:10 by simonmar]
Generate a little table of contents at the top of the module doc (only
if the module actually contains some section headings, though).

- - - - -
bb8560a1 by Simon Marlow at 2002-04-10T16:10:26+00:00
[haddock @ 2002-04-10 16:10:26 by simonmar]
Now we understand (or at least don't barf on) type signatures in
patterns such as you might find when scoped type variables are in use.

- - - - -
86c2a026 by Simon Marlow at 2002-04-10T16:10:49+00:00
[haddock @ 2002-04-10 16:10:49 by simonmar]
more updates

- - - - -
1c052b0e by Simon Marlow at 2002-04-10T16:28:05+00:00
[haddock @ 2002-04-10 16:28:05 by simonmar]
Parse errors in doc strings are now reported as warnings rather that
causing the whole thing to fall over.  It still needs cleaning up (the
warning is emitted with trace) but this will do for the time being.

- - - - -
ace03e8f by Simon Marlow at 2002-04-10T16:38:03+00:00
[haddock @ 2002-04-10 16:38:03 by simonmar]
update again

- - - - -
69006c3e by Simon Marlow at 2002-04-11T13:38:02+00:00
[haddock @ 2002-04-11 13:38:02 by simonmar]
mention Opera

- - - - -
fe9b10f8 by Simon Marlow at 2002-04-11T13:40:31+00:00
[haddock @ 2002-04-11 13:40:30 by simonmar]
- copy haddock.css into the same place as the generated HTML

- new option: --css <file>  specifies the style sheet to use

- new option:  -o <dir>  specifies the directory in which to
  generate the output.

- because Haddock now needs to know where to find its default stylesheet,
  we have to have a wrapper script and do the haddock-inplace thing
  (Makefile code copied largely from fptools/happy).

- - - - -
106adbbe by Simon Marlow at 2002-04-24T15:12:41+00:00
[haddock @ 2002-04-24 15:12:41 by simonmar]
Stop slurping comment lines when we see a row of dashes longer than
length 2: these are useful as separators.

- - - - -
995d3f9e by Simon Marlow at 2002-04-24T15:14:12+00:00
[haddock @ 2002-04-24 15:14:11 by simonmar]
Grok the kind of module headers we use in fptools/libraries, and pass
the "portability", "stability", and "maintainer" strings through into
the generated HTML.  If the module header doesn't match the pattern,
then we don't include the info in the HTML.

- - - - -
e14da136 by Simon Marlow at 2002-04-24T15:16:57+00:00
[haddock @ 2002-04-24 15:16:57 by simonmar]
Done module headers now.

- - - - -
2ca8dfd4 by Simon Marlow at 2002-04-24T15:57:48+00:00
[haddock @ 2002-04-24 15:57:47 by simonmar]
Handle gcons in export lists (a common extension).

- - - - -
044cea81 by Simon Marlow at 2002-04-25T14:20:12+00:00
[haddock @ 2002-04-25 14:20:12 by simonmar]
Add the little lambda icon

- - - - -
63955027 by Simon Marlow at 2002-04-25T14:40:05+00:00
[haddock @ 2002-04-25 14:40:05 by simonmar]
- Add support for named chunks of documentation which can be
  referenced from the export list.

- Copy the icon from $libdir to the destination in HTML mode.

- - - - -
36e3f913 by Simon Marlow at 2002-04-25T16:48:36+00:00
[haddock @ 2002-04-25 16:48:36 by simonmar]
More keyboard bashing

- - - - -
7ae18dd0 by Simon Marlow at 2002-04-26T08:43:33+00:00
[haddock @ 2002-04-26 08:43:33 by simonmar]
Package util reqd. to compile with 4.08.2

- - - - -
bbd5fbab by Simon Marlow at 2002-04-26T10:13:00+00:00
[haddock @ 2002-04-26 10:13:00 by simonmar]
Include $(GHC_HAPPY_OPTS) when compiling HsParser

- - - - -
31c53d79 by Simon Marlow at 2002-04-26T11:18:57+00:00
[haddock @ 2002-04-26 11:18:56 by simonmar]
- support for fundeps (partially contributed by Brett Letner - thanks
  Brett).

- make it build with GHC 4.08.2

- - - - -
c415ce76 by Simon Marlow at 2002-04-26T13:15:02+00:00
[haddock @ 2002-04-26 13:15:02 by simonmar]
Move the explicit formatting of the little table for the
stability/portability/maintainer info from the HTML into the CSS, and
remove the explicit table size (just right-align it).

- - - - -
520ee21a by Simon Marlow at 2002-04-26T16:01:44+00:00
[haddock @ 2002-04-26 16:01:44 by simonmar]
Yet more keyboard bashing - this is pretty much complete now.

- - - - -
2ae37179 by Simon Marlow at 2002-04-26T16:02:14+00:00
[haddock @ 2002-04-26 16:02:14 by simonmar]
Add a couple of things I forgot about

- - - - -
b7211e04 by Simon Marlow at 2002-04-29T15:28:12+00:00
[haddock @ 2002-04-29 15:28:12 by simonmar]
bugfix for declBinders on a NewTypeDecl

- - - - -
640c154a by Simon Marlow at 2002-04-29T15:28:54+00:00
[haddock @ 2002-04-29 15:28:54 by simonmar]
Allow '-- |' style annotations on constructors and record fields.

- - - - -
393f258a by Simon Marlow at 2002-04-29T15:37:32+00:00
[haddock @ 2002-04-29 15:37:32 by simonmar]
syntax fix

- - - - -
8a2c2549 by Simon Marlow at 2002-04-29T15:37:48+00:00
[haddock @ 2002-04-29 15:37:48 by simonmar]
Add an example

- - - - -
db88f8a2 by Simon Marlow at 2002-04-29T15:55:46+00:00
[haddock @ 2002-04-29 15:55:46 by simonmar]
remove a trace

- - - - -
2b0248e0 by Simon Marlow at 2002-04-29T15:56:19+00:00
[haddock @ 2002-04-29 15:56:19 by simonmar]
Fix for 'make install'

- - - - -
120453a0 by Simon Marlow at 2002-04-29T15:56:39+00:00
[haddock @ 2002-04-29 15:56:39 by simonmar]
Install the auxilliary bits

- - - - -
950e6dbb by Simon Marlow at 2002-04-29T15:57:30+00:00
[haddock @ 2002-04-29 15:57:30 by simonmar]
Add BinDist bits

- - - - -
154b9d71 by Simon Marlow at 2002-05-01T11:02:52+00:00
[haddock @ 2002-05-01 11:02:52 by simonmar]
update

- - - - -
ba6c39fa by Simon Marlow at 2002-05-01T11:03:26+00:00
[haddock @ 2002-05-01 11:03:26 by simonmar]
Add another item

- - - - -
bacb5e33 by Simon Marlow at 2002-05-03T08:50:00+00:00
[haddock @ 2002-05-03 08:50:00 by simonmar]
Fix some typos.

- - - - -
54c87895 by Sven Panne at 2002-05-05T19:40:51+00:00
[haddock @ 2002-05-05 19:40:51 by panne]
As a temporary hack/workaround for a bug in GHC's simplifier, don't
pass Happy the -c option for generating the parsers in this
subdir. Furthermore, disable -O for HaddocParse, too.

- - - - -
e6c08703 by Simon Marlow at 2002-05-06T09:51:10+00:00
[haddock @ 2002-05-06 09:51:10 by simonmar]
Add RPM spec file (thanks to Tom Moertel <tom-rpms at moertel.com>)

- - - - -
7b8fa8e7 by Simon Marlow at 2002-05-06T12:29:26+00:00
[haddock @ 2002-05-06 12:29:26 by simonmar]
Add missing type signature (a different workaround for the bug in
GHC's simplifier).

- - - - -
cd0e300d by Simon Marlow at 2002-05-06T12:30:09+00:00
[haddock @ 2002-05-06 12:30:09 by simonmar]
Remove workaround for simplifier bug in previous revision.

- - - - -
687e68fa by Simon Marlow at 2002-05-06T12:32:32+00:00
[haddock @ 2002-05-06 12:32:32 by simonmar]
Allow empty data declarations (another GHC extension).

- - - - -
8f29f696 by Simon Marlow at 2002-05-06T12:49:21+00:00
[haddock @ 2002-05-06 12:49:21 by simonmar]
Fix silly bug in named documentation block lookup.

- - - - -
8e0059af by Simon Marlow at 2002-05-06T13:02:42+00:00
[haddock @ 2002-05-06 13:02:42 by simonmar]
Add another named chunk with a different name

- - - - -
68f8a896 by Simon Marlow at 2002-05-06T13:32:32+00:00
[haddock @ 2002-05-06 13:32:32 by simonmar]
Be more lenient about extra paragraph breaks

- - - - -
65fc31db by Simon Marlow at 2002-05-07T15:36:36+00:00
[haddock @ 2002-05-07 15:36:36 by simonmar]
DocEmpty is a right and left-unit of DocAppend (remove it in the smart
constructor).

- - - - -
adc81078 by Simon Marlow at 2002-05-07T15:37:15+00:00
[haddock @ 2002-05-07 15:37:15 by simonmar]
Allow code blocks to be denoted with bird-tracks in addition to [...].

- - - - -
1283a3c1 by Simon Marlow at 2002-05-08T11:21:56+00:00
[haddock @ 2002-05-08 11:21:56 by simonmar]
Add a facility for specifying options that affect Haddock's treatment
of the module.  Options are given at the top of the module in a
comma-separated list, beginning with '-- #'.  eg.

	-- # prune, hide, ignore-exports

Options currently available, with their meanings:

  prune:
	ignore declarations which have no documentation annotations

  ignore-exports:
	act as if the export list were not specified (i.e. export
   	everything local to the module).

  hide:
	do not include this module in the generated documentation, but
 	propagate any exported definitions to modules which re-export
	them.

There's a slight change in the semantics for re-exporting a full
module by giving 'module M' in the export list: if module M does not
have the 'hide' option, then the documentation will now just contain a
reference to module M rather than the full inlined contents of that
module.

These features, and some other changes in the pipeline, are the result
of discussions between myself and Manuel Chakravarty
<chak at cse.unsw.edu.au> (author of IDoc) yesterday.

Also: some cleanups, use a Writer monad to collect error messages in
some places instead of just printing them with trace.

- - - - -
a2239cf5 by Simon Marlow at 2002-05-08T11:22:30+00:00
[haddock @ 2002-05-08 11:22:30 by simonmar]
Update to test new features.

- - - - -
6add955f by Simon Marlow at 2002-05-08T13:37:25+00:00
[haddock @ 2002-05-08 13:37:25 by simonmar]
Change the markup for typewriter-font from [...] to @... at .  The
reasoning is that the '@' symbol is much less likely to be needed than
square brackets, and we don't want to have to escape square brackets
in code fragments.

This will be mildly painful in the short term, but it's better to get
the change out of the way as early as possible.

- - - - -
cda06447 by Simon Marlow at 2002-05-08T13:39:56+00:00
[haddock @ 2002-05-08 13:39:56 by simonmar]
Allow nested-style comments to be used as documentation annotations too. eg.

	{-| ... -}

is equivalent to

	-- | ...

An extra space can also be left after the comment opener: {- | ... -}.
The only version that isn't allowed is {-# ... -}, because this syntax
overlaps with Haskell pragmas;  use {- # ... -} instead.

- - - - -
db23f65e by Simon Marlow at 2002-05-08T14:48:41+00:00
[haddock @ 2002-05-08 14:48:39 by simonmar]
Add support for existential quantifiers on constructors.

- - - - -
adce3794 by Simon Marlow at 2002-05-08T15:43:25+00:00
[haddock @ 2002-05-08 15:43:25 by simonmar]
update

- - - - -
62a1f436 by Simon Marlow at 2002-05-08T15:44:10+00:00
[haddock @ 2002-05-08 15:44:10 by simonmar]
Update to version 0.2

- - - - -
f6a24ba3 by Simon Marlow at 2002-05-09T08:48:29+00:00
[haddock @ 2002-05-09 08:48:29 by simonmar]
typo

- - - - -
9f9522a4 by Simon Marlow at 2002-05-09T10:33:14+00:00
[haddock @ 2002-05-09 10:33:14 by simonmar]
oops, left out '/' from the special characters in the last change.

- - - - -
14abcb39 by Simon Marlow at 2002-05-09T10:34:44+00:00
[haddock @ 2002-05-09 10:34:44 by simonmar]
Fix buglet

- - - - -
b8d878be by Simon Marlow at 2002-05-09T10:35:00+00:00
[haddock @ 2002-05-09 10:35:00 by simonmar]
Give a more useful instance of Show for Module.

- - - - -
f7bfd626 by Simon Marlow at 2002-05-09T10:37:07+00:00
[haddock @ 2002-05-09 10:37:07 by simonmar]
The last commit to Main.lhs broke the delicate balance of laziness
which was being used to avoid computing the dependency graph of
modules.

So I finally bit the bullet and did a proper topological sort of the
module graph, which turned out to be easy (stealing the Digraph module
from GHC - this really ought to be in the libraries somewhere).

- - - - -
b481c1d0 by Simon Marlow at 2002-05-09T10:37:25+00:00
[haddock @ 2002-05-09 10:37:25 by simonmar]
another item done

- - - - -
032e2b42 by Simon Marlow at 2002-05-09T10:44:15+00:00
[haddock @ 2002-05-09 10:44:15 by simonmar]
Don't consider a module re-export as having documentation, for the
purposes of deciding whether we need a Synopsis section or not.

- - - - -
5fb45e92 by Simon Marlow at 2002-05-09T11:10:55+00:00
[haddock @ 2002-05-09 11:10:55 by simonmar]
Add a special case for list types in ppHsAType

- - - - -
1937e428 by Simon Marlow at 2002-05-09T12:43:06+00:00
[haddock @ 2002-05-09 12:43:06 by simonmar]
Type synonyms can accept a ctype on the RHS, to match GHC.

- - - - -
0f16ce56 by Simon Marlow at 2002-05-09T12:45:19+00:00
[haddock @ 2002-05-09 12:45:19 by simonmar]
Add 'stdcall' keyword

- - - - -
29b0d7d2 by Simon Marlow at 2002-05-09T13:35:45+00:00
[haddock @ 2002-05-09 13:35:45 by simonmar]
Add System Requirements section

- - - - -
bf14dddd by Simon Marlow at 2002-05-09T13:36:11+00:00
[haddock @ 2002-05-09 13:36:11 by simonmar]
Test existential types, amongst other things

- - - - -
502f8f6f by Simon Marlow at 2002-05-09T13:37:35+00:00
[haddock @ 2002-05-09 13:37:35 by simonmar]
Print the module name in a doc-string parse error

- - - - -
ca1f8d49 by Simon Marlow at 2002-05-09T13:38:04+00:00
[haddock @ 2002-05-09 13:38:04 by simonmar]
Add dependency

- - - - -
8d3d91ff by Simon Marlow at 2002-05-09T15:37:57+00:00
[haddock @ 2002-05-09 15:37:57 by simonmar]
Add the changelog/release notes

- - - - -
f3960959 by Simon Marlow at 2002-05-09T15:47:47+00:00
[haddock @ 2002-05-09 15:47:47 by simonmar]
mention the backquote-style of markup

- - - - -
089fb6e6 by Simon Marlow at 2002-05-09T15:59:45+00:00
[haddock @ 2002-05-09 15:59:45 by simonmar]
update

- - - - -
bdd3be0b by Simon Marlow at 2002-05-09T15:59:56+00:00
[haddock @ 2002-05-09 15:59:56 by simonmar]
Document changes since 0.1

- - - - -
00fc4af8 by Simon Marlow at 2002-05-10T08:22:48+00:00
[haddock @ 2002-05-10 08:22:48 by simonmar]
oops, update to version 0.2

- - - - -
a8a79041 by Simon Marlow at 2002-05-10T16:05:08+00:00
[haddock @ 2002-05-10 16:05:08 by simonmar]
Only include a mini-contents if there are 2 or more sections

- - - - -
06653319 by Simon Marlow at 2002-05-13T09:13:12+00:00
[haddock @ 2002-05-13 09:13:12 by simonmar]
fix typos

- - - - -
1402b19b by Simon Marlow at 2002-05-13T10:14:22+00:00
[haddock @ 2002-05-13 10:14:22 by simonmar]
Allow backquote as the right-hand quote as well as the left-hand
quote, as suggested by Dean Herrington.

Clean up the grammar a litte.

- - - - -
dcd5320d by Simon Marlow at 2002-05-13T10:44:10+00:00
[haddock @ 2002-05-13 10:44:10 by simonmar]
a couple more things, prioritise a bit

- - - - -
a90130c4 by Simon Marlow at 2002-05-13T15:19:03+00:00
[haddock @ 2002-05-13 15:19:03 by simonmar]
Cope with datatypes which have documentation on the constructor but
not the type itself, and records which have documentation on the
fields but not the constructor.  (Thanks to Ross Paterson for pointing
out the bugs).

- - - - -
a774d432 by Simon Marlow at 2002-05-13T15:20:54+00:00
[haddock @ 2002-05-13 15:20:54 by simonmar]
Fix one of the record examples

- - - - -
2d1d5218 by Simon Marlow at 2002-05-15T12:44:35+00:00
[haddock @ 2002-05-15 12:44:35 by simonmar]
Preserve the newline before a bird-track, but only within a paragraph.

- - - - -
1554c09a by Simon Marlow at 2002-05-15T13:03:02+00:00
[haddock @ 2002-05-15 13:03:01 by simonmar]
Reworking of the internals to support documenting function arguments
(the Most Wanted new feature by the punters).

The old method of keeping parsed documentation in a Name -> Doc
mapping wasn't going to cut it for anntations on type components,
where there's no name to attach the documentation to, so I've moved to
storing all the documentation in the abstract syntax.  Previously some
of the documentation was left in the abstract syntax by the parser,
but was later extracted into the mapping.

In order to avoid having to parameterise the abstract syntax over the
type of documentation stored in it, we have to parse the documentation
at the same time as we parse the Haskell source (well, I suppose we
could store 'Either String Doc' in the HsSyn, but that's clunky).  One
upshot is that documentation is now parsed eagerly, and documentation
parse errors are fatal (but have better line numbers in the error
message).

The new story simplifies matters for the code that processes the
source modules, because we don't have to maintain the extra Name->Doc
mapping, and it should improve efficiency a little too.

New features:

  - Function arguments and return values can now have doc annotations.

  - If you refer to a qualified name in a doc string, eg. 'IO.putStr',
    then Haddock will emit a hyperlink even if the identifier is not
    in scope, so you don't have to make sure everything referred to
    from the documentation is imported.

  - several bugs & minor infelicities fixed.

- - - - -
57344dc3 by Simon Marlow at 2002-05-15T13:03:19+00:00
[haddock @ 2002-05-15 13:03:19 by simonmar]
Bump to version 0.3

- - - - -
b2791812 by Simon Marlow at 2002-05-15T13:03:41+00:00
[haddock @ 2002-05-15 13:03:41 by simonmar]
update

- - - - -
fead183e by Simon Marlow at 2002-05-15T13:10:15+00:00
[haddock @ 2002-05-15 13:10:15 by simonmar]
Rename Foo.hs to Test.hs, and add a Makefile

- - - - -
b0b1f89f by Simon Marlow at 2002-05-15T13:16:07+00:00
[haddock @ 2002-05-15 13:16:07 by simonmar]
- Remove the note about function argument docs not being implemented

- Note that qualified identifiers can be used to point to entities
  that aren't in scope.

- - - - -
5665f31a by Simon Marlow at 2002-05-15T13:28:46+00:00
[haddock @ 2002-05-15 13:28:46 by simonmar]
Patch to add support for GHC-style primitive strings ".."#, from Ross Paterson.

- - - - -
0564505d by Simon Marlow at 2002-05-17T10:51:57+00:00
[haddock @ 2002-05-17 10:51:57 by simonmar]
Fix bugs in qualified name handling (A.B.f was returned as B.f)

- - - - -
10e7311c by Simon Marlow at 2002-05-21T10:24:52+00:00
[haddock @ 2002-05-21 10:24:52 by simonmar]
- Use an alternate tabular layout for datatypes, which is more compact
- Fix some problems with the function argument documentation

- - - - -
2f91c2a6 by Simon Marlow at 2002-05-21T10:27:40+00:00
[haddock @ 2002-05-21 10:27:40 by simonmar]
add a few more test cases

- - - - -
01c2ddd2 by Simon Marlow at 2002-05-21T10:28:33+00:00
[haddock @ 2002-05-21 10:28:33 by simonmar]
Rearrange a bit, and add support for tabular datatype rendering

- - - - -
a4e4c5f8 by Simon Marlow at 2002-05-27T09:03:52+00:00
[haddock @ 2002-05-27 09:03:51 by simonmar]
Lots of changes:

 - instances of a class are listed with the class, and
   instances involving a datatype are listed with that type.
   Derived instances aren't included at the moment: the calculation
   to find the instance head for a derived instance is non-trivial.

 - some formatting changes; use rows with specified height rather than
   cellspacing in some places.

 - various fixes (source file links were wrong, amongst others)

- - - - -
48722e68 by Simon Marlow at 2002-05-27T12:30:38+00:00
[haddock @ 2002-05-27 12:30:37 by simonmar]
- Put function arguments *before* the doc for the function, as suggested
  by Sven Panne.  This looks nicer when the function documentation is
  long.

- Switch to using bold for binders at the definition site, and use
  underline for keywords.  This makes the binder stand out more.

- - - - -
657204d2 by Simon Marlow at 2002-05-27T13:19:49+00:00
[haddock @ 2002-05-27 13:19:49 by simonmar]
Fix bug: we weren't renaming HsDocCommentNamed in renameDecl

- - - - -
592aae66 by Simon Marlow at 2002-05-27T14:10:27+00:00
[haddock @ 2002-05-27 14:10:27 by simonmar]
Fix some bugs in the rendering of qualified type signatures.

- - - - -
69c8f763 by Simon Marlow at 2002-05-27T14:36:45+00:00
[haddock @ 2002-05-27 14:36:45 by simonmar]
warning message tweak

- - - - -
16e64e21 by Simon Marlow at 2002-05-27T14:53:53+00:00
[haddock @ 2002-05-27 14:53:53 by simonmar]
hyperlinked identifiers should be in <tt>

- - - - -
8d5e4783 by Simon Marlow at 2002-05-27T15:56:45+00:00
[haddock @ 2002-05-27 15:56:45 by simonmar]
Do something sensible for modules which don't export anything (except
instances).

- - - - -
9d3ef811 by Simon Marlow at 2002-05-28T10:12:50+00:00
[haddock @ 2002-05-28 10:12:50 by simonmar]
Rename the module documentation properly (bug reported by Sven Panne).

- - - - -
ef03a1cc by Simon Marlow at 2002-05-28T10:13:04+00:00
[haddock @ 2002-05-28 10:13:04 by simonmar]
Add some more test cases

- - - - -
92baa0e8 by Simon Marlow at 2002-05-28T11:17:55+00:00
[haddock @ 2002-05-28 11:17:55 by simonmar]
If an identifier doesn't lex, then just replace it by a DocString.

- - - - -
a3156213 by Simon Marlow at 2002-05-28T16:16:19+00:00
[haddock @ 2002-05-28 16:16:19 by simonmar]
Only link to names in the current module which are actually listed in
the documentation.  A name may be exported but not present in the
documentation if it is exported as part of a 'module M' export
specifier.

- - - - -
31acf941 by Simon Marlow at 2002-05-28T16:17:11+00:00
[haddock @ 2002-05-28 16:17:11 by simonmar]
update

- - - - -
7e474ebf by Sigbjorn Finne at 2002-05-28T22:42:08+00:00
[haddock @ 2002-05-28 22:42:08 by sof]
Handle lone occurrences of '/', e.g.,

  -- | This/that.

[did this in the lexer rather than in the parser, as I couldn't
 see a way not to introduce an S/R conflict that way.]

- - - - -
093f7e53 by Simon Marlow at 2002-05-29T09:09:49+00:00
[haddock @ 2002-05-29 09:09:49 by simonmar]
Back out previous change until we can find a better way to do this.

- - - - -
9234389c by Simon Marlow at 2002-05-29T13:19:06+00:00
[haddock @ 2002-05-29 13:19:06 by simonmar]
Make the markup syntax a little more friendly:

  - single quotes are now interpreted literally unless they surround a
    valid Haskell identifier.  So for example now there's no need to
    escape a single quote used as an apostrophe.

  - text to the right of a bird track is now literal (if you want
    marked-up text in a code block, use @...@).

- - - - -
b3333526 by Simon Marlow at 2002-05-29T13:38:51+00:00
[haddock @ 2002-05-29 13:38:51 by simonmar]
Document recent changes to markup syntax

- - - - -
f93641d6 by Simon Marlow at 2002-05-29T15:27:18+00:00
[haddock @ 2002-05-29 15:27:18 by simonmar]
Include the instances in abstract data types too

- - - - -
613f21e3 by Simon Marlow at 2002-06-03T13:05:58+00:00
[haddock @ 2002-06-03 13:05:57 by simonmar]
Allow exporting of individual class methods and record selectors.  For
these we have to invent the correct type signature, which we do in the
simplest possible way (i.e. no context reduction nonsense in the class
case).

- - - - -
14b36807 by Simon Marlow at 2002-06-03T13:20:00+00:00
[haddock @ 2002-06-03 13:20:00 by simonmar]
Fix linking to qualified names again (thanks to Sven Panne for
pointing out the bug).

- - - - -
95b10eac by Simon Marlow at 2002-06-03T13:46:48+00:00
[haddock @ 2002-06-03 13:46:48 by simonmar]
Fix for exporting record selectors from a newtype declaration

- - - - -
272f932e by Simon Marlow at 2002-06-03T13:56:38+00:00
[haddock @ 2002-06-03 13:56:38 by simonmar]
update to version 0.3

- - - - -
1c0a3bed by Simon Marlow at 2002-06-03T14:05:07+00:00
[haddock @ 2002-06-03 14:05:07 by simonmar]
Add changes in version 0.3

- - - - -
145b4626 by Simon Marlow at 2002-06-03T14:12:38+00:00
[haddock @ 2002-06-03 14:12:38 by simonmar]
Render class names as proper binders

- - - - -
052106b3 by Simon Marlow at 2002-06-03T14:15:10+00:00
[haddock @ 2002-06-03 14:15:10 by simonmar]
update, and separate into bugs, features, and cosmetic items.

- - - - -
854f4914 by Simon Marlow at 2002-06-03T14:16:13+00:00
[haddock @ 2002-06-03 14:16:13 by simonmar]
More test cases

- - - - -
466922c8 by Simon Marlow at 2002-06-03T14:16:56+00:00
[haddock @ 2002-06-03 14:16:56 by simonmar]
Example from the paper

- - - - -
9962a045 by Simon Marlow at 2002-06-03T14:17:49+00:00
[haddock @ 2002-06-03 14:17:49 by simonmar]
A debugging version of the style-sheet, which gives some tables
coloured backgrounds so we can see what's going on.

- - - - -
f16b79db by Simon Marlow at 2002-06-03T14:19:46+00:00
[haddock @ 2002-06-03 14:19:46 by simonmar]
typo

- - - - -
620db27b by Simon Marlow at 2002-06-03T14:48:32+00:00
[haddock @ 2002-06-03 14:48:32 by simonmar]
oops, fix markup bugs

- - - - -
53fd105c by Simon Marlow at 2002-06-05T09:05:07+00:00
[haddock @ 2002-06-05 09:05:07 by simonmar]
Keep foreign imports when there is no export list (bug reported by
Sven Panne).

- - - - -
6d98989c by Simon Marlow at 2002-06-05T09:12:02+00:00
[haddock @ 2002-06-05 09:12:02 by simonmar]
Identifiers in single quotes can be symbol names too (bug reported by
Hal Daume).

- - - - -
001811e5 by Sven Panne at 2002-06-08T14:03:36+00:00
[haddock @ 2002-06-08 14:03:36 by panne]
Tiny workaround for the fact that Haddock currently ignores
HsImportSpecs: Let the local_orig_env take precedence.
This is no real solution at all, but improves things sometimes,
e.g. in my GLUT documentation.  :-)

- - - - -
504d19c9 by Simon Marlow at 2002-06-11T09:23:25+00:00
[haddock @ 2002-06-11 09:23:25 by simonmar]
portability nit

- - - - -
e13b5af4 by Simon Marlow at 2002-06-20T12:38:07+00:00
[haddock @ 2002-06-20 12:38:07 by simonmar]
Empty declaration fixes.

- - - - -
f467a9b6 by Simon Marlow at 2002-06-20T12:39:02+00:00
[haddock @ 2002-06-20 12:39:01 by simonmar]
Add support for a "prologue" - a description for the whole library,
placed on the contents page before the module list.

- - - - -
b8dbfe20 by Simon Marlow at 2002-06-21T12:43:06+00:00
[haddock @ 2002-06-21 12:43:06 by simonmar]
When we have a single code block paragraph, don't place it in
<pre>..</pre>, just use <tt>..</tt> to avoid generating extra vertical
white space in some browsers.

- - - - -
4831dbbd by Simon Marlow at 2002-06-21T15:50:42+00:00
[haddock @ 2002-06-21 15:50:42 by simonmar]
Add support for reading and writing interface files(!)

This turned out to be quite easy, and necessary to get decent
hyperlinks between the documentation for separate packages in the
libraries.

The functionality isn't quite complete yet: for a given package of
modules, you'd like to say "the HTML for these modules lives in
directory <dir>" (currently they are assumed to be all in the same
place).

Two new flags:

	--dump-interface=FILE   dump an interface file in FILE
	--read-interface=FILE	read interface from FILE

an interface file describes *all* the modules being processed.  Only
the exported names are kept in the interface: if you re-export a name
from a module in another interface the signature won't be copied.
This is a compromise to keep the size of the interfaces sensible.

Also, I added another useful option:

	--no-implicit-prelude

avoids trying to import the Prelude.  Previously this was the default,
but now importing the Prelude from elsewhere makes sense if you also
read in an interface containing the Prelude module, so Haddock imports
the Prelude implicitly according to the Haskell spec.

- - - - -
d3640a19 by Sven Panne at 2002-06-23T14:54:00+00:00
[haddock @ 2002-06-23 14:54:00 by panne]
Make it compile with newer GHCs

- - - - -
780c506b by Sven Panne at 2002-06-23T15:44:31+00:00
[haddock @ 2002-06-23 15:44:31 by panne]
Cleaned up build root handling and added more docs

- - - - -
45290d2e by Simon Marlow at 2002-06-24T14:37:43+00:00
[haddock @ 2002-06-24 14:37:42 by simonmar]
When reading an interface, allow a file path offset to be specified
which represents the path to the HTML files for the modules specified
by that interface.  The path may be either relative (to the location
of the HTML for this package), or absolute.

The syntax is

	--read-interface=PATH,FILE

where PATH is the path to the HTML, and FILE is the filename
containing the interface.

- - - - -
4e2b9ae6 by Simon Marlow at 2002-07-03T16:01:08+00:00
[haddock @ 2002-07-03 16:01:07 by simonmar]
Handle import specs properly, include 'hiding'.  Haddock now has a
complete implementation of the Haskell module system (more or less; I
won't claim it's 100% correct).

- - - - -
9a9aa1a8 by Simon Marlow at 2002-07-03T16:18:16+00:00
[haddock @ 2002-07-03 16:18:16 by simonmar]
Update

- - - - -
560c3026 by Simon Marlow at 2002-07-04T14:56:10+00:00
[haddock @ 2002-07-04 14:56:10 by simonmar]
Clean up the code that constructs the exported declarations, and fix a
couple of bugs along the way.  Now if you import a class hiding one of
the methods, then re-export the class, the version in the
documentation will correctly have the appropriate method removed.

- - - - -
2c26e77d by Simon Marlow at 2002-07-04T15:26:13+00:00
[haddock @ 2002-07-04 15:26:13 by simonmar]
More bugfixes to the export handling

- - - - -
03e0710d by Simon Marlow at 2002-07-09T10:12:10+00:00
[haddock @ 2002-07-09 10:12:10 by simonmar]
Don't require that the list type comes from "Prelude" for it to be
treated as special syntax (sometimes it comes from Data.List or maybe
even GHC.Base).

- - - - -
44f3891a by Simon Marlow at 2002-07-09T10:12:51+00:00
[haddock @ 2002-07-09 10:12:51 by simonmar]
commented-out debugging code

- - - - -
97280873 by Krasimir Angelov at 2002-07-09T16:33:33+00:00
[haddock @ 2002-07-09 16:33:31 by krasimir]
'Microsoft HTML Help' support

- - - - -
3dc04655 by Simon Marlow at 2002-07-10T09:40:56+00:00
[haddock @ 2002-07-10 09:40:56 by simonmar]
Fix for rendering of the (->) type constructor, from Ross Paterson.

- - - - -
c9f149c6 by Simon Marlow at 2002-07-10T10:26:11+00:00
[haddock @ 2002-07-10 10:26:11 by simonmar]
Tweaks to the MS Help support: the extra files are now only generated
if you ask for them (--ms-help).

- - - - -
e8acc1e6 by Simon Marlow at 2002-07-10T10:57:10+00:00
[haddock @ 2002-07-10 10:57:10 by simonmar]
Document all the new options since 0.3

- - - - -
8bb85544 by Simon Marlow at 2002-07-10T10:58:31+00:00
[haddock @ 2002-07-10 10:58:31 by simonmar]
Sort the options a bit

- - - - -
abc0dd59 by Simon Marlow at 2002-07-15T09:19:38+00:00
[haddock @ 2002-07-15 09:19:38 by simonmar]
Fix a bug in mkExportItems when processing a module without an
explicit export list.  We were placing one copy of a declaration for
each binder in the declaration, which for a data type would mean one
copy of the whole declaration per constructor or record selector.

- - - - -
dde65bb9 by Simon Marlow at 2002-07-15T09:54:16+00:00
[haddock @ 2002-07-15 09:54:16 by simonmar]
merge rev. 1.35

- - - - -
bd7eb8c4 by Simon Marlow at 2002-07-15T10:14:31+00:00
[haddock @ 2002-07-15 10:14:30 by simonmar]
Be a bit more liberal in the kind of commenting styles we allow, as
suggested by Malcolm Wallace.  Mostly this consists of allowing doc
comments either side of a separator token.

In an export list, a section heading is now allowed before the comma,
as well as after it.  eg.

 	module M where (
	    T(..)
	  -- * a section heading
	  , f
	  -- * another section heading
	  , g
        )

In record fields, doc comments are allowed anywhere (previously a
doc-next was allowed only after the comma, and a doc-before was
allowed only before the comma).  eg.

	data R = C {
		-- | describes 'f'
		  f :: Int
		-- | describes 'g'
		, g :: Int
		}

- - - - -
8f6dfe34 by Simon Marlow at 2002-07-15T10:21:56+00:00
[haddock @ 2002-07-15 10:21:56 by simonmar]
Mention alternative commenting styles.

- - - - -
fc515bb7 by Simon Marlow at 2002-07-15T16:16:50+00:00
[haddock @ 2002-07-15 16:16:50 by simonmar]
Allow multiple sections/subsections before and after a comma in the
export list.

Also at the same time I made the syntax a little stricter (multiple
commas now aren't allowed between export specs).

- - - - -
80a97e74 by Simon Marlow at 2002-07-19T09:13:10+00:00
[haddock @ 2002-07-19 09:13:10 by simonmar]
Allow special id's ([], (), etc.) to be used in an import declaration.

- - - - -
a69d7378 by Simon Marlow at 2002-07-19T09:59:02+00:00
[haddock @ 2002-07-19 09:59:02 by simonmar]
Allow special id's ([], (), etc.) to be used in an import declarations.

- - - - -
d205fa60 by Simon Marlow at 2002-07-19T10:00:16+00:00
[haddock @ 2002-07-19 10:00:16 by simonmar]
Relax the restrictions which require doc comments to be followed by
semi colons - in some cases this isn't necessary.  Now you can write

	module M where {
 	  -- | some doc
	  class C where {}
 	}

without needing to put a semicolon before the class declaration.

- - - - -
e9301e14 by Simon Marlow at 2002-07-23T08:24:09+00:00
[haddock @ 2002-07-23 08:24:09 by simonmar]
A new TODO list item

- - - - -
e5d77586 by Simon Marlow at 2002-07-23T08:40:56+00:00
[haddock @ 2002-07-23 08:40:56 by simonmar]
- update the acknowledgements

- remove the paragraph that described how to use explicit layout with
  doc comments; it isn't relevant any more.

- - - - -
78a94137 by Simon Marlow at 2002-07-23T08:43:02+00:00
[haddock @ 2002-07-23 08:43:02 by simonmar]
more tests

- - - - -
5c320927 by Simon Marlow at 2002-07-23T08:43:26+00:00
[haddock @ 2002-07-23 08:43:26 by simonmar]
Updates for version 0.4

- - - - -
488e99ae by Simon Marlow at 2002-07-23T09:10:46+00:00
[haddock @ 2002-07-23 09:10:46 by simonmar]
Fix the %changelog (rpm complained that it wasn't in the right order)

- - - - -
a77bb373 by Simon Marlow at 2002-07-23T09:12:38+00:00
[haddock @ 2002-07-23 09:12:38 by simonmar]
Another item for the TODO list

- - - - -
f1ec1813 by Simon Marlow at 2002-07-23T10:18:46+00:00
[haddock @ 2002-07-23 10:18:46 by simonmar]
Add a version banner when invoked with -v

- - - - -
1d44cadf by Simon Marlow at 2002-07-24T09:28:19+00:00
[haddock @ 2002-07-24 09:28:19 by simonmar]
Remove ^Ms

- - - - -
4d8d5e94 by Simon Marlow at 2002-07-24T09:42:18+00:00
[haddock @ 2002-07-24 09:42:17 by simonmar]
Patches to quieten ghc -Wall, from those nice folks at Galois.

- - - - -
d6edc43e by Simon Marlow at 2002-07-25T14:37:29+00:00
[haddock @ 2002-07-25 14:37:28 by simonmar]
Patch to allow simple hyperlinking to an arbitrary location in another
module's documentation, from Volker Stolz.

Now in a doc comment:

  #foo#

creates

  <a name="foo"></a>

And you can use the form "M\#foo" to hyperlink to the label 'foo' in
module 'M'.  Note that the backslash is necessary for now.

- - - - -
b34d18fa by Simon Marlow at 2002-08-02T09:08:22+00:00
[haddock @ 2002-08-02 09:08:22 by simonmar]
The <TT> and <PRE> environments seem to use a font that is a little
too small in IE.  Compensate.

(suggestion from Daan Leijen).

- - - - -
8106b086 by Simon Marlow at 2002-08-02T09:25:23+00:00
[haddock @ 2002-08-02 09:25:20 by simonmar]
Remove <P>..</P> from around list items, to reduce excess whitespace
between the items of bulleted and ordered lists.

(Suggestion from Daan Leijen).

- - - - -
c1acff8f by Simon Marlow at 2002-08-05T09:03:49+00:00
[haddock @ 2002-08-05 09:03:49 by simonmar]
update

- - - - -
f968661c by Simon Marlow at 2002-11-11T09:32:57+00:00
[haddock @ 2002-11-11 09:32:57 by simonmar]
Fix cut-n-pasto

- - - - -
12d02619 by Simon Marlow at 2002-11-13T09:49:46+00:00
[haddock @ 2002-11-13 09:49:46 by simonmar]
Small bugfix in the --read-interface option parsing from Brett Letner.

- - - - -
30e32d5e by Ross Paterson at 2003-01-16T15:07:57+00:00
[haddock @ 2003-01-16 15:07:57 by ross]
Adjust for the new exception libraries (as well as the old ones).

- - - - -
871f65df by Sven Panne at 2003-02-20T21:31:40+00:00
[haddock @ 2003-02-20 21:31:40 by panne]
* Add varsyms and consyms to index
* Exclude empty entries from index

- - - - -
bc42cc87 by Sven Panne at 2003-02-24T21:26:29+00:00
[haddock @ 2003-02-24 21:26:29 by panne]
Don't convert a "newtype" to a single-constructor "data" for
non-abstractly exported types, they are quite different regarding
strictness/pattern matching. Now a "data" without any constructors is
only emitted for an abstractly exported type, regardless if it is
actually a "newtype" or a "data".

- - - - -
0c2a1d99 by Sven Panne at 2003-03-08T19:02:38+00:00
[haddock @ 2003-03-08 19:02:38 by panne]
Fixed some broken/redirected/canonicalized links found by a very picky
link checker.

- - - - -
25459269 by Sven Panne at 2003-03-09T21:13:43+00:00
[haddock @ 2003-03-09 21:13:43 by panne]
Don't append a fragment to non-defining index entries, only documents
with a defining occurrence have a name anchor.

- - - - -
6be4db86 by Sven Panne at 2003-03-10T21:34:25+00:00
[haddock @ 2003-03-10 21:34:24 by panne]
Escape fragments. This fixes e.g. links to operators.

- - - - -
eb12972c by Ross Paterson at 2003-04-25T10:50:06+00:00
[haddock @ 2003-04-25 10:50:05 by ross]
An 80% solution to generating derived instances.  A complete solution
would duplicate the instance inference logic, but if a type variable
occurs as a constructor argument, then we can just propagate the derived
class to the variable.  But we know nothing of the constraints on any
type variables that occur elsewhere.  For example, the declarations

	data Either a b = Left a | Right b deriving (Eq, Ord)
	data Ptr a = Ptr Addr# deriving (Eq, Ord)
	newtype IORef a = IORef (STRef RealWorld a) deriving Eq

yield the instances

	(Eq a, Eq b) => Eq (Either a b)
	(Ord a, Ord b) => Ord (Either a b)
	Eq (Ptr a)
	Ord (Ptr a)
	(??? a) => Eq (IORef a)

The last example shows the limits of this local analysis.
Note that a type variable may be in both categories: then we know a
constraint, but there may be more, or a stronger constraint, e.g.

	data Tree a = Node a [Tree a] deriving Eq
yields
	(Eq a, ??? a) => Eq (Tree a)

- - - - -
de886f78 by Simon Marlow at 2003-04-25T11:17:55+00:00
[haddock @ 2003-04-25 11:17:55 by simonmar]
Some updates, including moving the derived instance item down to the
bottom of the list now that Ross has contributed some code that does
the job for common cases.

- - - - -
1b52cffd by Simon Marlow at 2003-04-30T14:02:32+00:00
[haddock @ 2003-04-30 14:02:32 by simonmar]
When installing on Windows, run cygpath over $(HADDOCKLIB) so that
haddock (a mingw program, built by GHC) can understand it.

You still need to be in a cygwin environment to run Haddock, because
of the shell script wrapper.

- - - - -
d4f638de by Simon Marlow at 2003-05-06T10:04:47+00:00
[haddock @ 2003-05-06 10:04:47 by simonmar]
Catch another case of a paragraph containing just a DocMonospaced that
should turn into a DocCodeBlock.

- - - - -
4162b2b9 by Simon Marlow at 2003-05-06T10:11:44+00:00
[haddock @ 2003-05-06 10:11:44 by simonmar]
Add some more code-block tests.

- - - - -
4f5802c8 by Simon Marlow at 2003-05-06T10:14:52+00:00
[haddock @ 2003-05-06 10:14:52 by simonmar]
Don't turn a single DocCodeBlock into a DocMonospaced, because that
tends to remove the line breaks in the code.

- - - - -
ef8c45f7 by Simon Marlow at 2003-05-21T15:07:21+00:00
[haddock @ 2003-05-21 15:07:21 by simonmar]
Only omit the module contents when there are no section headings at all.

- - - - -
bcee1e75 by Sigbjorn Finne at 2003-05-30T16:50:45+00:00
[haddock @ 2003-05-30 16:50:45 by sof]
cygpath: for now, steer clear of --mixed

- - - - -
30567af3 by Sigbjorn Finne at 2003-05-30T17:59:28+00:00
[haddock @ 2003-05-30 17:59:28 by sof]
oops, drop test defn from prev commit

- - - - -
b0856e7d by Simon Marlow at 2003-06-03T09:55:26+00:00
[haddock @ 2003-06-03 09:55:26 by simonmar]
Two small fixes to make the output valid HTML 4.01 (transitional).

Thanks to Malcolm Wallace for pointing out the problems.

- - - - -
70e137ea by Simon Marlow at 2003-07-28T13:30:35+00:00
[haddock @ 2003-07-28 13:30:35 by simonmar]
Add tests for a couple of bugs.

- - - - -
122bd578 by Simon Marlow at 2003-07-28T13:31:25+00:00
[haddock @ 2003-07-28 13:31:25 by simonmar]
Add documentation for anchors.

- - - - -
0bd27cb2 by Simon Marlow at 2003-07-28T13:31:46+00:00
[haddock @ 2003-07-28 13:31:46 by simonmar]
Update

- - - - -
08052d42 by Simon Marlow at 2003-07-28T13:32:12+00:00
[haddock @ 2003-07-28 13:32:12 by simonmar]
layout tweak.

- - - - -
13942749 by Simon Marlow at 2003-07-28T13:33:03+00:00
[haddock @ 2003-07-28 13:33:03 by simonmar]
Differentiate links to types/classes from links to
variables/constructors with a prefix ("t:" and "v:" respectively).

- - - - -
d7f493b9 by Simon Marlow at 2003-07-28T13:35:17+00:00
[haddock @ 2003-07-28 13:35:16 by simonmar]
When a module A exports another module's contents via 'module B', then
modules which import entities from B re-exported by A should link to
B.foo rather than A.foo.  See examples/Bug2.hs.

- - - - -
d94cf705 by Simon Marlow at 2003-07-28T13:36:14+00:00
[haddock @ 2003-07-28 13:36:14 by simonmar]
Update to version 0.5

- - - - -
dbb776cd by Sven Panne at 2003-07-28T14:02:43+00:00
[haddock @ 2003-07-28 14:02:43 by panne]
* Updated to version 0.5
* Automagically generate configure if it is not there

- - - - -
6cfeee53 by Simon Marlow at 2003-07-28T14:32:43+00:00
[haddock @ 2003-07-28 14:32:42 by simonmar]
Update to avoid using hslibs with GHC >= 5.04

- - - - -
a1ce838f by Simon Marlow at 2003-07-28T14:33:37+00:00
[haddock @ 2003-07-28 14:33:37 by simonmar]
Update for 0.5

- - - - -
c0fe6493 by Simon Marlow at 2003-07-28T14:53:22+00:00
[haddock @ 2003-07-28 14:53:22 by simonmar]
Markup fix

- - - - -
6ea31596 by Sven Panne at 2003-07-28T16:40:45+00:00
[haddock @ 2003-07-28 16:40:45 by panne]
Make it compile with GHC >= 6.01

- - - - -
afcd30fc by Simon Marlow at 2003-07-30T15:04:52+00:00
[haddock @ 2003-07-30 15:04:52 by simonmar]
Pay attention to import specs when building the the import env, as
well as the orig env.  This may fix some wrong links in documentation
when import specs are being used.

- - - - -
17c3137f by Simon Marlow at 2003-07-30T16:05:41+00:00
[haddock @ 2003-07-30 16:05:40 by simonmar]
Rename instances based on the import_env for the module in which they
are to be displayed.  This should give, in many cases, better links
for the types and classes mentioned in the instance head.

This involves keeping around the import_env in the iface until the
end, because instances are not collected up until all the modules have
been processed.  Fortunately it doesn't seem to affect performance
much.

Instance heads are now attached to ExportDecls, rather than the HTML
backend passing around a separate mapping for instances.  This is a
cleanup.

- - - - -
3d3b5c87 by Sven Panne at 2003-08-04T10:18:24+00:00
[haddock @ 2003-08-04 10:18:24 by panne]
Don't print parentheses around one-element contexts

- - - - -
9e3f3f2d by Simon Marlow at 2003-08-04T12:59:47+00:00
[haddock @ 2003-08-04 12:59:47 by simonmar]
A couple of TODOs.

- - - - -
e9d8085c by Simon Marlow at 2003-08-05T14:10:31+00:00
[haddock @ 2003-08-05 14:10:31 by simonmar]
I'm not sure why, but it seems that the index entries for non-defining
occurrences of entities did not have an anchor - the link just pointed
to the module.  This fixes it.

- - - - -
ff5c7d6d by Simon Marlow at 2003-08-15T14:42:59+00:00
[haddock @ 2003-08-15 14:42:59 by simonmar]
Convert the lexer to Alex, and fix a bug in the process.

- - - - -
1aa077bf by Simon Marlow at 2003-08-15T15:00:18+00:00
[haddock @ 2003-08-15 15:00:18 by simonmar]
Update

- - - - -
d3de1e38 by Simon Marlow at 2003-08-15T15:01:03+00:00
[haddock @ 2003-08-15 15:01:03 by simonmar]
wibbles

- - - - -
b40ece3b by Simon Marlow at 2003-08-18T10:04:47+00:00
[haddock @ 2003-08-18 10:04:47 by simonmar]
Lex the 'mdo' keyword as 'do'.

- - - - -
8f9a1146 by Simon Marlow at 2003-08-18T11:48:24+00:00
[haddock @ 2003-08-18 11:48:24 by simonmar]
Two bugs from Sven.

- - - - -
ea54ebc0 by Simon Marlow at 2003-08-18T11:48:46+00:00
[haddock @ 2003-08-18 11:48:46 by simonmar]
Fixes to the new lexer.

- - - - -
d5f6a4b5 by Simon Marlow at 2003-08-19T09:09:03+00:00
[haddock @ 2003-08-19 09:09:03 by simonmar]
Further wibbles to the syntax.

- - - - -
6bbdadb7 by Sven Panne at 2003-08-26T18:45:35+00:00
[haddock @ 2003-08-26 18:45:35 by panne]
Use autoreconf instead of autoconf

- - - - -
32e889cb by Sven Panne at 2003-08-26T19:01:19+00:00
[haddock @ 2003-08-26 19:01:18 by panne]
Made option handling a bit more consistent with other tools, in
particular: Every program in fptools should output
   * version info on stdout and terminate successfully when -V or --version
   * usage info on stdout and terminate successfully when -? or --help
   * usage info on stderr and terminate unsuccessfully when an unknown option
is given.

- - - - -
5d156a91 by Sven Panne at 2003-08-26T19:20:55+00:00
[haddock @ 2003-08-26 19:20:55 by panne]
Make it *very* clear that we terminate when given a -V/--version flag

- - - - -
e6577265 by Sven Panne at 2003-08-27T07:50:03+00:00
[haddock @ 2003-08-27 07:50:02 by panne]
* Made -D a short option for --dump-interface.
* Made -m a short option for --ms-help.
* Made -n a short option for --no-implicit-prelude.
* Made -c a short option for --css.
* Removed DocBook options from executable (they didn't do anything),
  but mark them as reserved in the docs. Note that the short option
  for DocBook output is now -S (from SGML) instead of -d. The latter
  is now a short option for --debug.
* The order of the Options in the documentation now matches the order
  printed by Haddock itself.

Note: Although changing the names of options is often a bad idea, I'd
really like to make the options for the programs in fptools more
consistent and compatible to the ones used in common GNU programs.

- - - - -
d303ff98 by Simon Marlow at 2003-09-10T08:23:48+00:00
[haddock @ 2003-09-10 08:23:48 by simonmar]
Add doc subdir.

Patch contributed by: Ian Lynagh <igloo at earth.li>.

- - - - -
9a70e46a by Simon Marlow at 2003-09-10T08:24:32+00:00
[haddock @ 2003-09-10 08:24:32 by simonmar]
Install these files in $(datadir), not $(libdir), since they're
architecture independent.

Patch contributed by: Ian Lynagh <igloo at earth.li>.

- - - - -
bbb87e7a by Simon Marlow at 2003-09-10T08:25:31+00:00
[haddock @ 2003-09-10 08:25:31 by simonmar]
Haddock's supplementary HTML bits now live in $(datadir), not
$(libdir).

Patch contributed by: Ian Lynagh <igloo at earth.li>.

- - - - -
3587c24b by Simon Marlow at 2003-09-22T10:34:38+00:00
[haddock @ 2003-09-22 10:34:38 by simonmar]
Allow installing of docs.

- - - - -
d510b517 by Sven Panne at 2003-10-11T08:10:44+00:00
[haddock @ 2003-10-11 08:10:44 by panne]
Include architecture-independent files in file list

- - - - -
187d7618 by Sigbjorn Finne at 2003-10-20T17:19:24+00:00
[haddock @ 2003-10-20 17:19:22 by sof]
support for i-parameters + zip comprehensions

- - - - -
b6c7a273 by Simon Marlow at 2003-11-03T14:24:24+00:00
[haddock @ 2003-11-03 14:24:24 by simonmar]
Update TODO file.

- - - - -
58513e33 by Simon Marlow at 2003-11-05T11:22:04+00:00
[haddock @ 2003-11-05 11:22:04 by simonmar]
Remove the last of the uses of 'trace' to emit warnings, and tidy up a
couple of places where duplicate warnings were being emitted.

- - - - -
33a78846 by Simon Marlow at 2003-11-05T11:30:53+00:00
[haddock @ 2003-11-05 11:30:52 by simonmar]
- Suppress warnings about unknown imported modules by default.
- Add a -v/--verbose flag to re-enable these warnings.

The general idea is to suppress the "Warning: unknown module: Prelude"
warnings which most Haddock users will see every time, and which
aren't terribly useful.

- - - - -
a969de7f by Simon Marlow at 2003-11-05T12:30:28+00:00
[haddock @ 2003-11-05 12:30:28 by simonmar]
- Remove the emboldening of index entries for defining locations.
  This isn't useful, and breaks abstractions.

- If an entity is re-exported by a module but the module doesn't
  include documentation for that entity (perhaps because it is
  re-exported by 'module M'), then don't attempt to hyperlink to
  the documentation from the index.  Instead, just list that module
  in the index, to indicate that the entity is exported from there.

- - - - -
f14ea82a by Simon Marlow at 2003-11-05T15:15:59+00:00
[haddock @ 2003-11-05 15:15:59 by simonmar]
Index overhaul:

  - no more separate type/class and variable/function indices

  - the index now makes a distinction between different entities
    with the same name.  One example is a type constructor with
    the same name as a data constructor, but another example is
    simply a function with the same name exported by two different
    modules.  For example, the index entry for 'catch' now looks like
    this:

    catch
      1 (Function)	Control.Exception
      2 (Function)	GHC.Exception, Prelude, System.IO, System.IO.Error

    making it clear that there are two different 'catch'es, but one
    of them is exported by several modules.

  - Each index page now has the index contents (A B C ...) at the top.

Please let me know if you really hate any of this.

- - - - -
01a25ca6 by Simon Marlow at 2003-11-05T15:16:38+00:00
[haddock @ 2003-11-05 15:16:38 by simonmar]
Update

- - - - -
1a7ccb86 by Simon Marlow at 2003-11-05T17:16:05+00:00
[haddock @ 2003-11-05 17:16:04 by simonmar]
Support for generating a single unified index for several packages.

  --use-index=URL  turns off normal index generation, causes Index
 		   links to point to URL.

  --gen-index      generates an combined index from the specified
                   interfaces.

Currently doesn't work exactly right, because the interfaces don't
contain the iface_reexported info.  I'll need to fix that up.

- - - - -
a2bca16d by Simon Marlow at 2003-11-06T10:44:52+00:00
[haddock @ 2003-11-06 10:44:52 by simonmar]
Include iface_reexported in the .haddock file.  This unfortunately
bloats the file (40% for base).  If this gets to be a problem we can
always apply the dictionary trick that GHC uses for squashing .hi
files.

- - - - -
0a09c293 by Simon Marlow at 2003-11-06T12:39:47+00:00
[haddock @ 2003-11-06 12:39:46 by simonmar]
- Add definition lists, marked up like this:

	-- | This is a definition list:
	--
	--   [@foo@] The description of @foo at .
	--
	--   [@bar@] The description of @bar at .

  Cunningly, the [] characters are not treated specially unless a [ is
  found at the beginning of a paragraph, in which case the ] becomes
  special in the following text.


- Add --use-contents and --gen-contents, along the lines of
  --use-index and --gen-index added yesterday.  Now we can generate a
  combined index and contents for the whole of the hierarchical
  libraries, and in theory the index/contents on the system could
  be updated as new packages are added.

- - - - -
fe1b3460 by Simon Marlow at 2003-11-06T14:47:36+00:00
[haddock @ 2003-11-06 14:47:36 by simonmar]
Remove the 'Parent' button - it is of dubious use, and often points
into thin air.

- - - - -
db6d762f by Simon Marlow at 2003-11-06T16:48:14+00:00
[haddock @ 2003-11-06 16:48:11 by simonmar]
- Include the OptHide setting in the interface, so we don't include
  hidden modules in the combined index/contents.

- Add a -k/--package flag to set the package name for the current set
  of modules.  The package name for each module is now shown in the
  right-hand column of the contents, in a combined contents page.

- - - - -
7d71718b by Simon Marlow at 2003-11-06T16:50:28+00:00
[haddock @ 2003-11-06 16:50:28 by simonmar]
Add -k/--package docs

- - - - -
ef43949d by Simon Marlow at 2003-11-06T16:51:23+00:00
[haddock @ 2003-11-06 16:51:23 by simonmar]
Bump to 0.6

- - - - -
1c419e06 by Simon Marlow at 2003-11-06T16:51:50+00:00
[haddock @ 2003-11-06 16:51:50 by simonmar]
update

- - - - -
69422327 by Simon Marlow at 2003-11-10T14:41:06+00:00
[haddock @ 2003-11-10 14:41:05 by simonmar]
Re-exporting names from a different package is problematic, because we
don't have access to the full documentation for the entity.  Currently
Haddock just ignores entities with no documentation, but this results
in bogus-looking empty documentation for many of the modules in the
haskell98 package.  So:

  - the documentation will now just list the name, as a link
    pointing to the location of the actual documentation.

  - now we don't attempt to link to these re-exported entities if
    they are referred to by the current module.

Additionally:

  - If there is no documentation in the current module, include
    just the Synopsis section (rather than just the documentation
    section, as it was before).  This just looks nicer and was on
    the TODO list.

- - - - -
3c3fc433 by Simon Marlow at 2003-11-10T14:51:59+00:00
[haddock @ 2003-11-10 14:51:59 by simonmar]
Fix for getReExports: take into account names which are not visible
because they are re-exported from a different package.

- - - - -
31c8437b by Simon Marlow at 2003-11-10T15:10:53+00:00
[haddock @ 2003-11-10 15:10:53 by simonmar]
Version 0.6 changes

- - - - -
a7c2430b by Simon Marlow at 2003-11-10T15:15:58+00:00
[haddock @ 2003-11-10 15:15:58 by simonmar]
getReExports: one error case that isn't

- - - - -
00cc459c by Simon Marlow at 2003-11-10T16:15:19+00:00
[haddock @ 2003-11-10 16:15:18 by simonmar]
copyright update

- - - - -
ca62408d by Simon Marlow at 2003-11-11T09:57:25+00:00
[haddock @ 2003-11-11 09:57:25 by simonmar]
Version 0.6

- - - - -
3acbf818 by Simon Marlow at 2003-11-11T12:10:44+00:00
[haddock @ 2003-11-11 12:10:44 by simonmar]
Go back to producing just the documentation section, rather than just
the synopsis section, for a module with no documentation annotations.

One reason is that the synopsis section tries to link each entity to
its documentation on the same page.  Also, the doc section anchors
each entity, and it lists instances which the synopsis doesn't.

- - - - -
6c90abc2 by Simon Marlow at 2003-11-12T10:03:39+00:00
[haddock @ 2003-11-12 10:03:39 by simonmar]
2002 -> 2003

- - - - -
090bbc4c by Simon Marlow at 2003-11-28T12:08:00+00:00
[haddock @ 2003-11-28 12:08:00 by simonmar]
update

- - - - -
8096a832 by Simon Marlow at 2003-11-28T12:09:58+00:00
[haddock @ 2003-11-28 12:09:58 by simonmar]
Fix some of the problems with Haddock generating pages that are too
wide.  Now we only specify 'nowrap' when it is necessary to avoid a
code box getting squashed up by the text to the right of it.

- - - - -
35294929 by Sven Panne at 2003-12-29T17:16:31+00:00
[haddock @ 2003-12-29 17:16:31 by panne]
Updated my email address

- - - - -
cdb697bf by Simon Marlow at 2004-01-08T10:14:24+00:00
[haddock @ 2004-01-08 10:14:24 by simonmar]
Add instructions for using GHC to pre-process source for feeding to Haddock.

- - - - -
8dfc491f by Simon Marlow at 2004-01-09T12:45:46+00:00
[haddock @ 2004-01-09 12:45:46 by simonmar]
Add -optP-P to example ghc command line.

- - - - -
ac41b820 by Simon Marlow at 2004-02-03T11:02:03+00:00
[haddock @ 2004-02-03 11:02:03 by simonmar]
Fix bug in index generation

- - - - -
f4e7edcb by Simon Marlow at 2004-02-10T11:51:16+00:00
[haddock @ 2004-02-10 11:51:16 by simonmar]
Don't throw away whitespace at the beginning of a line (experimental fix).

- - - - -
68e212d2 by Simon Marlow at 2004-02-10T12:10:08+00:00
[haddock @ 2004-02-10 12:10:08 by simonmar]
Fix for previous commit: I now realise why the whitespace was stripped
from the beginning of the line.  Work around it.

- - - - -
e7d7f2df by Sven Panne at 2004-02-10T18:38:45+00:00
[haddock @ 2004-02-10 18:38:45 by panne]
Make Haddock link with the latest relocated monad transformer package

- - - - -
992d4225 by Simon Marlow at 2004-02-16T10:21:35+00:00
[haddock @ 2004-02-16 10:21:35 by simonmar]
Add a TODO

- - - - -
1ac55326 by Simon Marlow at 2004-03-12T11:33:39+00:00
[haddock @ 2004-03-12 11:33:39 by simonmar]
Add an item.

- - - - -
0478e903 by Simon Marlow at 2004-03-15T12:24:05+00:00
[haddock @ 2004-03-15 12:24:05 by simonmar]
Add an item.

- - - - -
6f26d21a by Simon Marlow at 2004-03-18T14:21:29+00:00
[haddock @ 2004-03-18 14:21:29 by simonmar]
Fix URL

- - - - -
19b6bb99 by Simon Marlow at 2004-03-22T14:09:03+00:00
[haddock @ 2004-03-22 14:09:03 by simonmar]
getReExports was bogus: we should really look in the import_env to
find the documentation for an entity which we are re-exporting without
documentation.

Suggested by: Ross Paterson (patch modified by me).

- - - - -
5c756031 by Simon Marlow at 2004-03-24T09:42:11+00:00
[haddock @ 2004-03-24 09:42:10 by simonmar]
hiding bug from Ross Paterson (fixed in rev 1.59 of Main.hs)

- - - - -
1b692e6c by Simon Marlow at 2004-03-24T10:10:50+00:00
[haddock @ 2004-03-24 10:10:50 by simonmar]
mkExportItems fix & simplification: we should be looking at the actual
exported names (calculated earlier) to figure out which subordinates
of a declaration are exported.

This means that if you export a record, and name its fields separately
in the export list, the fields will still be visible in the
documentation for the constructor.

- - - - -
90e5e294 by Simon Marlow at 2004-03-24T10:12:08+00:00
[haddock @ 2004-03-24 10:12:08 by simonmar]
Make restrictCons take into account record field names too (removing a ToDo).

- - - - -
2600efa4 by Simon Marlow at 2004-03-24T10:16:17+00:00
[haddock @ 2004-03-24 10:16:17 by simonmar]
Record export tests.

- - - - -
6a8575c7 by Simon Marlow at 2004-03-25T09:35:14+00:00
[haddock @ 2004-03-25 09:35:14 by simonmar]
restrictTo: fix for restricting a newtype with a record field.

- - - - -
dcf55a8d by Simon Marlow at 2004-03-25T10:01:42+00:00
[haddock @ 2004-03-25 10:01:42 by simonmar]
Fix duplicate instance bug

- - - - -
f49aa758 by Simon Marlow at 2004-03-25T10:02:41+00:00
[haddock @ 2004-03-25 10:02:41 by simonmar]
Duplicate instance bug.

- - - - -
7b87344c by Simon Marlow at 2004-03-25T10:29:56+00:00
[haddock @ 2004-03-25 10:29:56 by simonmar]
If a name is imported from two places, one hidden and one not, choose
the unhidden one to link to.  Also, when there's only a hidden module
to link to, don't try linking to it.

- - - - -
40f44d7b by Simon Marlow at 2004-03-25T15:17:24+00:00
[haddock @ 2004-03-25 15:17:23 by simonmar]
Add support for collaspible parts of the page, with a +/- button and a
bit of JavaScript.  Make the instances collapsible, and collapse them
by default.

This makes documentation with long lists of instances (eg. the
Prelude) much easier to read.  Maybe we should give other
documentation sections the same treatment.

- - - - -
9b64dc0f by Simon Marlow at 2004-03-25T15:20:55+00:00
[haddock @ 2004-03-25 15:20:55 by simonmar]
Update

- - - - -
c2fff7f2 by Simon Marlow at 2004-03-25T15:45:10+00:00
[haddock @ 2004-03-25 15:45:10 by simonmar]
Eliminate some unnecessary spaces in the HTML rendering

- - - - -
b7948ff0 by Simon Marlow at 2004-03-25T16:00:37+00:00
[haddock @ 2004-03-25 16:00:36 by simonmar]
Remove all that indentation in the generated HTML to keep the file sizes down.

- - - - -
da2bb4ca by Sven Panne at 2004-03-27T09:57:58+00:00
[haddock @ 2004-03-27 09:57:57 by panne]
Added the new-born haddock.js to the build process and the documentation.

- - - - -
b99e6f8c by Sven Panne at 2004-03-27T10:32:20+00:00
[haddock @ 2004-03-27 10:32:20 by panne]
"type" is a required attribute of the "script" element

- - - - -
562b185a by Sven Panne at 2004-03-27T12:52:34+00:00
[haddock @ 2004-03-27 12:52:34 by panne]
Add a doctype for the contents page, too.

- - - - -
f6a99c2d by Simon Marlow at 2004-04-14T10:03:25+00:00
[haddock @ 2004-04-14 10:03:25 by simonmar]
fix for single-line comment syntax

- - - - -
de366303 by Simon Marlow at 2004-04-20T13:08:04+00:00
[haddock @ 2004-04-20 13:08:04 by simonmar]
Allow a 'type' declaration to include documentation comments.  These
will be ignored by Haddock, but at least one user (Johannes Waldmann)
finds this feature useful, and it's easy to add.

- - - - -
fd78f51e by Simon Marlow at 2004-05-07T15:14:56+00:00
[haddock @ 2004-05-07 15:14:56 by simonmar]
- update copyright
- add version to abstract

- - - - -
59f53e32 by Sven Panne at 2004-05-09T14:39:53+00:00
[haddock @ 2004-05-09 14:39:53 by panne]
Fix the fix for single-line comment syntax,
-------------------------------------------
is now a valid comment line again.

- - - - -
8b18f2fe by Simon Marlow at 2004-05-10T10:11:51+00:00
[haddock @ 2004-05-10 10:11:51 by simonmar]
Update

- - - - -
225a491d by Ross Paterson at 2004-05-19T13:10:23+00:00
[haddock @ 2004-05-19 13:10:23 by ross]
Make the handling of "deriving" slightly smarter, by ignoring data constructor
arguments that are identical to the lhs.  Now handles things like

data Tree a = Leaf a | Branch (Tree a) (Tree a) deriving ...

- - - - -
37588686 by Mike Thomas at 2004-05-21T06:38:14+00:00
[haddock @ 2004-05-21 06:38:14 by mthomas]
Windows exe extensions (bin remains for Unix).

- - - - -
cf2b9152 by Simon Marlow at 2004-05-25T09:34:54+00:00
[haddock @ 2004-05-25 09:34:54 by simonmar]
Add some TODO items

- - - - -
4d29cdfc by Simon Marlow at 2004-05-25T10:41:46+00:00
[haddock @ 2004-05-25 10:41:46 by simonmar]
Complain if -h is used with --gen-index or --gen-contents, because
it'll overwrite the new index/contents.

- - - - -
2e0771e0 by Mike Thomas at 2004-05-28T20:17:55+00:00
[haddock @ 2004-05-28 20:17:55 by mthomas]
Windows: search for templates in executable directory. Unix: Haddock tries cwd first rather than error if no -l arg.

- - - - -
8d10bde1 by Sven Panne at 2004-06-05T16:53:34+00:00
[haddock @ 2004-06-05 16:53:34 by panne]
Misc. rpm spec file cleanup, including:
* make BuildRoot handling more consistent
* added default file attributes
* consistent defines and tags

- - - - -
59974349 by Sven Panne at 2004-06-05T18:01:00+00:00
[haddock @ 2004-06-05 18:01:00 by panne]
More rpm spec file cleanup, including:
* added some BuildRequires
* changed packager to me, so people can complain at the right place :-]
* consistently refer to haskell.org instead of www.haskell.org

- - - - -
b94d4903 by Simon Marlow at 2004-07-01T11:08:58+00:00
[haddock @ 2004-07-01 11:08:57 by simonmar]
Update to the +/- buttons: use a resized image rather than a <button>.
Still seeing some strange effects in Konqueror, so might need to use a
fixed-size image instead.

- - - - -
d5278f67 by Sven Panne at 2004-07-04T15:15:55+00:00
[haddock @ 2004-07-04 15:15:55 by panne]
Install pictures for +/- pictures, too (JPEG is a strange format for graphics
like this, I would have expected GIF or PNG here.)

Things look fine with Konqueror and Netscape on Linux now, the only downside is
that the cursor doesn't change when positioned above the "button".

- - - - -
46dec6c5 by Sven Panne at 2004-07-13T17:59:28+00:00
[haddock @ 2004-07-13 17:59:28 by panne]
A quote is a valid part of a Haskell identifier, but it would interfere with an
ECMA script string delimiter, so escape it there.

- - - - -
1d7bc432 by Simon Marlow at 2004-07-22T08:54:06+00:00
[haddock @ 2004-07-22 08:54:06 by simonmar]
Add single quote to $ident, so you can say eg. 'foldl'' to refer to
foldl' (the longest match rule is our friend).

Bug reported by Adrian Hey <ahey at iee.org>

- - - - -
f183618b by Krasimir Angelov at 2004-07-27T22:59:35+00:00
[haddock @ 2004-07-27 22:58:23 by krasimir]
Add basic support for Microsoft HTML Help 2.0

- - - - -
d515d0c2 by Krasimir Angelov at 2004-07-27T23:02:36+00:00
[haddock @ 2004-07-27 23:02:36 by krasimir]
escape names in the index

- - - - -
a5f1be23 by Krasimir Angelov at 2004-07-27T23:05:21+00:00
[haddock @ 2004-07-27 23:05:21 by krasimir]
Add jsFile, plusFile and minusFile to the file list

- - - - -
c4fb4881 by Krasimir Angelov at 2004-07-28T22:12:10+00:00
[haddock @ 2004-07-28 22:12:09 by krasimir]
bugfix. Move contentsHtmlFile, indexHtmlFile and subIndexHtmlFile functions to
HaddockUtil.hs module to make them accessible from HaddockHH2.hs

- - - - -
64d30b1d by Krasimir Angelov at 2004-07-30T22:15:47+00:00
[haddock @ 2004-07-30 22:15:45 by krasimir]
more stuffs

  - support for separated compilation of packages
  - the contents page now uses DHTML TreeView
  - fixed copyFile bug

- - - - -
133c8c5c by Krasimir Angelov at 2004-07-31T12:04:38+00:00
[haddock @ 2004-07-31 12:04:37 by krasimir]
make the DHtmlTree in contents page more portable. The +/- buttons are replaced
with new images which looks more beatiful.

- - - - -
79040963 by Krasimir Angelov at 2004-07-31T13:10:20+00:00
[haddock @ 2004-07-31 13:10:20 by krasimir]
Make DHtmlTree compatible with Mozila browser

- - - - -
1a55dc90 by Krasimir Angelov at 2004-07-31T14:52:55+00:00
[haddock @ 2004-07-31 14:52:55 by krasimir]
fix

- - - - -
85ce0237 by Krasimir Angelov at 2004-07-31T14:53:28+00:00
[haddock @ 2004-07-31 14:53:28 by krasimir]
HtmlHelp 1.x

- - - - -
3c0c53ba by Krasimir Angelov at 2004-07-31T20:35:21+00:00
[haddock @ 2004-07-31 20:35:21 by krasimir]
Added support for DevHelp

- - - - -
d42b5af1 by Krasimir Angelov at 2004-07-31T21:17:51+00:00
[haddock @ 2004-07-31 21:17:51 by krasimir]
Document new features in HtmlHelp

- - - - -
790fe21e by Krasimir Angelov at 2004-08-01T15:14:02+00:00
[haddock @ 2004-08-01 15:14:02 by krasimir]
add missing imports

- - - - -
fd7cc6bc by Krasimir Angelov at 2004-08-01T19:52:08+00:00
[haddock @ 2004-08-01 19:52:06 by krasimir]
fix some bugs. Now I have got the entire libraries documentation in HtmlHelp 2.0 format.

- - - - -
94ad7ac8 by Krasimir Angelov at 2004-08-01T19:53:50+00:00
[haddock @ 2004-08-01 19:53:50 by krasimir]
I forgot to add the new +/- images

- - - - -
f0c65388 by Krasimir Angelov at 2004-08-02T16:25:53+00:00
[haddock @ 2004-08-02 16:25:53 by krasimir]
Add root node to the table of contents. All modules in tree are not children of
the root

- - - - -
f50bd85d by Sven Panne at 2004-08-02T18:17:46+00:00
[haddock @ 2004-08-02 18:17:46 by panne]
Mainly DocBook fixes

- - - - -
09527ce3 by Sven Panne at 2004-08-02T20:02:29+00:00
[haddock @ 2004-08-02 20:02:29 by panne]
Fixed -o/--odir handling. Generating the output, especially the
directory handling, is getting a bit convoluted nowadays...

- - - - -
c8fbacfa by Sven Panne at 2004-08-02T20:31:13+00:00
[haddock @ 2004-08-02 20:31:13 by panne]
Warning police

- - - - -
37830bff by Sven Panne at 2004-08-02T20:32:29+00:00
[haddock @ 2004-08-02 20:32:28 by panne]
Nuked dead code

- - - - -
13847171 by Sven Panne at 2004-08-02T21:12:27+00:00
[haddock @ 2004-08-02 21:12:25 by panne]
Use pathJoin instead of low-level list-based manipulation for FilePaths

- - - - -
c711d61e by Sven Panne at 2004-08-02T21:16:02+00:00
[haddock @ 2004-08-02 21:16:02 by panne]
Removed WinDoze CRs

- - - - -
b1f7dc88 by Sven Panne at 2004-08-03T19:35:59+00:00
[haddock @ 2004-08-03 19:35:59 by panne]
Fixed spelling of "http-equiv" attribute

- - - - -
dd5f394e by Sven Panne at 2004-08-03T19:44:03+00:00
[haddock @ 2004-08-03 19:44:03 by panne]
Pacify W3C validator:
* Added document encoding (currently UTF-8, not sure if this is completely correct)
* Fixed syntax of `id' attributes
* Added necessary `alt' attribute for +/- images

Small layout improvement:
* Added space after +/- images (still not perfect, but better than before)

- - - - -
919c47c6 by Sigbjorn Finne at 2004-08-03T19:45:11+00:00
[haddock @ 2004-08-03 19:45:11 by sof]
make it compile with <= ghc-6.1

- - - - -
4d6f01d8 by Sigbjorn Finne at 2004-08-03T19:45:30+00:00
[haddock @ 2004-08-03 19:45:30 by sof]
ffi wibble

- - - - -
4770643a by Sven Panne at 2004-08-03T20:47:46+00:00
[haddock @ 2004-08-03 20:47:46 by panne]
Fixed CSS for button style. Note that only "0" is a valid measure without a unit!

- - - - -
14aaf2e5 by Sven Panne at 2004-08-03T21:07:59+00:00
[haddock @ 2004-08-03 21:07:58 by panne]
Improved spacing of dynamic module tree

- - - - -
97c3579a by Simon Marlow at 2004-08-09T11:03:04+00:00
[haddock @ 2004-08-09 11:03:04 by simonmar]
Add FormatVersion

Patch submitted by: George Russell <ger at informatik.uni-bremen.de>

- - - - -
af7f8c03 by Simon Marlow at 2004-08-09T11:55:07+00:00
[haddock @ 2004-08-09 11:55:05 by simonmar]
Add support for a short description for each module, which is included
in the contents.

The short description should be given in a "Description: " field of
the header.  Included in this patch are changes that make the format
of the header a little more flexible.  From the comments:

-- all fields in the header are optional and have the form
--
-- [spaces1][field name][spaces] ":"
--    [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")*
-- where each [spaces2] should have [spaces1] as a prefix.
--
-- Thus for the key "Description",
--
-- > Description : this is a
-- >    rather long
-- >
-- >    description
-- >
-- > The module comment starts here
--
-- the value will be "this is a .. description" and the rest will begin
-- at "The module comment".

The header fields must be in the following order: Module, Description,
Copyright, License, Maintainer, Stability, Portability.

Patches submitted by: George Russell <ger at informatik.uni-bremen.de>,
with a few small changes be me, mostly to merge with other recent
changes.

ToDo: document the module header.

- - - - -
7b865ad3 by Simon Marlow at 2004-08-10T14:09:57+00:00
[haddock @ 2004-08-10 14:09:57 by simonmar]
Fixes for DevHelp/HtmlHelp following introduction of short module description.

- - - - -
814766cd by Simon Marlow at 2004-08-10T14:33:46+00:00
[haddock @ 2004-08-10 14:33:45 by simonmar]
Fixes to installation under Windows.

- - - - -
39cf9ede by Simon Marlow at 2004-08-12T12:08:23+00:00
[haddock @ 2004-08-12 12:08:23 by simonmar]
Avoid using string-gap tricks.

- - - - -
b6d78551 by Simon Marlow at 2004-08-13T10:53:21+00:00
[haddock @ 2004-08-13 10:53:21 by simonmar]
Update

- - - - -
eaae7417 by Simon Marlow at 2004-08-13T10:53:50+00:00
[haddock @ 2004-08-13 10:53:50 by simonmar]
Test for primes in quoted links

- - - - -
68c34f06 by Sven Panne at 2004-08-16T19:59:38+00:00
[haddock @ 2004-08-16 19:59:36 by panne]
XMLification

- - - - -
7f45a6f9 by Sven Panne at 2004-08-18T16:42:54+00:00
[haddock @ 2004-08-18 16:42:54 by panne]
Re-added indices + minor fixes

- - - - -
8a5dd97c by Sigbjorn Finne at 2004-08-25T17:15:42+00:00
[haddock @ 2004-08-25 17:15:42 by sof]
backquote HADDOCK_VERSION defn for <= ghc-6.0.x; believe this is only needed under mingw

- - - - -
4b1b42ea by Sven Panne at 2004-08-26T20:08:50+00:00
[haddock @ 2004-08-26 20:08:49 by panne]
SGML is dead, long live DocBook XML!

Note: The BuildRequires tags in the spec files are still incomplete
and the documentation about the DocBook tools needs to be updated,
too. Stay tuned...

- - - - -
8d52cedb by Sven Panne at 2004-08-26T21:03:19+00:00
[haddock @ 2004-08-26 21:03:19 by panne]
Updated BuildRequires tags. Alas, there seems to be no real standard here, so
your mileage may vary... At least the current specs should work on SuSE Linux.

- - - - -
e6982912 by Sigbjorn Finne at 2004-08-30T15:44:59+00:00
[haddock @ 2004-08-30 15:44:59 by sof]
escape HADDOCK_VERSION double quotes on all platforms when compiling with <=6.0.x

- - - - -
b3fbc867 by Simon Marlow at 2004-08-31T13:09:42+00:00
[haddock @ 2004-08-31 13:09:42 by simonmar]
Avoid GHC/shell versionitis and create Version.hs

- - - - -
c359e16a by Sven Panne at 2004-09-05T19:12:33+00:00
[haddock @ 2004-09-05 19:12:32 by panne]
* HTML documentation for "foo.xml" goes into directory "foo" again,
  not "foo-html". This is nicer and consistent with the behaviour for
  building the docs from SGML.

* Disabled building PostScript documentation in the spec files for
  now, there are some strange issues with the FO->PS conversion for
  some files which have to be clarified first.

- - - - -
c68b1eba by Sven Panne at 2004-09-24T07:04:38+00:00
[haddock @ 2004-09-24 07:04:38 by panne]
Switched the default state for instances and the module hierarchy to
non-collapsed. This can be reversed when we finally use cookies from
JavaScript to have a more persistent state. Previously going back and forth
in the documentation was simply too annoying because everything was
collapsed again and therefore the documentation was not easily navigatable.

- - - - -
dfb32615 by Simon Marlow at 2004-09-30T08:21:29+00:00
[haddock @ 2004-09-30 08:21:29 by simonmar]
Add a feature request

- - - - -
45ff783c by Sven Panne at 2004-10-23T19:54:00+00:00
[haddock @ 2004-10-23 19:54:00 by panne]
Improved the Cygwin/MinGW chaos a little bit. There is still confusion
about host platform vs. target platform...

- - - - -
5f644714 by Krasimir Angelov at 2004-10-28T16:01:51+00:00
[haddock @ 2004-10-28 16:01:51 by krasimir]
update for ghc-6.3+

- - - - -
92d9753e by Sven Panne at 2004-11-01T16:39:01+00:00
[haddock @ 2004-11-01 16:39:01 by panne]
Revert previous commit: It's Network.URI which should be changed, not Haddock.

- - - - -
05f70f6e by Simon Marlow at 2005-01-04T16:15:51+00:00
[haddock @ 2005-01-04 16:15:51 by simonmar]
parser fix: allow qualified specialids.

- - - - -
47870837 by Simon Marlow at 2005-01-04T16:16:54+00:00
[haddock @ 2005-01-04 16:16:54 by simonmar]
Add a test

- - - - -
ff11fc2c by Ross Paterson at 2005-01-10T19:18:22+00:00
[haddock @ 2005-01-10 19:18:22 by ross]
Render non-ASCII characters using numeric character references, to simplify
charset issues.  There's a META tag saying the charset is UTF-8, but GHC
outputs characters as raw bytes.

Ideally we need an encoding on the input side too, primarily in comments,
because source files containing non-ASCII characters aren't portable between
locales.

- - - - -
eba2fc4e by Simon Marlow at 2005-01-11T10:44:37+00:00
[haddock @ 2005-01-11 10:44:37 by simonmar]
Remove string gap

- - - - -
b899a381 by Ross Paterson at 2005-01-13T11:41:33+00:00
[haddock @ 2005-01-13 11:41:33 by ross]
recognize SGML-style numeric character references &#ddd; or &#xhhhh; and
translate them into Chars.

- - - - -
106e3cf0 by Ross Paterson at 2005-01-13T14:43:41+00:00
[haddock @ 2005-01-13 14:43:41 by ross]
also allow uppercase X in hexadecimal character references (like SGML)

- - - - -
e8f54f25 by Ross Paterson at 2005-01-13T14:44:24+00:00
[haddock @ 2005-01-13 14:44:24 by ross]
Describe numeric character references.

- - - - -
914ccdce by Sven Panne at 2005-01-15T18:44:48+00:00
[haddock @ 2005-01-15 18:44:45 by panne]
Make Haddock compile again after the recent base package changed. The Map/Set
legacy hell has been factored out, so that all modules can simply use the new
non-deprecated interfaces. Probably a lot of things can be improved by a little
bit of Map/Set/List algebra, this can be done later if needed.

Small note: Currently the list of instances in HTML code is reversed. This will
hopefully be fixed later.

- - - - -
6ab20e84 by Sven Panne at 2005-01-16T12:18:26+00:00
[haddock @ 2005-01-16 12:18:26 by panne]
Trim imports

- - - - -
efb81da9 by Sven Panne at 2005-01-16T12:58:08+00:00
[haddock @ 2005-01-16 12:58:03 by panne]
Correctly handle the new order of arguments for the combining function
given to fromListWith.

- - - - -
e27b5834 by Sven Panne at 2005-01-16T14:14:41+00:00
[haddock @ 2005-01-16 14:14:39 by panne]
Data.Map.unions is left-biased.

- - - - -
dae3cc3e by Sven Panne at 2005-01-16T14:22:44+00:00
[haddock @ 2005-01-16 14:22:44 by panne]
Added the last missing "flip" to get identical HTML output as previous versions.

- - - - -
951d8408 by Sven Panne at 2005-01-16T14:37:10+00:00
[haddock @ 2005-01-16 14:37:10 by panne]
Refactored Text.PrettyPrint legacy hell into a separate module.

- - - - -
f1c4b892 by Sven Panne at 2005-01-16T15:41:25+00:00
[haddock @ 2005-01-16 15:41:21 by panne]
Cleaned up imports and dropped support for GHC < 5.03, it never worked, anyway.

- - - - -
60824c6e by Simon Marlow at 2005-01-18T10:02:48+00:00
[haddock @ 2005-01-18 10:02:48 by simonmar]
Add a TODO

- - - - -
a8c82f23 by Krasimir Angelov at 2005-01-28T23:19:39+00:00
[haddock @ 2005-01-28 23:19:39 by krasimir]
import Foreign/Foreign.C are required for Windows

- - - - -
d8450a23 by Simon Marlow at 2005-02-02T16:23:04+00:00
[haddock @ 2005-02-02 16:23:00 by simonmar]
Revamp the linking strategy in Haddock.

Now name resolution is done in two phases:

 - first resolve everything to original names, like a Haskell compiler
   would.

 - then, figure out the "home" location for every entity, and point
   all the links to there.  The home location is the lowest non-hidden
   module in the import hierarchy that documents the entity.  If there
   are multiple candidates, one is chosen at random.

Also:

 - Haddock should not generate any HTML with dangling links any more.
   Unlinked references are just rendered as plain text.

 - Error reporting is better: if we can't find a link destination for
   an entity reference, we now emit a warning.

- - - - -
1cce71d0 by Simon Marlow at 2005-02-03T13:42:19+00:00
[haddock @ 2005-02-03 13:42:19 by simonmar]
- add --ignore-all-exports flag, which behaves as if every module
  has the ignore-exports attribute (requested by Chris Ryder).

- add --hide option to hide a module on the command line.

- add --use-package option to get Haddock info for a package from
  ghc-pkg (largely untested).

- remove reexports from the .haddock file, they aren't used any more.

- - - - -
767123ef by Ross Paterson at 2005-02-03T16:17:37+00:00
[haddock @ 2005-02-03 16:17:37 by ross]
fix typo for < 6.3

- - - - -
0c680c04 by Simon Marlow at 2005-02-04T12:03:31+00:00
[haddock @ 2005-02-04 12:03:31 by simonmar]
Fix bug in renameExportItems that meant links in instances weren't
being renamed properly.

- - - - -
ff7abe5f by Simon Marlow at 2005-02-04T12:15:53+00:00
[haddock @ 2005-02-04 12:15:52 by simonmar]
Add attribute #not-home, to indicate that the current module should
not be considered to be a home module for the each entity it exports,
unless there is no other module that exports the entity.

- - - - -
fc2cfd27 by Simon Marlow at 2005-02-04T12:40:02+00:00
[haddock @ 2005-02-04 12:40:02 by simonmar]
Update the documentation w.r.t. home modules and the not-home attribute.

- - - - -
26b8ddf7 by Ross Paterson at 2005-02-04T13:36:06+00:00
[haddock @ 2005-02-04 13:36:05 by ross]
sort lists of instances by
- arity of the type constructors (so higher-kinded instances come first)
- name of the class
- argument types

- - - - -
26bfb19c by Simon Marlow at 2005-02-23T15:57:12+00:00
[haddock @ 2005-02-23 15:57:12 by simonmar]
Fix documentation regarding the module attributes.

- - - - -
9c3afd02 by Simon Marlow at 2005-02-28T16:18:17+00:00
[haddock @ 2005-02-28 16:18:17 by simonmar]
version 0.7

- - - - -
a95fd63f by Simon Marlow at 2005-02-28T16:22:08+00:00
[haddock @ 2005-02-28 16:22:08 by simonmar]
Attempt to fix the layout of the package names in the contents.

Having tried just about everything, the only thing I can get to work
reliably is to make the package names line up on a fixed offset from
the left margin.  This obviously isn't ideal, so anyone else that
would like to have a go at improving it is welcome.  One option is to
remove the +/- buttons from the contents list and go back to a plain
table.

The contents page now uses CSS for layout rather than tables.  It
seems that most browsers have different interpretations of CSS layout,
so only the simplest things lead to consistent results.

- - - - -
905d42f7 by Simon Marlow at 2005-03-01T17:16:42+00:00
[haddock @ 2005-03-01 17:16:40 by simonmar]
Another attempt at lining up the package names on the contents page.
Now, they line up with Konqueror, and almost line up with Firefox & IE
(different layout in each case).

- - - - -
a0e1d178 by Wolfgang Thaller at 2005-03-09T08:28:39+00:00
[haddock @ 2005-03-09 08:28:39 by wolfgang]
Hack haddock's lexer to accept the output from Apple's broken version of
cpp (Apple's cpp leaves #pragma set_debug_pwd directives in it's output).

- - - - -
9e1eb784 by Simon Marlow at 2005-04-22T14:27:15+00:00
[haddock @ 2005-04-22 14:27:15 by simonmar]
Add a TODO item

- - - - -
23281f78 by Ross Paterson at 2005-05-18T12:41:59+00:00
[haddock @ 2005-05-18 12:41:59 by ross]
fix 3 bugs in --use-package, and document it.

- - - - -
00074a68 by Sven Panne at 2005-05-21T12:35:29+00:00
[haddock @ 2005-05-21 12:35:29 by panne]
Warning/versionitis police

- - - - -
341fa822 by Simon Marlow at 2005-06-15T15:43:21+00:00
[haddock @ 2005-06-15 15:43:21 by simonmar]
Allow "licence" as an alternate spelling of "license"

- - - - -
3b953f8b by Simon Marlow at 2005-06-16T08:14:12+00:00
[haddock @ 2005-06-16 08:14:12 by simonmar]
wibble

- - - - -
abfd9826 by Simon Marlow at 2005-06-27T14:46:40+00:00
[haddock @ 2005-06-27 14:46:40 by simonmar]
name hierarchical HTML files as A-B-C.html instead of A.B.C.html.  The
old way confused Apache because the extensions are sometimes
interpreted as having special meanings.

- - - - -
a01eea00 by Simon Marlow at 2005-08-04T13:59:40+00:00
[haddock @ 2005-08-04 13:59:40 by simonmar]
0.7 changes

- - - - -
170ef87e by Simon Marlow at 2005-08-04T15:08:03+00:00
[haddock @ 2005-08-04 15:08:03 by simonmar]
spec file from Jens Peterson

- - - - -
7621fde4 by Simon Marlow at 2005-08-04T15:59:30+00:00
[haddock @ 2005-08-04 15:59:30 by simonmar]
replace mingw tests with $(Windows)

- - - - -
a20739bb by Sven Panne at 2005-08-05T07:01:12+00:00
[haddock @ 2005-08-05 07:01:12 by panne]
Reverted to previous version (but with bumped version number), the last
commit broke RPM building on SuSE systems due to differently named
dependencies.

As a clarification: All .spec files in the repository have to work at least
on SuSE, because that's the system I'm using. And as "Mr. Building Police",
I reserve me the right to keep them that way... >:-) It might very well be
the case that we need different .spec files for different platforms, so
packagers which are unhappy with the current .spec files should contact me,
stating the actual problems.

- - - - -
4afb15cf by Simon Marlow at 2005-10-05T10:51:45+00:00
[haddock @ 2005-10-05 10:51:45 by simonmar]
Add a bug

- - - - -
60f69f82 by Simon Marlow at 2005-10-05T12:52:03+00:00
[haddock @ 2005-10-05 12:52:03 by simonmar]
Document new behaviour of -s option

- - - - -
f7e520ca by Simon Marlow at 2005-10-10T15:02:55+00:00
[haddock @ 2005-10-10 15:02:55 by simonmar]
extractRecSel: ignore non-record constructors (fixes a crash when
using datatypes with a mixture of record and non-record style
constructors).

- - - - -
b2edbedb by Simon Marlow at 2005-10-14T09:44:21+00:00
Start CHANGES for 0.8
- - - - -
21c7ac8d by Simon Marlow at 2005-10-14T23:11:19+00:00
First cut of Cabal build system
- - - - -
766cecdd by Simon Marlow at 2005-10-29T08:14:43+00:00
Add configure script and Makefile for the docs

Add a separate configure script and build system for building the
documentation.  The configure and Makefile code is stolen from
fptools.  This is left as a separate build system so that the main
Cabal setup doesn't require a Unix build environment or DocBook XML
tools.


- - - - -
aa36c783 by Duncan Coutts at 2006-01-17T19:29:55+00:00
Add a --wiki=URL flag to add a per-module link to a correspondng wiki page.
So each html page gets an extra link (placed next to the source code and
contents links) to a corresponding wiki page. The idea is to let readers
contribute their own notes, examples etc to the documentation.

Also slightly tidy up the code for the --source option.

- - - - -
e06e2da2 by Simon Marlow at 2006-01-18T09:28:15+00:00
TODO: documnet --wiki
- - - - -
17adfda9 by Duncan Coutts at 2006-01-19T20:17:59+00:00
Add an optional wiki link for each top level exported name.
In each module, for each "top level" exported entity we add a hyper link to a
corresponding wiki page. The link url gets the name of the exported entity as
a '#'-style anchor, so if there is an anchor in the page with that name then
the users browser should jump directly to it. By "top level" we mean functions,
classes, class members and data types (data, type, newtype), but not data
constructors, class instances or data type class membership.

The link is added at the right of the page and in a small font. Hopefully this
is the right balance of visibility/distraction.

We also include a link to the wiki base url in the contents and index pages.

- - - - -
f52324bb by Duncan Coutts at 2006-01-19T20:28:27+00:00
Rewrite pathJoin to only add a path separator when necessary.
When the path ends in a file seperator there is no need to add another.
Now using "--wiki=http://blah.com/foo/" should do the right thing.
(Code snippet adapted from Isaac's FilePath package.)

- - - - -
43bb89fa by Duncan Coutts at 2006-01-21T17:15:27+00:00
Teach haddock about line pragmas and add accurate source code links
Teach haddock about C and Haskell style line pragmas. Extend the lexer/parser's
source location tracking to include the file name as well as line/column. This
way each AST item that is tagged with a SrcLoc gets the original file name too.

Use this original file name to add source links to each exported item, in the
same visual style as the wiki links. Note that the per-export source links are
to the defining module rather than whichever module haddock pretends it is
exported from. This is what we want for source code links. The source code link
URL can also contain the name of the export so one could implement jumping to
the actual location of the function in the file if it were linked to an html
version of the source rather than just plain text. The name can be selected
with the %N wild card.

So for linking to the raw source code one might use:
--source=http://darcs/haskell.org/foo/%F

Or for linking to html syntax highlighted code:
--source=http://darcs/haskell.org/foo/%M.html#%N

- - - - -
edd9f229 by Duncan Coutts at 2006-01-22T00:02:00+00:00
Extend URL variable expansion syntax and add source links to the contents page
Like the wiki link on the contents and index page, add a source code link too.
Extend the wiki & source URL variable expansion syntax.

The original syntax was:
%F for the source file name (the .hs version only, not the .lhs or .hs.pp one)
%M for the module name (with '.' replaced by '/')

The new syntax is:
%F or %{FILE} for the original source file name
%M or %{MODULE} for the module name (no replacements)
%N or %{NAME} for the function/type export name
%K or %{KIND} for a type/value flag "t" or "v"

with these extensions:
%{MODULE/./c} to replace the '.' module seperator with any other char c

%{VAR|some text with the % char in it} which means if the VAR is not in use in
this URL context then "" else replace the given text with the '%' char
replaced by the string value of the VAR. This extension allows us to construct
URLs wit optional parts, since the module/file name is not available for the
URL in the contents/index pages and the value/type name is not available for
the URL at the top level of each module.

- - - - -
eb3c6ada by Duncan Coutts at 2006-01-23T13:42:34+00:00
Remove the complex substitutions and add more command line flags instead.
Instead of incomprehensable URL substitutions like ${MODULE/./-|?m=%} we now
use three seperate command line flags for the top level, per-module and
per-entity source and wiki links. They are:
--source-base, --source-module, --source-entity
--comments-base, --comments-module, --comments-entity

We leave -s, --source as an alias for --source-module which is how that option
behaved previously.

The long forms of the substitutions are still available, ${FILE} ${MODULE} etc
and the only non-trivial substitution is ${MODULE/./c} to replace the '.'
characters in the module name with any other character c. eg ${MODULE/./-}

Seperating the source and wiki url flags has the added bonus that they can
be turned on or off individually. So users can have per-module links for
example without having to also have per-entity links.`

- - - - -
a2f0f2af by Duncan Coutts at 2006-01-23T13:54:52+00:00
Make the --help output fit in 80 columns.
This is a purely cosmetic patch, feel free to ignore it.
The only trickery going on is that we don't display the deprecated -s, --source
flags in the help message, but we do still accept them.

- - - - -
2d3a4b0c by Duncan Coutts at 2006-01-23T14:12:16+00:00
Add documentation for the new --source-* and --comments-* command line options
- - - - -
1a82a297 by Simon Marlow at 2006-01-23T17:03:27+00:00
fix markup
- - - - -
100d464a by Duncan Coutts at 2006-01-23T18:31:13+00:00
remove a couple TODO items that have been done
The --wiki, or rather the --comment-* options are now documented.
There is probably no need to have haddock invoke unlit or cpp itself since
it can now pick up the line pragmas to get the source locations right. Tools
like Cabal will arrange for preprocessors to be run so there is less of a need
for tools like haddock to do it themselves.

- - - - -
3162fa91 by Simon Marlow at 2006-01-24T14:21:56+00:00
add a test I had lying around
- - - - -
98947063 by Simon Marlow at 2006-01-31T13:52:54+00:00
add scabal-version field
- - - - -
c41876e6 by Neil Mitchell at 2006-02-26T17:48:21+00:00
Add Hoogle output option
- - - - -
f86fb9c0 by Simon Marlow at 2006-03-08T09:15:20+00:00
add haskell.vim
Contributed by Brad Bowman <bsb at bereft.net>, thanks!

- - - - -
35d3c511 by benjamin.franksen at 2006-03-03T22:39:54+00:00
fixed libdir (/html was missing)
- - - - -
4d08fd7d by Simon Marlow at 2006-03-10T11:13:31+00:00
add PatternGuards extension
- - - - -
3f095e70 by Simon Marlow at 2006-03-13T11:40:42+00:00
bug fixes from Brad Bowman
- - - - -
8610849d by Sven Panne at 2006-03-19T17:02:56+00:00
Fixed Cabal/RPM build
- - - - -
34a994d6 by sven.panne at 2006-04-20T12:39:23+00:00
Avoid pattern guards

Due to the use of pattern guards in Haddock, GHC was called with
-fglasgow-exts. This in turn enables bang patterns, too, which broke the
Haddock build. Removing some unnecessary pattern guards seemed to be the
better way of fixing this instead of using a pragma to disable pattern
guards.

- - - - -
bb523f51 by Ross Paterson at 2006-04-24T09:03:25+00:00
extend 'deriving' heuristic a little
If an argument of a data constructor has a type variable head, it is
irreducible and the same type class can be copied into the constraint.
(Formerly we just did this for type variable arguments.)

- - - - -
dab9fe7a by Simon Marlow at 2006-04-26T10:02:31+00:00
record an idea
- - - - -
748b7078 by Simon Marlow at 2006-05-08T08:28:53+00:00
add section about deriving
- - - - -
11252ea1 by Simon Marlow at 2006-05-24T15:43:10+00:00
replace a fatal error in lexChar with a parseError
- - - - -
382c9411 by Simon Marlow at 2006-05-24T15:45:47+00:00
add a bug
- - - - -
b79272f5 by Simon Marlow at 2006-05-24T15:46:29+00:00
add a bug report
- - - - -
912edf65 by David Waern at 2006-07-10T19:09:23+00:00
Initial modifications -- doesn't compile
- - - - -
a3c7ba99 by David Waern at 2006-07-11T00:54:19+00:00
More porting work -- doesn't compile
- - - - -
0a173d19 by David Waern at 2006-07-11T11:30:03+00:00
Make the repos temporarily compile and illustrate a problem
- - - - -
bad316de by David Waern at 2006-07-11T15:43:47+00:00
Progress on the porting process 
- - - - -
bbf12d02 by David Waern at 2006-07-11T23:07:44+00:00
More progress on the porting -- first pass starting to shape up
- - - - -
de580ba2 by David Waern at 2006-07-20T17:48:30+00:00
More progress -- still on phase1
- - - - -
75a917a2 by David Waern at 2006-07-23T18:22:43+00:00
More work on pass1 -- mostly done
- - - - -
6697b3f7 by David Waern at 2006-07-23T22:17:40+00:00
More work, started working on the renaming phase -- this code will need a cleanup soon :)
- - - - -
82a5bcbb by David Waern at 2006-07-29T16:16:43+00:00
Add instances, build renaming environment, start on the renamer
- - - - -
c3f8f4f1 by David Waern at 2006-07-29T21:37:48+00:00
Complete the renamer
- - - - -
7e00d464 by David Waern at 2006-07-30T21:01:57+00:00
Start porting the Html renderer
- - - - -
f04ce121 by David Waern at 2006-08-09T20:04:56+00:00
More Html rendering progress
- - - - -
20c21b53 by David Waern at 2006-08-10T17:37:47+00:00
More progress
- - - - -
d7097e0d by David Waern at 2006-08-11T20:31:51+00:00
Cleanup
- - - - -
a7351e86 by David Waern at 2006-08-12T11:44:47+00:00
Render H98 Data declarations
- - - - -
3fb2208e by David Waern at 2006-08-12T17:15:34+00:00
Perfect rendering of Test.hs
- - - - -
454fd062 by David Waern at 2006-08-13T21:57:08+00:00
Misc fixes and interface load/save
- - - - -
7ef7e7be by David Waern at 2006-08-14T00:56:07+00:00
Some refactoring
- - - - -
a7d3efef by David Waern at 2006-08-19T20:07:55+00:00
Adapt to latest GHC 
- - - - -
5fc3c0d7 by David Waern at 2006-08-20T21:28:11+00:00
Move interface read/write to its own module + some cleanup
- - - - -
037e011c by David Waern at 2006-08-20T21:38:24+00:00
Small cleanup
- - - - -
da3a1023 by David Waern at 2006-09-03T16:05:22+00:00
Change mode to BatchCompile to avoid GHC API bug
- - - - -
3cc9be3b by David Waern at 2006-09-03T16:06:59+00:00
Starting work on GADT rendering
- - - - -
94506037 by David Waern at 2006-09-03T20:02:48+00:00
Compensate for change of export list order in GHC
- - - - -
c2cec4eb by David Waern at 2006-09-04T20:53:01+00:00
Rename a function
- - - - -
9a9735ba by David Waern at 2006-09-05T15:51:21+00:00
Change version number to 2.0
- - - - -
3758a714 by David Waern at 2006-09-05T15:51:49+00:00
Align comment properly
- - - - -
68478d9e by David Waern at 2006-09-15T18:03:00+00:00
Remove interface reading/writing code and use the GHC api for creating package environments instead
- - - - -
d2eedd95 by David Waern at 2006-09-15T18:05:29+00:00
Change the executable name to haddock-ghc-nolib
- - - - -
fcfbcf66 by David Waern at 2006-09-15T18:05:45+00:00
Small source code cleanup
- - - - -
d08eb017 by David Waern at 2006-09-15T18:06:21+00:00
Remove handling of --package flag
- - - - -
b8a4cf53 by David Waern at 2006-09-15T18:07:16+00:00
Remove commented-out code
- - - - -
bef0a684 by David Waern at 2006-09-15T18:37:57+00:00
Don't warn about missing links to ()
- - - - -
e7d25fd7 by David Waern at 2006-09-15T19:50:49+00:00
Remove Interface and Binary2 modules 
- - - - -
9894f2a1 by David Waern at 2006-09-15T19:53:43+00:00
Remove debug printing from HaddockHtml
- - - - -
a0e7455d by David Waern at 2006-09-16T00:16:29+00:00
Comments only
- - - - -
d5b26fa7 by David Waern at 2006-09-16T00:16:57+00:00
Refactor PackageData creation code and start on building the doc env propery (unfinished)
- - - - -
06aaa779 by David Waern at 2006-09-16T00:19:25+00:00
Better comments in Main.hs
- - - - -
1a52d1b4 by David Waern at 2006-09-18T22:17:11+00:00
Comments and spacing change
- - - - -
e5a97767 by David Waern at 2006-09-21T17:02:45+00:00
Remove unnecessary fmapM import in Main
- - - - -
9d0f9d3a by David Waern at 2006-09-22T18:07:07+00:00
Make import list in HaddockHtml prettier
- - - - -
3452f662 by David Waern at 2006-09-22T18:08:47+00:00
Refactor context rendering
- - - - -
12d0a6d0 by David Waern at 2006-09-22T18:09:52+00:00
Do proper HsType rendering (inser parentheses correctly)
- - - - -
2c20c2f9 by David Waern at 2006-09-22T18:10:45+00:00
Fix a bug in Main.toHsType
- - - - -
c5396443 by David Waern at 2006-09-22T18:11:16+00:00
Skip external package modules sort for now
- - - - -
3fb95547 by David Waern at 2006-09-22T20:35:40+00:00
Take away trailin "2" on all previously clashing type names
- - - - -
2174755f by David Waern at 2006-09-22T20:51:43+00:00
Remove unused imports in Main
- - - - -
1e9f7a39 by David Waern at 2006-09-22T20:52:11+00:00
Fix a comment in Main
- - - - -
32d9e028 by David Waern at 2006-10-05T16:40:11+00:00
Merge with changes to ghc HEAD
- - - - -
3058c8f5 by David Waern at 2006-10-05T16:41:02+00:00
Comment fixes
- - - - -
b9c217ec by David Waern at 2006-10-05T16:49:59+00:00
Filter out more builtin type constructors from warning messages
- - - - -
67e7d252 by David Waern at 2006-10-05T19:38:22+00:00
Refactoring -- better structured pass1
- - - - -
cd21c0c1 by David Waern at 2006-10-05T19:44:42+00:00
Remove read/dump interface flags
- - - - -
313f9e69 by David Waern at 2006-10-05T19:49:26+00:00
Remove unused pretty printing
- - - - -
480f09d1 by David Waern at 2006-12-28T13:22:24+00:00
Update to build with latest GHC HEAD
- - - - -
63dccfcb by David Waern at 2007-01-05T01:38:45+00:00
Fixed a bug so that --ghc-flag works correctly
- - - - -
3117dadc by David Waern at 2006-12-29T18:53:39+00:00
Automatically get the GHC lib dir
- - - - -
9dc84a5c by David Waern at 2006-12-29T19:58:53+00:00
Comments
- - - - -
0b0237cc by David Waern at 2007-01-05T16:48:30+00:00
Collect docs based on SrcLoc, syncing with removal of DeclEntity from GHC
- - - - -
a962c256 by David Waern at 2007-01-05T17:02:47+00:00
Add tabs in haddock.cabal
- - - - -
0ca30c97 by David Waern at 2007-01-05T17:04:11+00:00
Add GHCUtils.hs
- - - - -
c0ab9abe by David Waern at 2007-01-10T11:43:08+00:00
Change package name to haddock-ghc, version 0.1
- - - - -
38e18b27 by David Waern at 2007-01-12T12:03:52+00:00
No binder name for foreign exports
- - - - -
d18587ab by David Waern at 2007-01-12T12:08:15+00:00
Temp record
- - - - -
ba6251a0 by David Waern at 2007-01-12T18:27:55+00:00
Remove read/dump-interface (again)
- - - - -
f4ba2b39 by David Waern at 2007-01-12T18:31:36+00:00
Remove DocOption, use the GHC type
- - - - -
511be8bd by David Waern at 2007-01-12T18:32:41+00:00
Use exceptions instead of Either when loading package info
- - - - -
0f2144d8 by David Waern at 2007-01-12T18:33:23+00:00
Small type change
- - - - -
77507eb7 by David Waern at 2007-01-12T18:33:59+00:00
Remove interface file read/write
- - - - -
0ea1e14f by David Waern at 2007-01-17T21:40:26+00:00
Add trace_ppr to GHCUtils
- - - - -
3878b493 by David Waern at 2007-01-17T21:40:53+00:00
Sort external package modules and build a doc env
- - - - -
8dc323fc by David Waern at 2007-01-17T21:42:41+00:00
Remove comment
- - - - -
f4c5b097 by David Waern at 2007-01-18T23:22:18+00:00
Add haddock-ghc.cabal and remove ghc option pragma in source file
- - - - -
da242b2c by David Waern at 2007-01-18T23:22:46+00:00
Remove some tabs
- - - - -
288ed096 by David Waern at 2007-01-18T23:39:28+00:00
Moved the defaultErrorHandler to scope only over sortAndCheckModules for now
- - - - -
4dd150fe by David Waern at 2007-02-03T21:23:56+00:00
Let restrictCons handle infix constructors
- - - - -
97893442 by David Waern at 2007-02-04T16:26:00+00:00
Render infix data constructors
- - - - -
da89db72 by David Waern at 2007-02-04T16:26:33+00:00
CHange project name to Haddock-GHC
- - - - -
e93d48af by David Waern at 2007-02-04T16:59:08+00:00
Render infix type constructors properly
- - - - -
357bc99b by David Waern at 2007-02-04T17:37:08+00:00
Insert spaces around infix function names
- - - - -
ab6cfc49 by David Waern at 2007-02-04T17:59:54+00:00
Do not list entities without documentation
- - - - -
04249c7e by David Waern at 2007-02-04T19:16:25+00:00
Add GADT support (quite untested)
- - - - -
2c223f8d by David Waern at 2007-02-04T19:25:10+00:00
Add package file write/save again!
- - - - -
b07ed218 by David Waern at 2007-02-04T19:33:02+00:00
Comment out minf_iface based stuff
- - - - -
953d1fa7 by David Waern at 2007-02-05T00:12:23+00:00
Solve conflicts
- - - - -
593247fc by David Waern at 2007-02-06T19:48:48+00:00
Remove -package flag, GHC's can be used instead
- - - - -
f658ded2 by David Waern at 2007-02-06T20:50:44+00:00
Start for support of ATs
- - - - -
97f9e913 by David Waern at 2007-02-06T20:52:27+00:00
Wibble
- - - - -
2ce8e4cf by David Waern at 2007-02-16T12:09:49+00:00
Add the DocOptions change
- - - - -
dee4a9b5 by David Waern at 2007-03-06T01:24:48+00:00
Wibble
- - - - -
7cb99d18 by David Waern at 2007-03-06T01:24:58+00:00
Change version to 2.0 and executable name to haddock
- - - - -
c5aa02bc by David Waern at 2007-03-08T15:59:49+00:00
Go back to -B flag 
- - - - -
3a349201 by David Waern at 2007-03-09T13:31:59+00:00
Better exception handling and parsing of GHC flags
- - - - -
05a69b71 by David Waern at 2007-03-09T17:45:44+00:00
Remove commented-out DocEntity printing
- - - - -
755032cb by davve at dtek.chalmers.se at 2007-03-23T23:30:20+00:00
Remove a file that shouldn't be here
- - - - -
a7077e5f by davve at dtek.chalmers.se at 2007-03-24T03:58:48+00:00
Remove an import
- - - - -
6f55aa8b by davve at dtek.chalmers.se at 2007-03-25T00:46:48+00:00
Start work on Haddock API
- - - - -
f0199480 by davve at dtek.chalmers.se at 2007-03-25T00:56:36+00:00
Prettify some comments
- - - - -
f952f9d1 by davve at dtek.chalmers.se at 2007-03-25T00:56:53+00:00
Remove ppr in HaddockTypes
- - - - -
bc594904 by davve at dtek.chalmers.se at 2007-03-25T00:57:53+00:00
Remove commented out doc env inference
- - - - -
11ebf08d by davve at dtek.chalmers.se at 2007-03-25T01:23:25+00:00
De-flatten the namespace
- - - - -
f696b4bc by davve at dtek.chalmers.se at 2007-03-25T03:21:48+00:00
Add missing stuff to API
- - - - -
9a2a04c3 by davve at dtek.chalmers.se at 2007-03-25T03:22:02+00:00
Wibble
- - - - -
7d04a6d5 by davve at dtek.chalmers.se at 2007-03-25T03:22:08+00:00
Avoid a GHC bug with parseStaticFlags []
- - - - -
4d2820ba by davve at dtek.chalmers.se at 2007-03-26T04:57:01+00:00
Add fall-through case to mkExportItem
- - - - -
6ebc8950 by Stefan O'Rear at 2007-03-26T04:14:53+00:00
Add shebang line to Setup.lhs
- - - - -
80966ec5 by davve at dtek.chalmers.se at 2007-03-26T05:24:26+00:00
Fix stupid compile error
- - - - -
1ea1385d by davve at dtek.chalmers.se at 2007-04-05T17:19:56+00:00
Do save/read of interface files properly
- - - - -
0e4f6541 by David Waern at 2007-04-10T21:08:36+00:00
Add version to ghc dependency
- - - - -
b0499b63 by David Waern at 2007-04-10T21:37:08+00:00
Change package name to haddock
- - - - -
9d50d27e by David Waern at 2007-04-24T00:22:14+00:00
Use filepath package instead of FilePath
- - - - -
87c7fcdf by David Waern at 2007-07-10T21:03:04+00:00
Add new package dependencies
- - - - -
4768709c by David Waern at 2007-07-11T20:37:11+00:00
Follow changes to record constructor representation
- - - - -
b9a02fee by Simon Marlow at 2007-05-30T14:00:48+00:00
update to compile with the latest GHC & Cabal
- - - - -
c0ebdc01 by David Waern at 2007-07-11T21:35:45+00:00
Fix conflicts
- - - - -
97f7afd4 by David Waern at 2007-07-11T21:52:38+00:00
Follow changes to the GHC API
- - - - -
a5b7b58f by David Waern at 2007-07-12T20:36:48+00:00
Call parseStaticFlags before newSession
- - - - -
f7f50dbc by David Waern at 2007-08-01T21:52:58+00:00
Better indentation in haddock.cabal
- - - - -
d84e52ad by David Waern at 2007-08-02T00:08:18+00:00
Wibble
- - - - -
a23f494a by David Waern at 2007-08-02T00:08:24+00:00
Be better at trying to load all module dependencies (debugging)
- - - - -
ee917f13 by David Waern at 2007-08-03T18:48:08+00:00
Load all targets explicitly (checkModule doesn't chase dependencies anymore)
- - - - -
5182d631 by David Waern at 2007-08-16T16:48:55+00:00
Finalize support for links to other packages
- - - - -
dfd1e3da by David Waern at 2007-08-16T16:51:11+00:00
Fix haddock comment errors in Haddock.Types
- - - - -
50c0d83e by David Waern at 2007-08-16T16:51:37+00:00
Remove a debug import
- - - - -
d84b7c2b by David Waern at 2007-08-16T17:06:30+00:00
Rename PackageData to HaddockPackage
- - - - -
3b52cb9f by David Waern at 2007-08-16T17:09:42+00:00
Simplify some comments
- - - - -
66fa68d9 by David Waern at 2007-08-16T17:11:38+00:00
Comment the HaddockPackage definition
- - - - -
8674c761 by David Waern at 2007-08-16T17:25:54+00:00
Improve code layout in Main
- - - - -
571a3a0b by David Waern at 2007-08-16T17:32:13+00:00
Remove explict module imports in Main
- - - - -
d31b3cb0 by David Waern at 2007-08-16T17:36:23+00:00
Correct comments
- - - - -
7f8a9f2b by David Waern at 2007-08-16T17:39:50+00:00
Fix layout problems in Haddock.Types
- - - - -
9f421d7f by David Waern at 2007-08-17T11:16:48+00:00
Move options out of Main into Haddock.Options
- - - - -
80042b63 by David Waern at 2007-08-17T11:26:59+00:00
Small comment/layout fixes
- - - - -
b141b982 by David Waern at 2007-08-17T11:28:28+00:00
Change project name from Haddock-GHC to Haddock
- - - - -
dbeb4a81 by David Waern at 2007-08-17T11:41:05+00:00
Add top module comment to all files
- - - - -
ce99cc9e by David Waern at 2007-08-17T14:53:04+00:00
Factor out typechecking phase into Haddock.Typecheck
- - - - -
6bf75d9e by David Waern at 2007-08-17T16:55:35+00:00
Factor out package code to Haddock.Packages
- - - - -
b396db37 by David Waern at 2007-08-29T22:40:23+00:00
Major refactoring
- - - - -
3d4f95ee by David Waern at 2007-08-29T23:26:24+00:00
Rename HaddockModule to Interface and a few more refactorings
- - - - -
c55326db by David Waern at 2007-08-29T23:48:03+00:00
Some comment cleanup
- - - - -
9a84fc46 by David Waern at 2007-08-29T23:49:29+00:00
Add some modules that I forgot to add earlier
- - - - -
4536dce2 by David Waern at 2007-08-29T23:55:24+00:00
Wibble
- - - - -
9b7f0206 by David Waern at 2007-08-30T16:03:29+00:00
Wibble
- - - - -
c52c050a by David Waern at 2007-08-30T16:30:37+00:00
Rename HaddockModule to Interface
- - - - -
eae2995f by David Waern at 2007-08-30T16:42:59+00:00
Simplify createInterfaces
- - - - -
53f99caa by David Waern at 2007-09-29T00:04:31+00:00
Add build-type: Simple to the cabal file
- - - - -
0d3103a8 by David Waern at 2007-09-29T00:04:58+00:00
Add containers and array dependency
- - - - -
6acf5f30 by David Waern at 2007-09-29T00:13:36+00:00
Prettify the cabal file
- - - - -
87c1e378 by David Waern at 2007-09-29T13:16:39+00:00
FIX: consym data headers with more than two variables
- - - - -
b67fc16a by David Waern at 2007-09-29T14:01:32+00:00
FIX: prefix types used as operators should be quoted
- - - - -
a8f925bc by David Waern at 2007-09-29T14:02:26+00:00
Use isSymOcc from OccName instead of isConSym
- - - - -
fc330701 by David Waern at 2007-09-29T14:15:37+00:00
Use isLexConSym/isLexVarSym from OccName
- - - - -
e4f3dbad by David Waern at 2007-09-29T15:01:08+00:00
FIX: do not quote varsym type operators
- - - - -
402207d2 by David Waern at 2007-09-29T15:01:50+00:00
Wibble
- - - - -
f9d89ef0 by David Waern at 2007-09-29T15:17:40+00:00
Take care when pp tyvars - add parens on syms
- - - - -
849e2a77 by David Waern at 2007-10-01T21:56:39+00:00
Go back to using a ModuleMap instead of LookupMod - fixes a bug
- - - - -
549dbac6 by David Waern at 2007-10-02T01:05:19+00:00
Improve parsing of doc options
- - - - -
a36021b8 by David Waern at 2007-10-02T23:05:00+00:00
FIX: double arrows in constructor contexts
- - - - -
d03bf347 by David Waern at 2007-10-09T16:14:05+00:00
Add a simple test suite
- - - - -
c252c140 by David Waern at 2007-10-17T16:02:28+00:00
Add --optghc=.. style flag passing to GHC
- - - - -
cce6c1b3 by David Waern at 2007-10-18T22:03:20+00:00
Add support for --read-interface again
- - - - -
33d059c0 by David Waern at 2007-10-18T22:30:18+00:00
Refactoring -- get rid of Haddock.Packages
- - - - -
f9ed0a4c by David Waern at 2007-10-18T22:34:36+00:00
Name changes
- - - - -
8a1c816f by David Waern at 2007-10-20T14:24:23+00:00
Add --ghc-version option
- - - - -
4925aaa1 by David Waern at 2007-10-21T14:34:26+00:00
Add some Outputable utils
- - - - -
69e7e47f by David Waern at 2007-10-21T14:35:49+00:00
FIX: Ord for OrdName was not comparing modules
- - - - -
5a4ae535 by David Waern at 2007-10-21T21:18:48+00:00
Wibble
- - - - -
03d48e20 by David Waern at 2007-10-24T15:52:56+00:00
Remove Main from "other modules"
- - - - -
c66f6d82 by David Waern at 2007-10-24T16:37:18+00:00
Make it possible to run haddock on itself
- - - - -
21d156d8 by David Waern at 2007-10-25T14:02:14+00:00
Don't set boot modules as targets
- - - - -
f8bcf91c by David Waern at 2007-10-31T22:11:17+00:00
Add optimisation flags
- - - - -
7ac758f2 by David Waern at 2007-11-04T09:48:28+00:00
Go back to loading only targets (seems to work now)
- - - - -
4862aae1 by David Waern at 2007-11-05T22:24:57+00:00
Do full compilation of modules -- temporary fix for GHC API problem
- - - - -
697e1517 by David Waern at 2007-11-05T22:25:50+00:00
Don't warn about not being able to link to wired/system/builtin-names
- - - - -
892186da by David Waern at 2007-11-06T00:49:21+00:00
Filter out instances with TyCons that are not exported
- - - - -
9548314c by David Waern at 2007-11-06T09:37:14+00:00
Wibble
- - - - -
5cafd627 by David Waern at 2007-11-08T01:43:07+00:00
Filter out all non-vanilla type sigs
- - - - -
04621830 by David Waern at 2007-11-08T01:45:13+00:00
Synch loading of names from .haddock files with GHC's name cache
- - - - -
88d37f77 by David Waern at 2007-11-08T01:46:21+00:00
Remove commented-out code
- - - - -
6409c911 by David Waern at 2007-11-08T01:56:00+00:00
Small bugfix and cleanup in getDeclFromTyCls
- - - - -
af59d9c2 by David Waern at 2007-11-08T02:08:44+00:00
Remove OrdName stuff
- - - - -
3a615e2e by David Waern at 2007-11-08T02:13:41+00:00
Update runtests.hs following changes to haddock
- - - - -
01f3314e by David Waern at 2007-11-08T02:33:01+00:00
Complain if we can't link to wired-in names
- - - - -
fcafb5d1 by David Waern at 2007-11-09T02:40:16+00:00
Don't exit when there are no file arguments
- - - - -
194bc332 by David Waern at 2007-11-09T02:55:37+00:00
Wibble
- - - - -
dbe4cb55 by David Waern at 2007-11-09T02:56:14+00:00
Wibble
- - - - -
82869fda by David Waern at 2007-11-10T17:01:43+00:00
Introduce InstalledInterface structure and add more stuff to the .haddock files

We introduce InstalledInterface capturing the part of Interface that is stored
in the interface files. We change the ppHtmlContents and ppHtmllIndex to take
this structure instead of a partial Interface. We add stuff like the doc map
and exported names to the .haddock file (via InstalledInterface).

- - - - -
d6bb57bf by David Waern at 2007-11-10T17:19:48+00:00
FIX: contents and index should include external package modules when --gen-contents/--gen-index
- - - - -
e8814716 by David Waern at 2007-11-11T00:29:27+00:00
Remove lDocLinkName and its use in Html backend
- - - - -
6f9bd702 by David Waern at 2007-11-11T00:50:57+00:00
Do some refactoring in the html backend
This also merges an old patch by Augustsson:
  
  Wed Jul 12 19:54:36 CEST 2006  lennart.augustsson at credit-suisse.com
    * Print type definitions like signatures if given arrows.



- - - - -
09d0ce24 by Malcolm.Wallace at 2006-07-20T13:13:57+00:00
mention HsColour in the docs, next to option flags for linking to source code
- - - - -
24da6c34 by Malcolm.Wallace at 2006-07-20T13:14:50+00:00
change doc references to CVS to give darcs repository location instead
- - - - -
74d52cd6 by David Waern at 2007-11-11T00:55:33+00:00
Update copyright
- - - - -
fcaa3b4f by Duncan Coutts at 2006-09-08T13:41:00+00:00
Eliminate dep on network by doing a little cut'n'paste
haddock depending on the network causes a circular dependency
at least if you want to build the network lib with haddock docs.

- - - - -
10cc9bda by David Waern at 2007-11-11T02:09:41+00:00
Fix conflicts
- - - - -
4e3acd39 by David Waern at 2007-11-11T02:21:19+00:00
Manual merge of a patch from Duncan Coutts that removes the dependency on mtl 
- - - - -
fa9070da by Neil Mitchell at 2006-09-29T15:52:03+00:00
Do not generate an empty table if there are no exports, this fixes a <table></table> tag being generated, which is not valid HTML 4.01
- - - - -
d7431c85 by David Waern at 2007-11-11T02:28:50+00:00
Fix conflicts
- - - - -
f87e8f98 by Simon Marlow at 2006-10-10T11:37:16+00:00
changes for 0.8
- - - - -
db929565 by Simon Marlow at 2006-10-10T12:07:12+00:00
fix the name of the source file


- - - - -
8220aa4b by Simon Marlow at 2006-10-11T14:17:37+00:00
Rename haddock.js to haddock-util.js
haddock.js will be run automatically by Windows when you type
'haddock' if it is found on the PATH, so rename to avoid confusion.
Spotted by Adrian Hey.

- - - - -
6bccdaa1 by sven.panne at 2006-10-12T15:28:23+00:00
Cabal's sdist does not generate "-src.tar.gz" files, but ".tar.gz" ones
- - - - -
d3f3fc19 by Simon Marlow at 2006-12-06T16:05:07+00:00
add todo item for --maintainer
- - - - -
2da7e269 by Simon Marlow at 2006-12-15T15:52:00+00:00
TODO: do something better about re-exported symbols from another package
- - - - -
42d85549 by David Waern at 2007-11-11T02:30:59+00:00
Fix conflicts
- - - - -
5e7ef6e5 by Neil Mitchell at 2007-01-11T15:41:15+00:00
Never do spliting index files into many
- - - - -
f3d4aebe by Neil Mitchell at 2007-01-11T17:07:09+00:00
Add searching on the index page
- - - - -
bad3ab66 by Neil Mitchell at 2007-01-11T18:17:46+00:00
Delete dead code, now there is only one index page
- - - - -
cd09eedb by Neil Mitchell at 2007-01-11T18:21:19+00:00
Delete more stuff that is no longer required
- - - - -
e2806646 by David Waern at 2007-11-11T02:41:53+00:00
Fix conflicts
- - - - -
a872a823 by Neil Mitchell at 2007-01-11T18:51:43+00:00
Make the index be in case-insensitive alphabetic order
- - - - -
8bddd9d7 by Neil Mitchell at 2007-02-06T17:49:12+00:00
Do not create empty tables for data declarations which don't have any constructors, instances or comments. Gets better HTML 4.01 compliance
- - - - -
036b8120 by David Waern at 2007-11-11T02:56:58+00:00
Fix conflicts
- - - - -
f50c1639 by Conal Elliott at 2007-02-14T21:54:00+00:00
added substitution %{FILE///c}
- - - - -
402e166a by David Waern at 2007-11-11T03:35:46+00:00
Manual merge of old patch:

Sat Apr 21 04:36:43 CEST 2007  Roberto Zunino <zunrob at users.sf.net>
  * URL expansion for %%, %L, %{LINE}


- - - - -
2f264fbd by David Waern at 2007-11-11T03:40:33+00:00
Manual merge of an old patch:
  Thu Apr 19 20:23:40 CEST 2007  Wolfgang Jeltsch <g9ks157k at acme.softbase.org>
    * bug fix
    When Haddock was invoked with the --ignore-all-exports flag but the ignore-exports module attribute wasn't used, hyperlinks weren't created for 
  non-exported names.
  
    This fix might not be as clean as one would wish (since --ignore-all-exports now results in ignore_all_exports = True *and* an additional
  OptIgnoreExports option for every module) but at least the bug seems to be resolved now.

- - - - -
7d7ae106 by sven.panne at 2007-09-02T12:18:02+00:00
Install LICENSE in the correct place
- - - - -
66eaa924 by David Waern at 2007-11-11T19:02:46+00:00
Fix a bug that made haddock loop
- - - - -
4ed47b58 by David Waern at 2007-11-11T19:03:09+00:00
Rename java-script file (this wasn't merge correctly)
- - - - -
d569534a by David Waern at 2007-11-11T19:06:44+00:00
Don't require -B <ghc-libdir> when no argument files
Change readInterfaceFile to take a Maybe Session, to avoid having to pass -B 
<ghc-libdir> to Haddock when there're no source files to process. This is nice when 
computing contents/index for external packages.

- - - - -
373368bc by Neil Mitchell at 2007-01-11T18:22:44+00:00
Change from tabs to spaces in the ppHtmlIndex function
- - - - -
6b063a77 by Neil Mitchell at 2007-01-12T12:17:46+00:00
Rewrite much of the index searching code, previously was too slow to execute on the base library with IE, the new version guarantees less than O(log n) operations be performed, where n is the number in the list (before was always O(n))
- - - - -
bfad00b7 by David Waern at 2007-11-11T23:33:53+00:00
Fix conflicts
- - - - -
cd2dcc09 by Neil Mitchell at 2007-01-12T12:25:01+00:00
Make the max number of results 75 instead of 50, to allow map searching in the base library to work
- - - - -
3ae74764 by Neil Mitchell at 2007-01-12T12:58:17+00:00
Make the search box in a form so that enter does the default search
- - - - -
142103e5 by David Waern at 2007-11-12T00:03:18+00:00
Merge patch from the old branch:

Fri Aug 31 13:21:45 CEST 2007  Duncan Coutts <duncan at haskell.org>
  * Add category: Development to .cabal file
  Otherwise it appears on the hackage website in the "Unclassified" category.


- - - - -
22ec2ddb by David Waern at 2007-11-25T01:55:29+00:00
A a list of small improvements to the TODO file
- - - - -
eb0129f4 by Wolfgang Jeltsch at 2007-12-03T23:47:55+00:00
addition of type equality support (at least for HTML generation)
- - - - -
816a7e22 by David Waern at 2007-12-08T15:46:26+00:00
Handle class operators correctly when rendering predicates
- - - - -
68baaad2 by David Waern at 2007-12-08T16:15:54+00:00
Code layout changes
- - - - -
09b77fb4 by David Waern at 2007-12-08T16:16:03+00:00
Handle infix operators correctly in the Type -> HsType translation
- - - - -
31c36da2 by David Waern at 2007-12-08T16:24:27+00:00
Add ppLParendTypes/ppLParendType
- - - - -
b17cc818 by David Waern at 2007-12-08T16:26:12+00:00
Use ppParendType when printing types args in predicates
- - - - -
ffd1f2cf by David Waern at 2007-12-08T16:45:06+00:00
Fix rendering of instance heads to handle infix operators
This is also a refactoring to share this code for rendering predicates.


- - - - -
ff886d45 by David Waern at 2007-12-08T17:27:46+00:00
Fix rendering of class operators
- - - - -
e2fcbb9e by David Waern at 2007-12-08T17:59:28+00:00
Fix a bug (use ppTyName instead of ppName to print names in type apps)
- - - - -
79a1056e by David Waern at 2007-12-08T21:25:18+00:00
Update tests
- - - - -
867741ac by David Waern at 2007-12-08T21:25:49+00:00
Give a diff on test failure
- - - - -
7e5eb274 by David Waern at 2008-01-05T14:33:45+00:00
Add DrIFT commands
- - - - -
3656454d by David Waern at 2008-01-05T20:26:00+00:00
Add "cabal-version: >= 1.2" to the cabal file
- - - - -
77974efc by Simon Marlow at 2007-12-20T09:52:44+00:00
add an item
- - - - -
f6ac1708 by Simon Marlow at 2007-12-06T14:00:10+00:00
Source links must point to the original module, not the referring module
- - - - -
eda1d5c9 by David Waern at 2008-01-06T14:40:52+00:00
Manual merge of a patch to the 0.8 branch

  Thu Dec  6 15:00:10 CET 2007  Simon Marlow <simonmar at microsoft.com>
    * Source links must point to the original module, not the referring 
      module


- - - - -
378f4085 by David Waern at 2008-01-06T16:03:45+00:00
Change stability from stable to experimental
- - - - -
8bdafe44 by David Waern at 2008-01-06T16:14:22+00:00
Add haskell.vim (it had been removed somehow)
- - - - -
ea34d02e by David Waern at 2008-01-06T16:36:57+00:00
Change version to 2.0.0.0
- - - - -
34631ac0 by David Waern at 2008-01-06T16:44:57+00:00
Add missing modules to the cabal file
- - - - -
9e142935 by David Waern at 2008-01-06T17:25:42+00:00
Depend on ghc >= 6.8.2 && < 6.9
- - - - -
59f9eeaa by Simon Marlow at 2007-12-20T10:43:04+00:00
add build scripts
- - - - -
1c29ae30 by Simon Marlow at 2007-12-20T10:47:07+00:00
update version number
- - - - -
fe16a3e4 by Simon Marlow at 2007-12-20T10:48:03+00:00
update version
- - - - -
f688530f by Simon Marlow at 2007-12-20T10:48:29+00:00
doc updates
- - - - -
ce71b611 by David Waern at 2008-01-07T13:46:32+00:00
Change version in docs and spec
- - - - -
03ab8d6f by David Waern at 2008-01-07T13:47:38+00:00
Manually merge over changes to CHANGES for 0.9
- - - - -
39f1b042 by David Waern at 2008-01-07T15:17:41+00:00
Remove the -use-package flag, we don't support it anyway
- - - - -
7274a544 by David Waern at 2008-01-07T15:33:05+00:00
Update CHANGES for 2.0.0.0
- - - - -
96594f5d by David Waern at 2008-01-07T15:46:49+00:00
Wibble
- - - - -
f4c5a4c4 by David Waern at 2008-01-07T15:55:36+00:00
Change url to repo in documentation
- - - - -
8a4c77f0 by David Waern at 2008-01-07T16:00:54+00:00
Update CHANGES
- - - - -
cb3a9288 by David Waern at 2008-01-07T16:02:55+00:00
Documentation fix
- - - - -
d8e45539 by David Waern at 2008-01-07T16:12:00+00:00
Update docs to say that Haddock accets .lhs files and module names
- - - - -
4b5ce824 by David Waern at 2008-01-07T16:12:25+00:00
Document -B option
- - - - -
47274262 by David Waern at 2008-01-07T16:23:07+00:00
Update CHANGES
- - - - -
7ff314a9 by David Waern at 2008-01-07T16:23:20+00:00
Remove --use-package, --package & --no-implicit.. flags from docs
- - - - -
6c3819c0 by David Waern at 2008-01-07T16:23:52+00:00
Remove --no-implicit-prelide flag
- - - - -
1b14ae40 by David Waern at 2008-01-07T16:32:26+00:00
Update the "Using literate or pre-processed source" section
- - - - -
0117f620 by David Waern at 2008-01-07T16:41:55+00:00
Document the --optghc flag
- - - - -
087ab1cf by David Waern at 2008-01-07T16:42:10+00:00
Remove the documenation section on derived instances
The problem mentioned there doesn't exist in Haddock 2.0.0.0

- - - - -
7253951e by David Waern at 2008-01-07T16:48:40+00:00
Document OPTIONS_HADDOCK
- - - - -
3b6bdcf6 by David Waern at 2008-01-07T16:56:54+00:00
Wibble
- - - - -
3025adf9 by David Waern at 2008-01-07T17:08:14+00:00
Wibble
- - - - -
5f30f1a0 by David Waern at 2008-01-07T17:15:44+00:00
Change synopsis field to description
- - - - -
1673f54b by David Waern at 2008-01-07T17:18:21+00:00
Change my email address in the cabal file
- - - - -
55aa9808 by David Waern at 2008-01-07T18:18:02+00:00
Add documentation for readInterfaceFile
- - - - -
eaea417f by David Waern at 2008-01-07T18:21:30+00:00
Export necessary stuff from Distribution.Haddock
- - - - -
7ea18759 by David Waern at 2008-01-07T18:31:49+00:00
Remove dep on Cabal
- - - - -
7b79c74e by David Waern at 2008-01-07T18:33:49+00:00
Remove dep on process
- - - - -
ce3054e6 by David Waern at 2008-01-16T23:01:21+00:00
Add feature-requsts from Henning Thielemann to TODO
- - - - -
0c08f1ec by David Waern at 2008-01-16T23:03:02+00:00
Record a bug in TODO
- - - - -
b04605f3 by David Waern at 2008-01-23T16:59:06+00:00
Add a bug reported by Ross to TODO
- - - - -
5b17c030 by David Waern at 2008-01-23T18:05:53+00:00
A a bug report to TODO
- - - - -
1c993b0d by David Waern at 2008-01-25T16:30:25+00:00
Accept test output
- - - - -
c22fc0d0 by David Waern at 2008-01-25T16:34:49+00:00
Accept test output
- - - - -
4b795811 by David Waern at 2008-01-25T16:38:37+00:00
Change Hidden.hs (test) to use OPTIONS_HADDOCK
- - - - -
c124dbd9 by David Waern at 2008-01-25T16:39:23+00:00
Accept test output
- - - - -
ec6f6eea by David Waern at 2008-01-25T16:42:08+00:00
Add Hidden.html.ref to tests
- - - - -
1dc9610c by David Waern at 2008-02-02T20:50:51+00:00
Add a comment about UNPACK bug in TODO
- - - - -
2d3f7081 by David Waern at 2008-02-09T22:33:24+00:00
Change the representation of DocNames

Ross Paterson reported a bug where links would point to the defining module
instead of the "best" module for an identifier (e.g Int pointing to GHC.Base
instead of Data.Int). This patch fixes this problem by refactoring the way
renamed names are represented. Instead of representing them by:

> data DocName = Link Name | NoLink Name

they are now represented as such:

> data DocName = Documented Name Module | Undocumented Name

and the the link-env looks like this:

> type LinkEnv = Map Name Module

There are several reasons for this. First of all, the bug was caused by
changing the module part of Names during the renaming process, without changing
the Unique field. This caused names to be overwritten during the loading of
.haddock files (which caches names using the NameCache of the GHC session).
So we might create new Uniques during renaming to fix this (but I'm not
sure that would be problem-free). Instead, we just keep the Name and add the
Module where the name is best documented, since it can be useful to keep
the original Name around (for e.g. source-code location info and for users of
the Haddock API).

Also, the names Link/NoLink don't really make sense, since wether to use
links or not is entirely up to the users of DocName.

In the process of following this change into H.Backends.Html I removed the
assumption that binder names are Undocumented (which was just an unnecessary
assumption, the OccName is the only thing needed to render these). This will
probably make it possible to get rid of the renamer and replace it with a
traversal from SYB or Uniplate.

Since DocName has changed, InterfaceFile has changed so this patch also
increments the file-format version. No backwards-compatibility is implemented.

- - - - -
0f28c921 by David Waern at 2008-02-09T23:00:36+00:00
H.GHC.Utils: remove unused imports/exports
- - - - -
0c44cad5 by David Waern at 2008-02-10T00:28:13+00:00
H.GHC.Utils: add some functions that were removed by mistake
- - - - -
e3452f49 by David Waern at 2008-02-10T00:28:48+00:00
Fix some trivial warnings in H.InterfaceFile
- - - - -
a6d74644 by David Waern at 2008-02-10T00:48:06+00:00
Update the version message to fit in small terminals
- - - - -
76c9cd3e by David Waern at 2008-02-10T14:47:39+00:00
Remove bugs from TODO that don't apply anymore since the port
- - - - -
5e10e090 by David Waern at 2008-02-10T15:22:47+00:00
Remove bugs from TODO that weren't actual bugs
- - - - -
fef70878 by David Waern at 2008-02-10T15:23:44+00:00
Remove yet another item from TODO that was not an actual bug
- - - - -
e1af47b8 by David Waern at 2008-02-11T10:25:57+00:00
Bump the version number to 2.1.0

Since the exported datatype DocName has changed, we need to bump the
major version number.

Let's also drop the fourth version component, it's not that useful.

- - - - -
e3be7825 by David Waern at 2008-04-11T14:29:04+00:00
Add a bug to TODO
- - - - -
cb6574be by David Waern at 2008-04-11T16:00:45+00:00
Use the in-place haddock when running tests
- - - - -
c6d7af0d by David Waern at 2008-04-11T16:09:16+00:00
Turn off GHC warnings when running tests
- - - - -
7f61b546 by David Waern at 2008-04-11T17:24:00+00:00
Add a flag for turning off all warnings
- - - - -
883b8422 by David Waern at 2008-04-12T14:02:18+00:00
Fix printing of data binders
- - - - -
2a0db8fc by David Waern at 2008-04-12T18:52:46+00:00
Fix missing parenthesis in constructor args bug
- - - - -
1b3ac3f9 by David Waern at 2008-04-12T18:57:23+00:00
Simplify test suite and add tests
I move all tests into one single directory to simplify things, and add a test
for the last bug that was fixed.

- - - - -
8f178376 by David Waern at 2008-04-12T19:00:15+00:00
Add a script for copying test output to "expected" output
- - - - -
193e3a03 by David Waern at 2008-04-12T19:16:37+00:00
Remove two fixed bugs from TODO
- - - - -
ddc9130c by David Waern at 2008-04-12T19:37:06+00:00
Update test README
- - - - -
956069c0 by David Waern at 2008-05-01T12:16:14+00:00
Update version number in spec and docs
- - - - -
5478621c by David Waern at 2008-05-01T12:28:12+00:00
 Remove claim of backwards compatibility from docs for readInterfaceFile
- - - - -
4a16dea9 by David Waern at 2008-05-01T12:33:04+00:00
Update CHANGES
- - - - -
804216fb by David Waern at 2008-05-01T12:43:16+00:00
Add a synopsis
- - - - -
fd0c84d5 by David Waern at 2008-05-01T12:44:44+00:00
Add Haddock.DocName to the cabal file
- - - - -
9f4a7439 by David Waern at 2008-05-01T12:45:53+00:00
Remove -fglasgow-exts and -fasm
- - - - -
aee7c145 by David Waern at 2008-05-01T12:54:01+00:00
Add LANGUAGE pragmas to source files
- - - - -
9a58428b by David Waern at 2008-05-01T12:54:19+00:00
Add extensions to cabal file
- - - - -
494f1bee by David Waern at 2008-05-01T13:12:09+00:00
Export DocName in the API
- - - - -
c938196b by David Waern at 2008-05-01T13:12:19+00:00
Add hide options to some source files
- - - - -
236e86af by Neil Mitchell at 2008-06-07T20:45:10+00:00
Rewrite the --hoogle flag support
- - - - -
6d910950 by Neil Mitchell at 2008-06-14T10:56:50+00:00
Simplify the newtype/data outputting in Hoogle, as haddock does it automatically
- - - - -
f87a95a8 by Neil Mitchell at 2008-06-14T12:10:18+00:00
Add initial structure for outputting documentation as well, but does not yet output anything
- - - - -
7c3bce54 by Neil Mitchell at 2008-06-14T12:27:07+00:00
Remove <document comment> from the Hoogle output
- - - - -
9504a325 by Neil Mitchell at 2008-06-16T06:33:21+00:00
Default to "main" if there is no package, otherwise will clobber hoogle's hoogle info
- - - - -
4a794a79 by Neil Mitchell at 2008-06-16T06:53:29+00:00
Change packageName to packageStr, as it better reflects the information stored in it
- - - - -
7abc9baf by Neil Mitchell at 2008-06-16T07:09:49+00:00
Add modulePkgInfo to Haddock.GHC.Utils, which gives back package name and version info
- - - - -
8ca11514 by Neil Mitchell at 2008-06-16T07:13:48+00:00
Change Hoogle to take the package name and package version separately
- - - - -
a6da452d by Neil Mitchell at 2008-06-18T11:29:46+00:00
In Hoogle do not list things that are not local to this module
- - - - -
974b76b7 by David Waern at 2008-06-19T18:40:13+00:00
Be more consistent with GHC API naming in H.GHC.Utils
- - - - -
2facb4eb by David Waern at 2008-06-19T19:03:03+00:00
Update test output
- - - - -
c501de72 by David Waern at 2008-06-26T20:26:49+00:00
Use ghc-paths to get the lib dir

The path can still be overridden using the -B flag. It's not longer
required to pass the lib dir to the program that runs the test suite.

- - - - -
ac4c6836 by David Waern at 2008-06-26T20:33:08+00:00
Update CHANGES
- - - - -
9d21c60a by David Waern at 2008-06-26T20:34:53+00:00
Update README
- - - - -
741448f0 by David Waern at 2008-06-26T21:12:57+00:00
Improve wording in the help message
- - - - -
b1b42b11 by David Waern at 2008-06-30T10:16:17+00:00
Rename ForeignType
- - - - -
6d6c2b34 by David Waern at 2008-06-30T10:25:09+00:00
Rename TyFamily
- - - - -
8d1125ed by David Waern at 2008-06-30T10:37:21+00:00
Rename type patterns
- - - - -
7610a4cb by David Waern at 2008-06-30T10:45:07+00:00
Rename associated types
- - - - -
8eeba14c by David Waern at 2008-06-30T10:47:41+00:00
Remove the TODO file now that we have a trac
- - - - -
1af5b25b by David Waern at 2008-07-02T18:19:28+00:00
Render type family declarations (untested)
- - - - -
ceb99797 by David Waern at 2008-07-02T18:24:06+00:00
Remove redundant check for summary when rendering data types
- - - - -
b36a58e0 by David Waern at 2008-07-02T22:01:38+00:00
More support for type families and associated types
Now we just need to render the instances

- - - - -
78784879 by David Waern at 2008-07-07T22:13:58+00:00
Remove filtering of instances
We were filtering out all instances for types with unknown names. This was probably an
attempt to filter out instances for internal types. I am removing the filtering for the
moment, and will try to fix this properly later.


- - - - -
3e758dad by David Waern at 2008-06-30T18:50:30+00:00
Run haddock in-place during testing
- - - - -
d9dab0ce by David Waern at 2008-07-08T21:04:32+00:00
Remove index.html and doc-index.html from output, they should not be versioned
- - - - -
3e6c4681 by David Waern at 2008-07-08T21:06:42+00:00
Update test output following change to instance filtering
- - - - -
e34a3f14 by David Waern at 2008-07-12T16:48:28+00:00
Stop using the map from exported names to declarations

During creation of the interface, we were using two maps: one from 
exported names to declarations, and one from all defined names in the 
module to declarations. The first contained subordinate names while the 
second one didn't. The first map was never used to look up names not 
defined in the associated module, so if we add subordinate names to the
second map, we could use it everywhere. That's that this patch does.

This simplifies code because we don't have to pass around two maps 
everywhere.

We now store the map from locally defined things in the interface
structure instead of the one from exported names.

- - - - -
2e1d2766 by David Waern at 2008-07-12T16:55:21+00:00
Get the all locally defined names from GHC API

We previously had some code to compute all locally defined names in 
a module including subordinate names. We don't need it since we can
get the names from modInfoTyThings in the GHC API.

- - - - -
bf637994 by David Waern at 2008-07-13T13:09:16+00:00
Refactoring in H.Interface.Create

We were creating a doc map, a declaration map and a list of entities
separately by going through the HsGroup. These structures were all used
to build the interface of a module.

Instead of doing this, we can start by creating a list of declarations
from the HsGroup, then collect the docs directly from this list 
(instead of using the list of entities), creating a documentation map.

We no longer need the Entity data type, and we can store a single
map from names to declarations and docs in the interface, instead of
the declaration map and the doc map.

This way, there is only one place where we filter out the declarations
that we don't want, and we can remove a lot of code.

Another advantage of this is that we can create the exports directly
out of the list of declarations when we export the full module contents.
(Previously we did a look up for each name to find the declarations).
This is faster and removes another point where we depend on names to
identify exported declarations, which is good because it eliminates
problems with instances (which don't have names).

- - - - -
547e410e by David Waern at 2008-07-13T13:34:51+00:00
Remove FastString import and FSLIT macro in H.I.Create -- they were unused
- - - - -
693759d1 by David Waern at 2008-07-13T13:36:23+00:00
Remove unused import from H.I.Create
- - - - -
cde6e7fb by David Waern at 2008-07-13T13:51:54+00:00
Small touches
- - - - -
96de8f1d by David Waern at 2008-07-20T11:21:46+00:00
Preparation for rendering instances as separate declarations

We want to be able to render instances as separate declarations. So we remove
the Name argument of ExportDecl, since instances are nameless.

This patch also contains the first steps needed to gather type family instances 
and display them in the backend, but the implementation is far from complete.
Because of this, we don't actually show the instances yet.

- - - - -
b0f824fb by David Waern at 2008-07-20T15:53:08+00:00
Follow changes to ExportDecl in Hoogle
- - - - -
1192eff3 by Neil Mitchell at 2008-06-26T00:28:10+00:00
Change how the Hoogle backend outputs classes, adding the context in
- - - - -
7a0d1464 by Neil Mitchell at 2008-06-26T00:28:46+00:00
Remove the indent utility function from Hoogle backend
- - - - -
3361241b by Neil Mitchell at 2008-06-26T09:45:09+00:00
Add support for Hoogle writing ForeignImport/ForeignExport properly
- - - - -
795ad3bf by Neil Mitchell at 2008-06-26T12:15:25+00:00
Flesh out the Hoogle code to render documentation
- - - - -
23277995 by Neil Mitchell at 2008-06-26T14:56:41+00:00
Fix a bug in the Hoogle backend, unordered lists were being written out <ul>...</u>
- - - - -
db739b27 by Neil Mitchell at 2008-06-26T15:09:54+00:00
Remove any white space around a <li> element
- - - - -
f2e6bb8c by Neil Mitchell at 2008-07-10T15:30:47+00:00
Remove the TODO in the Hoogle HTML generation, was already done
- - - - -
693ec9a3 by Neil Mitchell at 2008-07-10T15:53:00+00:00
Put brackets round operators in more places in the Hoogle output
- - - - -
842313aa by Neil Mitchell at 2008-07-10T16:01:25+00:00
Print type signatures with brackets around the name
- - - - -
cf93deb0 by David Waern at 2008-07-20T17:04:22+00:00
Bump version number to 2.2.0
- - - - -
30e6a8d1 by David Waern at 2008-07-20T17:04:41+00:00
Resolve conflicts in H.B.Hoogle
- - - - -
1f0071c9 by David Waern at 2008-07-23T23:05:01+00:00
Add "all" command to runtests.hs that runs all tests despite failures
- - - - -
f2723023 by David Waern at 2008-07-23T23:08:39+00:00
Update tests/README
- - - - -
c0304a11 by David Waern at 2008-07-23T23:21:15+00:00
Be compatible with GHC 6.8.3
    
The cabal file is converted to use the "new" syntax with explicit Library
and Executable sections.

We define the __GHC_PATCHLEVEL__ symbol using a conditinal cpp-options field
in the cabal file. (Ideally, Cabal would define the symbol for us, like it does
for __GLASGOW_HASKELL__).

We use these symbols to #ifdef around a small difference between 6.8.2 and 6.8.3.
    
Previously, we only supported GHC 6.8.2 officially but the dependencies field
said "ghc <= 6.9". This was just for convenience when testing against the (then 
compatible) HEAD version of GHC, and was left in the release by mistake.
  
Now, we support both GHC 6.8.2 and 6.8.3 and the dependencies field
correctly reflects this.

- - - - -
88a5fe71 by David Waern at 2008-07-23T23:54:16+00:00
Depend on the currently available ghc-paths versions only
- - - - -
8738d97b by David Waern at 2008-07-24T10:50:44+00:00
FIX haskell/haddock#44: Propagate parenthesis level when printing documented types
- - - - -
05339119 by David Waern at 2008-07-24T16:06:18+00:00
Drop unnecessary parenthesis in types, put in by the user
 
We were putting in parenthesis were the user did. Let's remove this since
it just clutters up the types. The types are readable anyway since we print
parens around infix operators and do not rely on fixity levels.
  
When doing this I discovered that we were relying on user parenthesis when
printin types like (a `O` b) c. This patchs fixes this problem so that
parenthesis are always inserted around an infix op application in case it
is applied to further arguments, or if it's an arguments to a type constructor.

Tests are updated.

- - - - -
b3a99828 by David Waern at 2008-07-24T10:19:43+00:00
Print parenthesis around non-atomic banged types

Fixes half of haskell/haddock#44

- - - - -
ab5238e0 by David Waern at 2008-07-24T22:07:49+00:00
Add a reference file for the TypeFamilies test
- - - - -
1941cc11 by David Waern at 2008-07-25T17:15:53+00:00
Simplify definition of pretty and trace_ppr
- - - - -
e3bfa33c by David Waern at 2008-07-25T17:18:27+00:00
Warning messages

Output a warning when filtering out data/type instances and associated types
in instances. We don't show these in the documentation yet, and we need to
let the user know.

- - - - -
9b85fc89 by David Waern at 2008-07-25T17:45:40+00:00
Doc: Mention Hoogle in the Introduction
- - - - -
afb2dd60 by David Waern at 2008-07-25T17:49:00+00:00
Doc: update -B description
- - - - -
584c0c91 by David Waern at 2008-07-25T18:11:38+00:00
Doc: describe -w flag
- - - - -
77619c24 by David Waern at 2008-07-28T12:29:07+00:00
Remove TODO from cabal file
- - - - -
96717d5f by David Waern at 2008-07-28T12:29:27+00:00
Support type equality predicates
- - - - -
c2fd2330 by David Waern at 2008-07-29T19:45:14+00:00
Move unL from H.B.Hoogle to H.GHC.Utils

I like Neil's shorter unL better than unLoc from the GHC API.

- - - - -
c4c3bf6a by David Waern at 2008-07-29T19:47:36+00:00
Do not export ATs when not in list of subitems
- - - - -
bf9a7b85 by David Waern at 2008-08-03T11:42:59+00:00
Filter out ForeignExports
- - - - -
df59fcb0 by David Waern at 2008-08-03T14:02:51+00:00
Filter out more declarations

The previous refactorings in H.I.Create introduced a few bugs. Filtering
of some types of declarations that we don't handle was removed. This patch
fixes this.

- - - - -
2f8a958b by David Waern at 2008-08-03T15:24:07+00:00
Move reL to H.GHC.Utils so we can use it everywhere
- - - - -
8ec15efd by David Waern at 2008-08-03T15:25:00+00:00
 Use isVanillaLSig from GHC API instead of home brewn function
- - - - -
300f93a2 by David Waern at 2008-08-03T15:25:27+00:00
Filter out separately exported ATs

This is a quick and dirty hack to get rid of separately exported ATs.
We haven't decided how to handle them yet. No warning message is given.

- - - - -
8776d1ec by David Waern at 2008-08-03T16:21:21+00:00
Filter out more declarations and keep only vanilla type sigs in classes
- - - - -
ea07eada by David Waern at 2008-08-03T16:48:00+00:00
Fix layout
- - - - -
dd5e8199 by David Waern at 2008-08-03T16:50:52+00:00
Move some utility functions from H.I.Create to H.GHC.Utils
- - - - -
4a1dbd72 by David Waern at 2008-08-03T17:39:55+00:00
Do not filter out doc declarations
- - - - -
0bc8dca4 by David Waern at 2008-08-03T17:47:26+00:00
Filter out separately exported ATs (take two)
- - - - -
af970fe8 by David Waern at 2008-08-03T22:39:17+00:00
Update CHANGES
- - - - -
5436ad24 by David Waern at 2008-08-03T22:40:20+00:00
Bump version number to 2.2.1
- - - - -
d66de448 by David Waern at 2008-08-05T19:00:32+00:00
Remove version restriction on ghc-paths
- - - - -
534b1364 by David Waern at 2008-08-05T19:04:35+00:00
Bump version to 2.2.2 and update CHANGES
- - - - -
549188ff by David Waern at 2008-08-05T19:16:49+00:00
Fix CHANGES
- - - - -
0d156bb4 by Luke Plant at 2008-08-11T15:20:59+00:00
invoking haddock clarification and help
- - - - -
748295cc by David Waern at 2008-08-11T18:56:37+00:00
Doc: say that the --hoogle option is functional
- - - - -
43301db4 by David Waern at 2008-08-05T19:26:08+00:00
Change ghc version dependency to >= 6.8.2
- - - - -
3e5a53b6 by David Waern at 2008-08-10T22:42:05+00:00
Make H.GHC.Utils build with GHC HEAD
- - - - -
7568ace0 by David Waern at 2008-08-11T19:41:54+00:00
Import Control.OldException instead of C.Exception when using ghc >= 6.9

We should really test for base version instead, but I don't currently
know which version to test for.

- - - - -
b71ae991 by David Waern at 2008-08-12T22:40:39+00:00
Make our .haddock file version number depend on the GHC version

We need to do this, since our .haddock format can potentially
change whenever GHC's version changes (even when only the patchlevel
changes).

- - - - -
6307ce3f by David Waern at 2008-08-12T22:49:57+00:00
Remove matching on NoteTy in AttachInstances, it has been removed
- - - - -
2dbcfd5f by David Waern at 2008-08-12T23:02:02+00:00
Comment out H.GHC.loadPackages - it is unused and doesn't build with ghc >= 6.9
- - - - -
c74db5c2 by David Waern at 2008-08-12T23:03:58+00:00
Hide <.> from GHC import in Hoogle only for ghc <= 6.8.3
- - - - -
69a44ebb by David Waern at 2008-08-12T23:11:12+00:00
Follow changes to parseDynamic/StaticFlags
- - - - -
5881f3f0 by David Waern at 2008-08-13T21:43:58+00:00
Add __GHC_PATCHLEVEL__ symbol also when building the library
- - - - -
8574dc11 by David Waern at 2008-08-13T21:44:17+00:00
Follow move of package string functions from PackageConfig to Module
- - - - -
c9baa77f by David Waern at 2008-08-13T21:45:29+00:00
Follow extensible exceptions changes
- - - - -
9092de15 by David Waern at 2008-08-13T21:46:20+00:00
Update test following Haddock version change
- - - - -
ebe569a4 by David Waern at 2008-08-13T21:46:54+00:00
Follow changes to parseDynamic- parseStaticFlags in GHC
- - - - -
b8a5ffd3 by David Waern at 2008-08-13T21:47:36+00:00
Follow changes to Binary in GHC 6.9
- - - - -
edfda1cc by David Waern at 2008-08-13T21:50:17+00:00
Change ghc version dependency to >= 6.8.2 && <= 6.9
- - - - -
d59be1cf by Neil Mitchell at 2008-08-12T16:02:53+00:00
Output all items, even if they are not defined in this module - ensures map comes from Prelude, not just GHC.Base
- - - - -
dda93b9f by Neil Mitchell at 2008-08-12T21:37:32+00:00
Add support for type synonyms to Hoogle, was accidentally missing before (woops!)
- - - - -
b6ee795c by Neil Mitchell at 2008-08-13T14:03:24+00:00
Generalise Hoogle.doc and add a docWith
- - - - -
415e1bb2 by Neil Mitchell at 2008-08-13T14:03:46+00:00
Make Hoogle add documentation to a package
- - - - -
790a1202 by Neil Mitchell at 2008-08-18T12:52:43+00:00
Use the same method to put out signatures as class methods in the Hoogle backend
- - - - -
ded37eba by Neil Mitchell at 2008-08-18T12:53:04+00:00
Remove Explicit top-level forall's when pretty-printing signatures
- - - - -
6468c722 by Neil Mitchell at 2008-08-20T07:59:13+00:00
Simplify the code by removing not-to-important use of <.> in the Hoogle back end
- - - - -
788c3a8b by Neil Mitchell at 2008-08-21T18:20:24+00:00
In the hoogle back end, markup definition lists using <i>, not <b>
- - - - -
77d4b000 by Ian Lynagh at 2008-08-14T10:49:14+00:00
Add a Makefile for GHC's build system. Still won't work yet, but we're closer
- - - - -
920440d7 by Ian Lynagh at 2008-08-27T18:06:46+00:00
Add haddock.wrapper
- - - - -
bcda925f by Ian Lynagh at 2008-08-27T18:07:02+00:00
Add a manual Cabal flag to control the ghc-paths dependency
- - - - -
04d194e2 by Ian Lynagh at 2008-08-27T20:41:27+00:00
Update extensions in Cabal file
Use ScopedTypeVariables instead of PatternSignatures

- - - - -
12480043 by Ian Lynagh at 2008-08-27T20:41:55+00:00
Increase the upper bound on the GHC version number
- - - - -
b1f809a5 by Ian Lynagh at 2008-08-27T21:32:22+00:00
Fix some warnings
- - - - -
aea0453d by Ian Lynagh at 2008-08-28T14:22:29+00:00
Fixes for using haddock in a GHC build tree
- - - - -
ad23bf86 by Ian Lynagh at 2008-08-28T21:14:27+00:00
Don't use Cabal wrappers on Windows
- - - - -
35858e4c by Ian Lynagh at 2008-08-29T00:07:42+00:00
Fix in-tree haddock on Windows
- - - - -
c2642066 by Ian Lynagh at 2008-09-03T22:35:53+00:00
follow library changes
- - - - -
2eb55d50 by Ian Lynagh at 2008-09-07T18:52:51+00:00
bindist fixes
- - - - -
3daa5b59 by Ian Lynagh at 2008-09-10T16:58:18+00:00
We need to tell haddock that its datasubdir is . or it can't find package.conf
- - - - -
388fd8c2 by Ian Lynagh at 2008-09-10T19:47:44+00:00
Fix haddock inplace on Windows
- - - - -
70a641c1 by Ian Lynagh at 2008-09-10T22:15:44+00:00
Fix installed haddock on Windows
- - - - -
83c1e997 by Neil Mitchell at 2008-09-11T10:48:55+00:00
Import GHC.Paths if not IN_GHC_TREE, seems to match the use of GHC.Paths functions much better
- - - - -
b452519b by Ian Lynagh at 2008-09-12T12:58:24+00:00
Add a LANGUAGE ForeignFunctionInterface pragma
- - - - -
afbd592c by Ian Lynagh at 2008-09-12T12:59:13+00:00
Wibble imports
- - - - -
547ac4ad by Ian Lynagh at 2008-09-14T15:34:22+00:00
Add a "#!/bin/sh" to haddock.wrapper
- - - - -
f207a807 by Ian Lynagh at 2008-09-15T10:02:32+00:00
Use "exec" when calling haddock in the wrapper
- - - - -
2ee68509 by Thomas Schilling at 2008-09-15T09:09:16+00:00
Port Haddock.Interface to new GHC API.

This required one bigger change: 'readInterfaceFile' used to take an
optional 'Session' argument.  This was used to optionally update the
name cache of an existing GHC session.  This does not work with the
new GHC API, because an active session requires the function to return
a 'GhcMonad' action, but this is not possible if no session is
provided.

The solution is to use an argument of functions for reading and
updating the name cache and to make the function work for any monad
that embeds IO, so it's result type can adapt to the calling context.

While refactoring, I tried to make the code a little more
self-documenting, mostly turning comments into function names.

- - - - -
3bb96431 by Thomas Schilling at 2008-09-15T09:09:37+00:00
Reflect GHC API changes.
- - - - -
2e60f714 by Thomas Schilling at 2008-09-15T09:10:37+00:00
Port Haddock.GHC.Typecheck to new GHC API.
- - - - -
9cfd4cff by Thomas Schilling at 2008-09-15T09:11:00+00:00
Port Haddock.GHC to new GHC API.
- - - - -
caffa003 by Thomas Schilling at 2008-09-15T09:11:25+00:00
Port Main to new GHC API.
- - - - -
069a4608 by Ian Lynagh at 2008-09-21T11:19:00+00:00
Fix paths used on Windows frmo a GHC tree: There is no whare directory
- - - - -
7ceee1f7 by Ian Lynagh at 2008-09-21T12:20:16+00:00
Fix the in-tree haddock on Windows
- - - - -
0d486514 by Ian Lynagh at 2008-09-23T18:06:58+00:00
Increase the GHC upper bound from 6.11 to 6.13
- - - - -
f092c414 by Neil Mitchell at 2008-09-11T14:56:07+00:00
Do not wrap __ in brackets
- - - - -
036bdd13 by Ian Lynagh at 2008-09-28T01:42:35+00:00
Fix building haddock when GhcProfiled=YES
- - - - -
01434a89 by David Waern at 2008-09-24T20:24:21+00:00
Add PatternSignatures LANGUAGE pragma to Main and Utils
- - - - -
1671a750 by David Waern at 2008-10-02T22:57:25+00:00
For source links, get original module from declaration name instead of environment.

Getting it from the environment must have been a remnant from the
times when we were using unqualified names (versions 0.x).

- - - - -
a25dde99 by David Waern at 2008-10-02T22:59:57+00:00
Remove ifaceEnv from Interface - it's no longer used
- - - - -
610993da by David Waern at 2008-10-02T23:04:58+00:00
Write a comment about source links for type instance declarations
- - - - -
5a96b5d5 by Thomas Schilling at 2008-10-03T10:45:08+00:00
Follow GHC API change of parseModule.
- - - - -
5a943ae5 by Ian Lynagh at 2008-10-03T15:56:58+00:00
TAG 2008-10-03
- - - - -
76cdd6ae by Thomas Schilling at 2008-10-08T12:29:50+00:00
Only load modules once when typechecking with GHC.
  
This still doesn't fix the memory leak since the typechecked source is
retained and then processed separately.  To fix the leak, modules must
be processed directly after typechecking.

- - - - -
7074d251 by David Waern at 2008-10-09T23:53:54+00:00
Interleave typechecking with interface creation

At the same time, we fix a bug where the list of interfaces were
processed in the wrong order, when building the links and renaming
the interfaces.

- - - - -
4b9b2b2d by David Waern at 2008-10-09T23:54:49+00:00
Add some strictness annotations in Interface

We add some strictness annotations to the fields of Interface,
so that less GHC data is hold on to during processing.

- - - - -
22035628 by David Waern at 2008-10-10T20:02:31+00:00
Remove typecheckFiles and MonadUtils import from H.GHC.Typeccheck
- - - - -
be637ad3 by David Waern at 2008-10-10T20:33:38+00:00
Make Haddock build with GHC 6.8.2
- - - - -
523b3404 by David Waern at 2008-10-10T21:08:09+00:00
Fix documentation for createInterfaces
- - - - -
e1556702 by David Waern at 2008-10-10T21:26:19+00:00
Hide H.Utils in library
- - - - -
a8e751c3 by David Waern at 2008-10-10T21:34:59+00:00
Add back .haddock file versioning based on GHC version

It was accidentally removed in the patch for GHC 6.8.2 compatibility

- - - - -
06fb3c01 by David Waern at 2008-10-10T21:47:15+00:00
Bump version number to 2.3.0
- - - - -
ff087fce by David Waern at 2008-10-10T22:35:49+00:00
Add support for DocPic

The support for DocPic was merged into the GHC source long ago,
but the support in Haddock was forgotten. Thanks Peter Gavin for
submitting this fix!

- - - - -
3af85bf6 by David Waern at 2008-10-10T23:34:05+00:00
Update tests
- - - - -
0966873c by Simon Marlow at 2008-10-10T14:43:04+00:00
no need for handleErrMsg now, we don't throw any ErrMsgs
- - - - -
f1870de3 by Clemens Fruhwirth at 2008-10-10T13:29:36+00:00
Compile with wrapper but remove it for dist-install
- - - - -
7b440dc2 by David Waern at 2008-10-11T14:02:25+00:00
Remove interface from LinksInfo

It was there to know the documentation home module when creating
a wiki link, but we already know this since we have the DocName.

- - - - -
e5729e6a by David Waern at 2008-10-15T20:49:18+00:00
Wibble
- - - - -
b2a8e01a by David Waern at 2008-10-15T21:03:36+00:00
Use type synonyms for declarations and docs in H.I.Create
- - - - -
be71a15b by David Waern at 2008-10-15T21:12:17+00:00
Comment out unused type family stuff completely
- - - - -
91aaf075 by David Waern at 2008-10-15T21:49:04+00:00
Wibble
- - - - -
42ba4eb4 by David Waern at 2008-10-15T21:53:53+00:00
Move convenient type synonym to H.Types
- - - - -
db11b723 by David Waern at 2008-10-15T22:14:07+00:00
Add DeclInfo to H.Types
- - - - -
193552b6 by David Waern at 2008-10-15T22:15:01+00:00
Add subordinates with docs to the declaration map

The only place in the code where we want the subordinates for a declaration is
right after having looked up the declaration in the map.

And since we include subordinates in the map, we might as well take the
opportunity to store those subordinates that belong to a particular declaration
together with that declaration.

We also store the documentation for each subordinate.

- - - - -
31e6eebc by David Waern at 2008-10-16T17:18:47+00:00
Wibble
- - - - -
0dcbd79f by David Waern at 2008-10-16T20:58:42+00:00
Fix haskell/haddock#61

We were not getting docs for re-exported class methods. This was because we
were looking up the docs in a map made from the declarations in the current
module being rendered. Obviously, re-exported class methods come from another
module.

Class methods and ATs were the only thing we were looking up using the doc map,
everything else we found in the ExporItems. So now I've put subordinate docs
in the ExportItem's directly, to make things a bit more consistent.

To do this, I added subordinates to the the declarations in the declaration
map. This was easy since we were computing subordinates anyway, to store
stand-alone in the map. I added a new type synonym 'DeclInfo', which is what we
call what is now stored in the map. 

This little refactoring removes duplicate code to retrieve subordinates and
documentation from the HsGroup.

- - - - -
de47f20a by David Waern at 2008-10-16T22:06:35+00:00
Document function and improve its layout
- - - - -
e74e625a by Thomas Schilling at 2008-10-20T11:12:57+00:00
Force interface more aggressively.

For running Haddock on GHC this reduces memory usage by about 50 MB on
a 32 bit system.  A heap profile shows total memory usage peak at
about 100 MB, but actual usage is at around 300 MB even with
compacting GC (+RTS -c).

- - - - -
b63ac9a1 by David Waern at 2008-10-20T20:25:50+00:00
Make renamer consistent

Instead of explicitly making some binders Undocumented, treat all names the
same way (that is, try to find a Documented name).

- - - - -
f6de0bb0 by Ian Lynagh at 2008-09-19T00:54:43+00:00
TAG GHC 6.10 fork
- - - - -
74599cd0 by David Waern at 2008-10-20T21:13:24+00:00
Do not save hidden modules in the .haddock file

We were saving interfaces of all processed modules including those hidden using
{-# OPTIONS_HADDOCK hide #-} in the .haddock file. This caused broken links
when generating the index for the libraries that come with GHC.

This patch excludes modules with hidden documentation when writing .haddock
files. It should fix the above problem. 

- - - - -
7b6742e9 by David Waern at 2008-10-21T19:54:52+00:00
Do not save hidden modules in the .haddock file (also for ghc >= 6.9)

When writing the first patch, I forgot to do the fix in both branches of an #if
macro.

- - - - -
b99b1951 by David Waern at 2008-10-22T20:04:18+00:00
Remove subordinate map and its usage

It is not needed now that we store subordinate names in the DeclInfo map.

- - - - -
da97cddc by David Waern at 2008-10-22T20:11:46+00:00
Tidy up code in H.I.Create a little

Remove commented out half-done type instance support, and remove DeclWithDoc
synonym.

- - - - -
6afa76f3 by David Waern at 2008-10-22T21:17:29+00:00
Fix warnings in H.GHC.Utils
- - - - -
171ea1e8 by David Waern at 2008-10-22T21:35:04+00:00
Fix warnings in H.Utils
- - - - -
c8cb3b91 by David Waern at 2008-10-22T21:36:49+00:00
Wibble
- - - - -
767fa06a by David Waern at 2008-10-27T19:59:04+00:00
Make named doc comments into ExportDoc instead of ExportDecl

Fixes a crash when processing modules without export lists containing named
docs.

- - - - -
e638bbc6 by David Waern at 2008-11-02T22:21:10+00:00
Add HCAR entry
- - - - -
92b4ffcf by David Waern at 2008-11-02T22:44:19+00:00
Update CHANGES
- - - - -
84d4da6e by David Waern at 2008-11-03T11:25:04+00:00
Add failing test for template haskell crash
- - - - -
2a9cd2b1 by David Waern at 2008-11-04T21:13:44+00:00
Add tests/TH.hs
- - - - -
8a59348e by David Waern at 2008-11-04T21:30:26+00:00
TAG 2.3.0
- - - - -
54f70d31 by Thomas Schilling at 2008-10-24T17:04:08+00:00
Enable framed view of the HTML documentation.

This patch introduces:

 - A page that displays the documentation in a framed view.  The left
   side will show a full module index.  Clicking a module name will
   show it in the right frame.  If Javascript is enabled, the left
   side is split again to show the modules at the top and a very short
   synopsis for the module currently displayed on the right.

 - Code to generate the mini-synopsis for each module and the mini
   module index ("index-frames.html").

 - CSS rules for the mini-synopsis.

 - A very small amount of javascript to update the mini-synopsis (but
   only if inside a frame.)

Some perhaps controversial things:

 - Sharing code was very difficult, so there is a small amount of code
   duplication.

 - The amount of generated pages has been doubled, since every module
   now also gets a mini-synopsis.  The overhead should not be too
   much, but I haven't checked.  Alternatively, the mini-synopsis
   could also be generated using Javascript if we properly annotate
   the actual synopsis.

- - - - -
5d7ea5a6 by David Waern at 2008-11-04T23:20:17+00:00
Follow change to ExportDecl in frames code
- - - - -
60e16308 by David Waern at 2008-11-04T23:35:26+00:00
Update CHANGES
- - - - -
d63fd26d by David Waern at 2008-11-04T23:37:43+00:00
Bump version number
- - - - -
c1660c39 by David Waern at 2008-11-04T23:44:46+00:00
Update CHANGES
- - - - -
995ab384 by David Waern at 2008-11-04T23:55:21+00:00
Remove .ref files from tests/output/
- - - - -
1abbbe75 by David Waern at 2008-11-04T23:57:41+00:00
Output version info before running tests
- - - - -
649b182f by David Waern at 2008-11-05T22:45:37+00:00
Add ANNOUNCE message
- - - - -
c36ae0bb by David Waern at 2008-11-05T23:15:35+00:00
Update ANNOUNCE
- - - - -
9c4f3d40 by David Waern at 2008-11-05T23:18:30+00:00
Wibble
- - - - -
5aac87ce by David Waern at 2008-11-06T21:07:48+00:00
Depend on base 4.* when using GHC >= 6.9, otherwise 3.*
- - - - -
b9796a74 by David Waern at 2008-11-06T21:13:40+00:00
Bump version to 2.4.1 and update CHANGES
- - - - -
d4b26baa by David Waern at 2008-11-06T21:26:33+00:00
Depend on base 4.0.* instead of 4.*
- - - - -
2cb0903c by David Waern at 2008-11-06T21:46:53+00:00
Fix warnings in H.B.HH and H.B.HH2
- - - - -
e568e89a by David Waern at 2008-11-06T21:47:12+00:00
Fix warnings in Haddock.ModuleTree
- - - - -
9dc14fbd by David Waern at 2008-11-06T21:47:52+00:00
Fix warnings in Haddock.Version
- - - - -
02ac197c by David Waern at 2008-11-06T21:51:31+00:00
Fix warnings in H.InterfaceFile and H.Options
- - - - -
63e7439a by David Waern at 2008-11-06T21:59:45+00:00
Fix warnings in H.GHC.Typecheck
- - - - -
4bca5b68 by David Waern at 2008-11-08T13:43:42+00:00
Set HscTarget to HscNothing instead of HscAsm

There used to be a bug in the GHC API that prevented us from setting this
value.

- - - - -
07357aec by David Waern at 2008-11-09T22:27:00+00:00
Re-export NameCache and friends from Distribution.Haddock
- - - - -
ea554b5a by David Waern at 2008-11-09T23:14:10+00:00
Add Haddock.GHC.Utils to other-modules in library
- - - - -
74aecfd7 by David Waern at 2008-11-10T01:18:57+00:00
Export DocName in the library
- - - - -
241a58b3 by David Waern at 2008-11-10T01:19:18+00:00
Document the functions in H.DocName
- - - - -
edc2ef1b by David Waern at 2008-11-10T01:20:52+00:00
Export H.DocName in the library
- - - - -
4f588d55 by David Waern at 2008-11-10T01:29:14+00:00
Make DocName an instance of NamedThing
- - - - -
b4647244 by David Waern at 2008-11-15T22:58:18+00:00
Reflect version bump in test suite
- - - - -
4bee8ce2 by David Waern at 2008-11-15T22:58:45+00:00
Update tests

For unknown reasons, test output for Bug1 and Test has changed for the better.

- - - - -
1690e2f9 by David Waern at 2008-11-15T22:59:33+00:00
Store hidden modules in .haddock files

We store documentation for an entity in the 'InstalledInterface' of the
definition site module, and never in the same structure for a module which
re-exports the entity. So when a client of the Haddock library wants to look up
some documentation, he/she might need to access a hidden module. But we
currently don't store hidden modules in the .haddock files.

So we add the hidden modules and the Haddock options to the .haddock files.
The options will be used to filter the module list to obtain the visible
modules only, which is necessary for generating the contents and index for
installed packages.

- - - - -
8add6435 by David Waern at 2008-11-16T14:35:50+00:00
Bump major version number due to .haddock file format change
- - - - -
48bfcf82 by David Waern at 2008-11-23T14:32:52+00:00
Update tests to account for version number bump
- - - - -
0bbd1738 by David Waern at 2008-11-23T14:33:31+00:00
HADDOCK_DATA_DIR changed to haddock_datadir
- - - - -
5088b78c by David Waern at 2008-11-23T17:13:21+00:00
FIX haskell/haddock#45: generate two anchors for each name

We generate two anchor tags for each name, one where we don't escape the name
and one where we URI-encode it. This is for compatibility between IE and Opera.
Test output is updated.

- - - - -
5ee5ca3b by Neil Mitchell at 2008-11-27T14:38:11+00:00
Drop HsDocTy annotations, they mess up pretty printing and also have a bracketing bug (#2584)
- - - - -
51c014e9 by Roman Cheplyaka at 2008-11-27T22:27:36+00:00
Allow referring to a specific section within a module in a module link
Fixes haskell/haddock#65

- - - - -
4094bdc5 by David Waern at 2008-11-28T21:13:33+00:00
Update tests following anchor change
- - - - -
f89552dd by Thomas Schilling at 2008-11-29T16:16:20+00:00
Haddock really shouldn't try to overwrite files.
- - - - -
98127499 by David Waern at 2008-12-07T14:09:15+00:00
Solve conflict
- - - - -
319356c5 by David Waern at 2008-10-22T21:16:55+00:00
Add -Wall -Werror to ghc-options
- - - - -
3c4968c9 by David Waern at 2008-11-04T23:38:56+00:00
TAG 2.4.0
- - - - -
4b21e003 by David Waern at 2008-11-06T21:14:04+00:00
TAG 2.4.1
- - - - -
8e0cad5c by David Waern at 2008-12-07T14:12:54+00:00
Remove -Werror
- - - - -
299d6deb by David Waern at 2008-12-07T14:25:18+00:00
Remove -Wall, we'll focus on warnings after 6.10.2 is out
- - - - -
5f4216b6 by David Waern at 2008-12-07T20:58:05+00:00
Resolve conflict properly
- - - - -
67d774e7 by Neil Mitchell at 2008-12-15T11:44:26+00:00
Make forall's in constructors explicit, i.e. data Foo = Foo {foo :: Eq a => a}
- - - - -
61851792 by Neil Mitchell at 2008-12-18T15:39:39+00:00
Try and find a better package name than "main" for Hoogle, goes wrong when working on an executable rather than a library
- - - - -
2fab8554 by David Waern at 2008-12-08T23:19:48+00:00
Make visible names from ExportItems

Instead of a complicated calculation of visible names out of GHC's export
items, we can get them straight out of the already calculated ExportItems.  The
ExportItems should represent exactly those items that are visible in an
interface. 

If store all the exported sub-names in ExportDecl instead of only those with
documentation, the calculation becomes very simple. So we do this change as
well (should perhaps have been a separate patch).
 
This should fix the problem with names from ghc-prim not appearing in the link
environment.

- - - - -
7caadd8c by Ian Lynagh at 2008-12-11T17:01:04+00:00
Wrap the GHC usage with defaultCleanupHandler
This fixes a bug where haddock leaves /tmp/ghc* directories uncleaned.

- - - - -
7c9fc9a5 by David Waern at 2009-01-02T21:38:27+00:00
Show re-exported names from external packages again

This fixes GHC ticket 2746.

In order to also link to the exported subordinate names of a declaration, we
need to re-introduce the sub map in the .haddock files.

- - - - -
119e4e05 by David Waern at 2009-01-06T23:34:17+00:00
Do not process boot modules

We should of course not try to produce documentation for boot modules! The
reason this has worked in the past is that the output of "real" modules
overwrites the output of boot modules later in the process. However, this
causes a subtle link environment problem. So let's get rid of this stupid
behaviour.
  
We avoid processing boot modules, but we continue to typecheck them.

- - - - -
c285b9d2 by David Waern at 2009-01-08T18:03:36+00:00
Export modules also when coming from external packages

This seems to have regressed since a refactoring that was
part of the 2.3.0 release.

- - - - -
24031c17 by David Waern at 2009-01-10T15:26:26+00:00
Change version to 2.4.2 - no need to go to 2.5.0
- - - - -
864d1c3f by David Waern at 2009-01-10T15:35:20+00:00
Update tests to account for version number change
- - - - -
524ba886 by David Waern at 2009-01-10T18:29:17+00:00
Add test for Template Haskell splicing
- - - - -
05e6e003 by David Waern at 2009-01-10T19:35:42+00:00
Fix Trac haskell/haddock#68: Turn on compilation via C for Template Haskell packages

We can't use HscNothing if we need to run code coming from modules inside
the processed package during typechecking, which is the case for some packages
using Template Haskell. This could be improved, to e.g. use HscInterpreted and
HscNothing where possible, instead of using HscC for all modules in the
package.

- - - - -
2b2bafa1 by David Waern at 2009-01-10T20:22:25+00:00
Only use needsTemplateHaskell when compiling with GHC 6.10.2 or above
- - - - -
bedc3a93 by Ian Lynagh at 2009-01-11T14:58:41+00:00
Fix the location of INPLACE_PKG_CONF; fixes the build
Spotted by Conal Elliott

- - - - -
943107c8 by David Waern at 2009-01-20T19:27:39+00:00
Document H.I.Create.collectDocs better
- - - - -
c6252e37 by David Waern at 2009-01-20T19:29:51+00:00
Fix Trac haskell/haddock#59: TH-generated declarations disappearing

This patch was contributed by Joachim Breitner (nomeata).

- - - - -
3568a6af by David Waern at 2009-01-21T21:41:48+00:00
Do not indicate that a constructor argument is unboxed

We only show the strictness annotation for an unboxed constructor argument. The
fact that it is unboxed is an implementation detail and should not be part of
the module interface.

- - - - -
562a4523 by David Waern at 2009-01-22T18:53:49+00:00
Fix Trac haskell/haddock#50: do not attach docs to pragmas or other kinds of non-declarations

We now filter out everything that is not a proper Haskell declaration before
collecting the docs and attaching them to declarations.

- - - - -
6fdf21c2 by David Waern at 2009-01-22T19:48:09+00:00
Add test for quasi quotation. No reference output yet.
- - - - -
dc4100fd by David Waern at 2009-01-22T19:57:47+00:00
Improve quasi-quotation test and add reference output
- - - - -
908b74bb by David Waern at 2009-01-23T23:22:03+00:00
Filter out separately exported associated types in a smarter way
- - - - -
f6b42ecb by David Waern at 2009-01-24T16:54:39+00:00
Correct spelling mistake in error message
- - - - -
24e4245d by David Waern at 2009-01-24T17:48:03+00:00
Correct comment
- - - - -
b5e8462f by David Waern at 2009-02-07T13:22:29+00:00
Do not show a subordinate at the top level if its parent is also exported

See note in the source code for more info.

- - - - -
4b09de57 by David Waern at 2009-02-07T13:53:53+00:00
Update test following change to top level subordinates
- - - - -
76379896 by David Waern at 2009-02-07T13:58:04+00:00
Remove html files in the tests/output/ directory which have been accidentally added
- - - - -
1a6d8b10 by Joachim Breitner at 2009-02-20T10:29:43+00:00
Typo in comment
- - - - -
fec367d0 by David Waern at 2009-02-24T20:21:17+00:00
Fix small bug

The rule is to prefer type constructors to other things when an identifier in a
doc string can refer to multiple things. This stopped working with newer GHC
versions (due to a tiny change in the GHC renamer). We implement this rule
in the HTML backend for now, instead of fixing it in GHC, since we will move
renaming of doc strings to Haddock in the future anyway. 

- - - - -
9b4172eb by David Waern at 2009-02-25T20:04:38+00:00
Fix bad error handling with newer GHCs

When support for GHC 6.10 was added, an error handler was installed only around
the typechecking phase. This had the effect that errors thrown during
dependency chasing were caught in the top-level exception handler and not
printed with enough detail.  With this patch we wrap the error handler around
all our usage of the Ghc monad. 

- - - - -
de2df363 by Simon Peyton Jones at 2009-02-02T16:47:42+00:00
Hide funTyConName, now exported by TypeRep
- - - - -
4d40a29f by Ian Lynagh at 2009-02-12T18:57:49+00:00
Don't build the library when building in the GHC tree
- - - - -
1cd0abe4 by Ian Lynagh at 2009-02-13T13:58:53+00:00
Add a ghc.mk
- - - - -
3d814eeb by Ian Lynagh at 2009-02-13T18:50:28+00:00
do .depend generation for haddock with the stage1 compiler
This is a bit of a hack. We mkdepend with stage1 as if .depend
depends on the stage2 compiler then make goes wrong: haddock's
.depend gets included, which means that make won't reload until
it's built, but we can't build it without the stage2 compiler. We
therefore build the stage2 compiler before its .depend file is
available, and so compilation fails.

- - - - -
b55036a4 by Ian Lynagh at 2009-02-25T01:38:13+00:00
Give haddock a wrapper on unix in the new GHC build system
- - - - -
9eabfe68 by Ian Lynagh at 2009-02-25T19:21:32+00:00
Create inplace/lib/html in the new GHC build system
- - - - -
93af30c7 by Ian Lynagh at 2008-11-07T19:18:23+00:00
TAG GHC 6.10.1 release
- - - - -
06e6e34a by Thomas Schilling at 2009-02-24T18:11:00+00:00
Define __GHC_PATCHLEVEL__ for recent version of GHC (stable).
- - - - -
680e6ed8 by Thomas Schilling at 2009-02-24T18:12:26+00:00
'needsTemplateHaskell' is not defined in current stable GHC.
- - - - -
6c5619df by David Waern at 2009-02-25T22:15:23+00:00
Hide fynTyConName only for recent GHC versions
- - - - -
6b2344f1 by Ian Lynagh at 2009-02-26T00:49:56+00:00
Add the module to one of haddocks warnings
- - - - -
e5d11c70 by David Waern at 2009-02-27T21:37:20+00:00
Bug fix
We tried to filter out subordinates that were already exported through their parent.

This didn't work properly since we were in some cases looking at the
grand-parent and not the parent.  We now properly compute all the parent-child
relations of a declaration, and use this information to get the parent of a
subordinate.

We also didn't consider record fields with multiple parents. This is now
handled correctly.

We don't currently support separately exported associated types. But when we
do, they should be handled correctly by this process too.

Also slightly improved the warning message that we give when filtering out
subordinates.

- - - - -
10a79a60 by David Waern at 2009-02-27T22:08:08+00:00
Fix error message conflict

The module name is already written in the beginning of the message, as
seems to be the convention in Haddock. Perhaps not so clear, but we
should change it everywhere in that case. Leaving it as it is for now.

- - - - -
c5055c7f by David Waern at 2009-02-27T22:15:17+00:00
Shorten warning message
- - - - -
a72fed3a by David Waern at 2009-02-28T00:53:55+00:00
Do not show package name in warning message
- - - - -
a5daccb2 by Ian Lynagh at 2009-03-01T14:59:35+00:00
Install haddock in the new GHC build system
- - - - -
dfdb025c by Ian Lynagh at 2009-03-07T23:56:29+00:00
Relax base dependency to < 4.2, not < 4.1
- - - - -
5769c8b4 by David Waern at 2009-03-21T14:58:52+00:00
Bump .haddock file version number (due to change of format)
- - - - -
f1b8f67b by David Waern at 2009-03-21T14:59:26+00:00
Define __GHC_PATCHLEVEL__=1 when using ghc-6.10.1
- - - - -
23f78831 by David Waern at 2009-03-21T16:40:52+00:00
Update CHANGES
- - - - -
7d2735e9 by David Waern at 2009-03-21T16:50:33+00:00
Update ANNOUNCE
- - - - -
0771e00a by David Waern at 2009-03-21T16:54:40+00:00
Update ANNOUNCE, again
- - - - -
81a6942a by David Waern at 2009-03-21T17:50:06+00:00
Don't be too verbose in CHANGES
- - - - -
29861dcf by David Waern at 2009-03-21T18:03:31+00:00
TAG 2.4.2
- - - - -
a585f285 by David Waern at 2009-03-21T19:20:29+00:00
Require Cabal >= 1.2.3
- - - - -
7c611662 by David Waern at 2009-03-21T19:21:48+00:00
TAG 2.4.2 with cabal-version >= 1.2.3
- - - - -
23b7deff by Simon Marlow at 2009-03-20T15:43:42+00:00
new GHC build system: use shell-wrappers macro
- - - - -
25f8afe7 by Ian Lynagh at 2009-03-21T19:13:53+00:00
Fix (with a hack?) haddock in teh new build system
- - - - -
6a29a37e by David Waern at 2009-03-24T22:10:15+00:00
Remove unnecessary LANGUAGE pragma
- - - - -
954da57d by David Waern at 2009-03-24T22:21:23+00:00
Fix warnings in H.B.DevHelp
- - - - -
1619f1df by David Waern at 2009-03-26T23:20:44+00:00
-Wall police in H.B.Html
- - - - -
b211e13b by Simon Marlow at 2009-03-24T13:00:56+00:00
install Haddock's html stuff
- - - - -
78e0b107 by David Waern at 2008-12-07T19:58:53+00:00
Add verbosity flag and utils, remove "verbose" flag
- - - - -
913dae06 by David Waern at 2008-12-07T20:01:05+00:00
Add some basic "verbose" mode logging in H.Interface
- - - - -
1cbff3bf by David Waern at 2009-03-27T00:07:26+00:00
Fix conflicts
- - - - -
22f82032 by David Waern at 2009-03-27T21:15:11+00:00
Remove H.GHC.Typecheck
- - - - -
81557804 by David Waern at 2009-03-27T21:19:22+00:00
Remove docNameOrig and use getName everywhere instead
- - - - -
d8267213 by David Waern at 2009-03-27T21:21:46+00:00
Use docNameOcc instead of nameOccName . getName
- - - - -
5d55deab by David Waern at 2009-03-27T21:33:04+00:00
Remove H.DocName and put DocName in H.Types
- - - - -
8ba72611 by David Waern at 2009-03-27T22:06:26+00:00
Document DocName
- - - - -
605f8ca5 by David Waern at 2009-03-27T22:45:21+00:00
-Wall police
- - - - -
e4da93ae by David Waern at 2009-03-27T23:12:53+00:00
-Wall police in H.B.Hoogle
- - - - -
bb255519 by David Waern at 2009-03-27T23:41:28+00:00
Define Foldable and Traversable instances for Located
- - - - -
f1195cfe by David Waern at 2009-03-27T23:51:34+00:00
Wibble
- - - - -
23818d7c by David Waern at 2009-03-28T00:03:55+00:00
-Wall police in H.I.Rename
- - - - -
0f050d67 by David Waern at 2009-03-28T00:15:15+00:00
-Wall police in H.I.AttachInstances
- - - - -
0f3fe038 by David Waern at 2009-03-28T21:09:41+00:00
Wibble
- - - - -
275d4865 by David Waern at 2009-03-28T21:27:06+00:00
Layout fix
- - - - -
54ff0ef8 by David Waern at 2009-03-28T21:59:07+00:00
-Wall police in H.I.Create
- - - - -
7f58b117 by David Waern at 2009-03-28T22:10:19+00:00
-Wall police in H.Interface
- - - - -
f0c03b44 by David Waern at 2009-03-28T22:22:59+00:00
-Wall police in Main
- - - - -
29da355c by David Waern at 2009-03-28T22:23:39+00:00
Turn on -Wall -Werror
- - - - -
446d3060 by David Waern at 2009-04-01T20:40:30+00:00
hlint police
- - - - -
3867c9fc by David Waern at 2009-04-01T20:48:42+00:00
hlint police
- - - - -
bd1f1600 by David Waern at 2009-04-01T20:58:02+00:00
hlint police
- - - - -
e0e90866 by David Waern at 2009-04-05T12:42:53+00:00
Move H.GHC.Utils to H.GhcUtils
- - - - -
9cbd426b by David Waern at 2009-04-05T12:57:21+00:00
Remove Haddock.GHC and move its (small) contents to Main
- - - - -
b5c2cbfd by David Waern at 2009-04-05T13:07:04+00:00
Fix whitespace and stylistic issues in Main
- - - - -
3c04aa56 by porges at 2008-12-07T08:22:19+00:00
add unicode output
- - - - -
607918da by David Waern at 2009-04-26T15:09:43+00:00
Resolve conflict
- - - - -
4bec6b6b by Simon Marlow at 2009-05-13T10:00:31+00:00
fix markup
- - - - -
436ad6f4 by Simon Marlow at 2009-03-23T11:54:45+00:00
clean up
- - - - -
bdcd1398 by Simon Marlow at 2009-03-24T10:36:45+00:00
new GHC build system: add $(exeext)
- - - - -
9c0972f3 by Simon Marlow at 2009-03-24T11:04:31+00:00
update for new GHC build system layout
- - - - -
d0f3f83a by Ian Lynagh at 2009-03-29T15:31:43+00:00
GHC new build system fixes
- - - - -
5a8245c2 by Ian Lynagh at 2009-04-04T20:44:23+00:00
Tweak new build system
- - - - -
9c6f2d7b by Simon Marlow at 2009-05-13T10:01:27+00:00
add build instructions for GHC
- - - - -
66d07c76 by Ian Lynagh at 2009-05-31T00:37:53+00:00
Quote program paths in ghc.mk
- - - - -
bb7de2cd by Ian Lynagh at 2009-06-03T22:57:55+00:00
Use a bang pattern on an unlifted binding
- - - - -
3ad283fc by Ian Lynagh at 2009-06-13T16:17:50+00:00
Include haddock in GHC bindists
- - - - -
ac447ff4 by David Waern at 2009-06-24T21:07:50+00:00
Delete Haddock.Exception and move contents to Haddock.Types

Only a few lines of code that mainly declares a type - why not just put it in Haddock.Types.

- - - - -
4464fb9b by David Waern at 2009-06-24T22:23:23+00:00
Add Haddock module headers

Add a proper Haddock module header to each module, with a more finegrained
copyright. If you feel mis-accreditted, please correct any copyright notice!

The maintainer field is set to haddock at projects.haskell.org.

Next step is to add a brief description to each module.

- - - - -
5f4c95dd by David Waern at 2009-06-24T22:39:44+00:00
Fix spelling error
- - - - -
6d074cdb by David Waern at 2009-06-25T21:53:56+00:00
Document Interface and InstalledInterface better
- - - - -
d0cbd183 by David Waern at 2009-06-27T12:46:46+00:00
Remove misplaced whitespace in H.I.Rename
- - - - -
fa381c49 by David Waern at 2009-06-27T13:26:03+00:00
Fix haskell/haddock#104 - create output directory if missing
- - - - -
91fb77ae by Ian Lynagh at 2009-06-25T15:59:50+00:00
TAG 2009-06-25
- - - - -
0d853f40 by Simon Peyton Jones at 2009-07-02T15:35:22+00:00
Follow extra field in ConDecl
- - - - -
b201735d by Ian Lynagh at 2009-07-05T16:50:35+00:00
Update Makefile for the new GHC build system
- - - - -
df6c0092 by Ian Lynagh at 2009-07-05T17:01:13+00:00
Resolve conflicts
- - - - -
1066870a by Ian Lynagh at 2009-07-05T17:01:48+00:00
Remove the -Wwarn hack in the GHC build system
- - - - -
7e856076 by Ian Lynagh at 2009-07-05T17:17:59+00:00
Fix warnings
- - - - -
5d4cd958 by Ian Lynagh at 2009-07-05T19:35:40+00:00
Bump version number
Cabal needs to distinguish between haddocks having a --verbose and
--verbosity flag

- - - - -
6ee07c99 by David Waern at 2009-07-06T20:14:57+00:00
Wibble
- - - - -
2308b66f by David Waern at 2009-07-06T20:24:20+00:00
Clearer printing of versions by runtests.hs
- - - - -
d4b5d9ab by David Waern at 2009-07-06T21:22:42+00:00
Fix (invisible) bug introduced by unicode patch
- - - - -
2caca8d8 by David Waern at 2009-07-06T21:44:10+00:00
Use HscAsm instead of HscC when using TH
- - - - -
18f3b755 by David Waern at 2009-07-06T22:10:22+00:00
Update HCAR entry (by Janis)
- - - - -
a72ac9db by David Waern at 2009-07-06T23:01:35+00:00
Follow HsRecTy change with an #if __GLASGOW_HASKEL__ >= 611
- - - - -
549135d2 by David Waern at 2009-07-06T23:11:41+00:00
Remove unused functions from Haddock.Utils
- - - - -
b450134a by Isaac Dupree at 2009-07-11T14:59:00+00:00
revert to split-index for large indices
- remove the search-box, because browsers have search-for-text
abilities anyway.
- pick 150 items in index as the arbitrary time at which to split it
- notice the bug that identifiers starting with non-ASCII characters
won't be listed in split-index, but don't bother to fix it yet (see
ticket haskell/haddock#116, http://trac.haskell.org/haddock/ticket/116 )

- - - - -
78a5661e by Isaac Dupree at 2009-07-20T15:37:18+00:00
Implement GADT records in HTML backend
- - - - -
4e163555 by Isaac Dupree at 2009-07-21T22:03:25+00:00
add test for GADT records
- - - - -
79aa4d6e by David Waern at 2009-07-23T20:40:37+00:00
Update test suite following version bump
- - - - -
5932c011 by David Waern at 2009-08-02T10:25:39+00:00
Fix documentation bug
- - - - -
a6970fca by David Waern at 2009-08-12T23:08:53+00:00
Remove support for ghc 6.8.* from .cabal file
- - - - -
c1695902 by Ian Lynagh at 2009-07-07T13:35:45+00:00
Fix unused import warnings
- - - - -
fb6df7f9 by Ian Lynagh at 2009-07-16T00:20:31+00:00
Use cProjectVersion directly rather than going through compilerInfo
Fixes the build after changes in GHC

- - - - -
548cdd66 by Simon Marlow at 2009-07-28T14:27:04+00:00
follow changes in GHC's ForeignType
- - - - -
9395aaa0 by David Waern at 2009-08-13T22:17:33+00:00
Switch from PatternSignatures to ScopedTypeVariables in Main
- - - - -
eebf39bd by David Waern at 2009-08-14T17:14:28+00:00
Version .haddock files made with GHC 6.10.3/4 correclty
- - - - -
58f3e735 by David Waern at 2009-08-14T17:19:37+00:00
Support GHC 6.10.* and 6.11.* only
- - - - -
5f63cecc by David Waern at 2009-08-14T22:03:20+00:00
Do not version .haddock file based on GHC patchlevel version

We require that the instances of Binary that we use from GHC will not change
between patchlevel versions.

- - - - -
d519de9f by David Waern at 2009-08-14T23:50:00+00:00
Update CHANGES
- - - - -
35dccf5c by David Waern at 2009-08-14T23:51:38+00:00
Update version number everywhere
- - - - -
6d363fea by David Waern at 2009-08-15T09:46:49+00:00
Update ANNOUNCE
- - - - -
c7ee6bc2 by David Waern at 2009-08-15T09:47:13+00:00
Remove -Werror

Forgot that Hackage doesn't like it.

- - - - -
a125c12b by David Waern at 2009-08-15T09:49:50+00:00
Require Cabal >= 1.6
- - - - -
adb2f560 by Isaac Dupree at 2009-08-12T03:47:14+00:00
Cross-Package Documentation version 4
- - - - -
3d6dc04d by David Waern at 2009-08-15T23:42:57+00:00
Put all the IN_GHC_TREE stuff inside getGhcLibDir
- - - - -
56624097 by David Waern at 2009-08-15T23:52:03+00:00
Add --print-ghc-libdir
- - - - -
f15d3ccb by David Waern at 2009-08-16T00:37:52+00:00
Read base.haddock when running tests

We can now test cross-package docs.

- - - - -
283f0fb9 by David Waern at 2009-08-16T00:50:59+00:00
Update test output - we now have more links
- - - - -
673d1004 by David Waern at 2009-08-16T01:26:08+00:00
Read process.haddock when running tests
- - - - -
0d127f82 by David Waern at 2009-08-16T01:43:04+00:00
Add a test for cross-package documentation
- - - - -
f94db967 by Ian Lynagh at 2009-08-16T18:42:44+00:00
Follow GHC build system changes
- - - - -
5151278a by Isaac Dupree at 2009-08-16T19:58:05+00:00
make cross-package list types look nicer
- - - - -
c41e8228 by Isaac Dupree at 2009-08-18T01:47:47+00:00
Haddock.Convert: export more functions
This lets us remove some code in Haddock.Interface.AttachInstances

- - - - -
2e5fa398 by Isaac Dupree at 2009-08-18T02:11:05+00:00
switch AttachInstances to use synify code
It changed an instance from showing ((,) a b) to (a, b)
because my synify code is more sophisticated; I hope the latter
is a good thing rather than a bad thing aesthetically, here.

But this definitely reduces code duplication!

- - - - -
b8b07123 by Isaac Dupree at 2009-08-18T02:23:31+00:00
Find instances using GHC, which is more complete.
In particular, it works cross-package.

An intermediate patch also moved the instance-finding into
createInterface, but that move turned out not to be necessary,
so if we want to do that, it'd go in a separate patch.
(Is that possible? Or will we need GHC to have loaded all the modules
first, before we can go searching for the instances (e.g. if the
modules are recursive or something)?)

- - - - -
6959b451 by Isaac Dupree at 2009-08-17T00:37:18+00:00
fix preprocessor conditional sense
- - - - -
942823af by Isaac Dupree at 2009-08-16T22:46:48+00:00
remove ghc 6.8 conditionals from Haddock.Interface
- - - - -
4b3ad888 by Isaac Dupree at 2009-08-18T20:24:38+00:00
Fix GHC 6.11 build in Haddock.Convert
- - - - -
0a89c5ab by Isaac Dupree at 2009-08-23T00:08:58+00:00
hacks to make it compile without fnArgDocsn
- - - - -
7b3bed43 by Isaac Dupree at 2009-08-23T03:01:28+00:00
less big-Map-based proper extraction of constructor subdocs
- - - - -
b21c279a by Isaac Dupree at 2009-08-23T03:02:06+00:00
Html: remove unnecessary+troublesome GHC. qualifications
- - - - -
96c97115 by Isaac Dupree at 2009-08-23T03:08:03+00:00
Move doc parsing/lexing into Haddock for ghc>=6.11
- - - - -
e1cec02d by Isaac Dupree at 2009-08-23T05:08:14+00:00
get rid of unused DocMap parameter in Html
- - - - -
66960c59 by Isaac Dupree at 2009-08-23T05:54:20+00:00
fix horrible named-docs-disappearing bug :-)
- - - - -
a9d7eff3 by Isaac Dupree at 2009-08-23T06:26:36+00:00
re-implement function-argument docs
..on top of the lexParseRn work.
This patch doesn't change the InstalledInterface format, and thus,
it does not work cross-package, but that will be easy to add
subsequently.

- - - - -
8bf6852c by Isaac Dupree at 2009-08-23T07:26:05+00:00
cross-package fnArgDocs. WARNING: changes .haddock binary format
While breaking the format, I took the opportunity to unrename the
DocMap that's saved to disk, because there's really no reason that
we want to know what *another* package's favorite place to link a
Name to was.  (Is that true? Or might we want to know, someday?)

Also, I added instance Binary Map in InterfaceFile.
It makes the code a little simpler without changing anything of
substance.  Also it lets us add another Map hidden inside another
Map (fnArgsDocs in instDocMap) without having really-convoluted
serialization code.  Instances are neat!
I don't understand why this change to InterfaceFile seemed to
subtly break binary compatibility all by itself, but no matter,
I'll just roll it into the greater format-changing patch. Done!

- - - - -
30115a64 by Isaac Dupree at 2009-08-23T18:22:47+00:00
Improve behavior for unfindable .haddock
- - - - -
aa364bda by Isaac Dupree at 2009-08-23T18:28:16+00:00
add comment for FnArgsDoc type
- - - - -
49b23a99 by Isaac Dupree at 2009-08-23T21:52:48+00:00
bugfix: restore fnArgDocs for type-synonyms
- - - - -
f65f9467 by Isaac Dupree at 2009-08-23T22:06:55+00:00
Backends.Hoogle: eliminate warnings
- - - - -
a292d216 by Isaac Dupree at 2009-08-23T22:10:24+00:00
Haddock.Convert: eliminate warnings
- - - - -
5546cd20 by Isaac Dupree at 2009-08-23T22:12:31+00:00
Haddock.Interface.Rename: eliminate warnings
- - - - -
0a9798b6 by Isaac Dupree at 2009-08-23T22:18:47+00:00
Main.hs: remove ghc<6.9 conditionals
- - - - -
e8f9867f by Isaac Dupree at 2009-08-23T22:27:46+00:00
Main.hs: eliminate warnings (except for OldException)
- - - - -
61c64247 by Isaac Dupree at 2009-08-23T22:41:01+00:00
move get*LibDir code in Main.hs, to +consistent code, -duplication
- - - - -
948f1e69 by Isaac Dupree at 2009-08-23T23:14:26+00:00
Main.hs: OldException->Exception: which eliminates warnings
- - - - -
3d5d5e03 by Isaac Dupree at 2009-08-23T23:20:11+00:00
GhcUtils: ghc >= 6.10
- - - - -
2771d657 by Isaac Dupree at 2009-08-23T23:21:55+00:00
InterfaceFile: ghc >= 6.10
- - - - -
d9f2b9d1 by Isaac Dupree at 2009-08-23T23:22:58+00:00
Types: ghc >= 6.10
- - - - -
ca39210e by Isaac Dupree at 2009-08-23T23:23:26+00:00
ModuleTree: ghc >= 6.10
- - - - -
883c4e59 by Isaac Dupree at 2009-08-23T23:24:04+00:00
Backends.DevHelp: ghc >= 6.10
- - - - -
04667df5 by Isaac Dupree at 2009-08-23T23:24:37+00:00
Backends.Html: ghc >= 6.10
- - - - -
a9f7f25f by Isaac Dupree at 2009-08-23T23:25:24+00:00
Utils: ghc >= 6.10
- - - - -
b7105022 by Isaac Dupree at 2009-08-23T23:37:47+00:00
eliminate haskell98 dependency, following GHC's example
It turns out I/we already had, and it was only a matter of
deleting it from the cabal file.

- - - - -
292e0911 by Isaac Dupree at 2009-08-24T01:22:44+00:00
refactor out subordinatesWithNoDocs
dep of inferenced-decls fix

- - - - -
c2ed46a2 by Isaac Dupree at 2009-08-24T01:24:03+00:00
Eradicate wrong runtime warning for type-inferenced exported-functions
see the long comment in the patch for why I did it this way :-)

- - - - -
4ac0b57c by David Waern at 2009-09-04T22:56:20+00:00
Clean up tyThingToHsSynSig a little

Factor out noLoc and use the case construct. Also rename the function to
tyThingToLHsDecl, since it doesn't just create type signatures.

- - - - -
28ab9201 by David Waern at 2009-09-04T22:58:50+00:00
Wibble
- - - - -
0d9fe6d0 by David Waern at 2009-09-06T18:39:30+00:00
Add more copyright owners to H.I.AttachInstances
- - - - -
122441b1 by David Waern at 2009-09-06T18:44:12+00:00
Style police
- - - - -
1fa79463 by David Waern at 2009-09-06T18:57:45+00:00
Move toHsInstHead to Haddock.Convert and call it synifyInstHead
- - - - -
0d42a8aa by David Waern at 2009-09-06T21:11:38+00:00
Use colordiff to display test results if available
- - - - -
ea9d8e03 by Simon Marlow at 2009-08-24T08:46:14+00:00
Follow changes in GHC's interface file format
Word32 instead of Int for FastString and Name offsets

- - - - -
537e051e by Simon Marlow at 2009-07-29T14:16:53+00:00
define unpackPackageId (it was removed from GHC)
- - - - -
50c63aa7 by David Waern at 2009-09-09T23:18:03+00:00
Remove commented-out code
- - - - -
511631fe by David Waern at 2009-09-09T23:19:05+00:00
Correct copyright in H.I.ParseModuleHeader
- - - - -
898ec768 by David Waern at 2009-09-11T11:22:29+00:00
Use Map.fromList/toList intead of fromAscList/toAscList when serializing Maps
  
This fixes the missing docs problem. The Eq and Ord instances for Name uses the
unique number in Name. This number is created at deserialization time by GHC's
magic Binary instance for Name, and it is random. Thus, fromAscList can't be used
at deserialization time, even though toAscList was used at serialization time.

- - - - -
37bec0d5 by Simon Peyton Jones at 2009-09-11T08:28:04+00:00
Track change in HsType
- - - - -
eb3a97c3 by Ian Lynagh at 2009-09-11T16:07:09+00:00
Allow building with base 4.2
- - - - -
bb4205ed by Ian Lynagh at 2009-09-22T13:50:02+00:00
Loosen the GHC dependency
- - - - -
5c75deb2 by Ian Lynagh at 2009-09-22T14:08:39+00:00
Fix building with GHC >= 6.12
- - - - -
fb131481 by David Waern at 2009-09-11T11:24:48+00:00
Update runtests.hs to work with GHC 6.11
- - - - -
ac3a419d by David Waern at 2009-09-11T11:25:14+00:00
Update CrossPackageDocs test
- - - - -
ec65c3c6 by David Waern at 2009-09-11T11:25:40+00:00
Add reference output for CrossPackageDocs
- - - - -
520c2758 by Ian Lynagh at 2009-10-25T17:26:40+00:00
Fix installation in the GHC build system
- - - - -
28b3d7df by Ian Lynagh at 2009-11-05T15:57:27+00:00
GHC build system: Make *nix installation work in paths containing spaces
- - - - -
5c9bb541 by David Waern at 2009-11-14T11:56:39+00:00
Track change in HsType for the right compiler version
- - - - -
905097ce by David Waern at 2009-11-14T12:10:47+00:00
hlint police
- - - - -
04920630 by Ian Lynagh at 2009-11-20T13:46:30+00:00
Use defaultObjectTarget rather than HscAsm
This fixes haddock when we don't have a native code generator

- - - - -
966eb079 by David Waern at 2009-11-15T12:32:21+00:00
Remove commented-out code
- - - - -
37f00fc4 by David Waern at 2009-11-22T13:58:48+00:00
Make runtests.hs strip links before diffing

Generates easier to read diffs when tests fail. The content of the links
is not important anyway since it is not taken into account by the tests.

- - - - -
3a9bb8ef by David Waern at 2009-11-22T14:05:06+00:00
Follow findProgramOnPath signature change in runtests.hs
- - - - -
b26b9e5a by David Waern at 2009-11-22T14:08:40+00:00
Follow removal of GHC.MVar from base in CrossPackageDocs 
- - - - -
f4d90ae4 by David Waern at 2009-11-22T14:48:47+00:00
Make copy.hs strip link contents before copying

No more updating of reference files when URLs in links changes.

- - - - -
4c9c420d by David Waern at 2009-11-22T15:26:41+00:00
Update test reference output

* More links (Int, Float etc)
* Stripped link contents 

- - - - -
a62b80e3 by David Waern at 2009-11-23T23:19:39+00:00
Update CrossPackageDocs reference output

- Remove GHC.MVar import (removed from base)
- Strip link contents

- - - - -
43491394 by David Waern at 2009-11-23T23:20:00+00:00
Update test reference files with comments on instances
- - - - -
0d370a0b by David Waern at 2009-11-23T23:25:16+00:00
Bump version number
- - - - -
2293113e by David Waern at 2009-11-24T20:55:49+00:00
Comments on instances

Implementing this was a little trickier than I thought, since we need to match
up instances from the renamed syntax with instances represented by
InstEnv.Instance. This is due to the current design of Haddock, which matches
comments with declarations from the renamed syntax, while getting the list of
instances of a class/family directly using the GHC API.

- Works for class instances only (Haddock has no support for type family
  instances yet)
- The comments are rendered to the right of the instance head in the HTML output
- No change to the .haddock file format
- Works for normal user-written instances only. No comments are added on
  derived or TH-generated instances

- - - - -
bf586f29 by David Waern at 2009-11-27T22:05:15+00:00
Whitespace police
- - - - -
b8f03afa by David Waern at 2009-11-27T22:11:46+00:00
Remove bad whitespace and commented-out pieces
- - - - -
90b8ee90 by David Waern at 2009-11-27T22:15:04+00:00
Whitespace police
- - - - -
b5ede900 by David Waern at 2009-11-27T22:15:50+00:00
Whitespace police
- - - - -
e3fddbfe by David Waern at 2009-11-28T13:37:59+00:00
Remove Name from DocInstance

It's not used.

- - - - -
9502786c by David Waern at 2009-11-28T13:56:54+00:00
Require at least GHC 6.12

While regression testing Haddock, I found a bug that happens with GHC 6.10.3,
but not with GHC 6.12-rc2 (haven't tried 6.10.4). I don't have time to track it
down.

I think we should just always require the latest major GHC version. The time
spent on making Haddock work with older versions is too high compared to the
time spent on bugfixing, refactoring and features.

- - - - -
8fa688d8 by David Waern at 2009-11-28T15:05:03+00:00
Remove cruft due to compatibility with older GHCs
- - - - -
46fbbe9d by David Waern at 2009-11-28T15:07:50+00:00
Add a documentation header to Haddock.Convert
- - - - -
c3d2cc4a by David Waern at 2009-11-28T15:10:14+00:00
Remove unused H.Utils.FastMutInt2
- - - - -
490aba80 by David Waern at 2009-11-28T15:36:36+00:00
Rename Distribution.Haddock into Documentation.Haddock
- - - - -
33ee2397 by David Waern at 2009-11-28T15:36:47+00:00
Fix error message
- - - - -
a5a3b950 by David Waern at 2009-11-28T16:58:39+00:00
Add a test flag that brings in QuickCheck
- - - - -
fa049e13 by David Waern at 2009-11-28T19:32:18+00:00
Say that we want quickcheck 2
- - - - -
f32b0d9b by David Waern at 2009-11-28T19:32:40+00:00
Add an Arbitrary instance for HsDoc
- - - - -
da9a8bd7 by David Waern at 2009-11-28T20:15:30+00:00
Rename HsDoc back into Doc
- - - - -
edb60101 by David Waern at 2009-11-28T22:16:16+00:00
Move H.Interface.Parse/Lex to H.Parse/Lex

These are not just used to build Interfaces.

- - - - -
0656a9b8 by David Waern at 2009-11-28T23:12:14+00:00
Update version number in test suite
- - - - -
5e8c6f4a by David Waern at 2009-12-21T14:12:41+00:00
Improve doc of DocName
- - - - -
7868e551 by Ian Lynagh at 2009-09-22T10:43:03+00:00
TAG GHC 6.12-branch created
- - - - -
0452a3ea by Ian Lynagh at 2009-12-15T12:46:07+00:00
TAG GHC 6.12.1 release
- - - - -
65e9be62 by David Waern at 2009-12-21T16:58:58+00:00
Update CHANGES
- - - - -
145cee32 by David Waern at 2009-12-21T16:59:09+00:00
TAG 2.6.0
- - - - -
3c552008 by David Waern at 2009-12-22T17:11:14+00:00
Update ANNOUNCE
- - - - -
931f9db4 by David Waern at 2010-01-22T19:57:17+00:00
Convert haddock.vim to use unix newlines
- - - - -
4e56588f by David Waern at 2010-01-22T22:11:17+00:00
Remove unnecessary (and inexplicable) uses of nub
- - - - -
744bb4d1 by David Waern at 2010-01-22T22:12:14+00:00
Follow move of parser and lexer
- - - - -
e34bab14 by David Waern at 2010-01-22T22:49:13+00:00
Use findProgramLocation instead of findProgramOnPath in runtests.hs
- - - - -
8d39891b by Isaac Dupree at 2010-01-14T18:53:18+00:00
fix html arg-doc off-by-one and silliness
- - - - -
9401f2e9 by David Waern at 2010-01-22T22:57:03+00:00
Create a test for function argument docs
- - - - -
507a82d7 by David Waern at 2010-01-22T23:24:47+00:00
Put parenthesis around type signature arguments of function type
- - - - -
8a305c28 by David Waern at 2010-01-23T17:26:59+00:00
Add reference file for the FunArgs test
- - - - -
1309d5e1 by David Waern at 2010-01-24T16:05:08+00:00
Improve FunArg test and update Test.html.ref
- - - - -
2990f055 by Yitzchak Gale at 2010-02-14T16:03:46+00:00
Do not generate illegal character in HTML ID attribute.
- - - - -
c5bcab7a by David Waern at 2010-02-22T22:10:30+00:00
Fix Haddock markup error in comment
- - - - -
c6416a73 by David Waern at 2010-02-24T22:55:08+00:00
Large additions to the Haddock API

Also improved and added more doc comments.

- - - - -
57d289d7 by David Waern at 2010-02-24T22:58:02+00:00
Remove unused ifaceLocals
- - - - -
80528d93 by David Waern at 2010-02-25T21:05:09+00:00
Add HaddockModInfo to the API
- - - - -
82806848 by David Waern at 2010-02-25T21:05:27+00:00
Wibble
- - - - -
744cad4c by David Waern at 2010-02-25T23:30:59+00:00
Make it possible to run a single test
- - - - -
6a806e4c by David Waern at 2010-03-14T14:19:39+00:00
Bump version number
- - - - -
a5a8e4a7 by David Waern at 2010-03-14T14:36:35+00:00
Update ANNOUNCE
- - - - -
6f05435e by Simon Hengel at 2010-03-15T20:52:42+00:00
Add missing dependencies for 'library' in haddock.cabal
- - - - -
faefe2bd by David Waern at 2010-03-15T22:29:37+00:00
Solve conflicts
- - - - -
9808ad52 by David Waern at 2010-03-15T22:51:21+00:00
Bump version number
- - - - -
eb0bf60b by David Waern at 2010-03-15T22:52:32+00:00
Update CHANGES
- - - - -
f95cd891 by David Waern at 2010-03-15T23:01:06+00:00
Add Paths_haddock to other-modules of library
- - - - -
65997b0a by David Waern at 2010-03-15T23:14:59+00:00
Update CHANGES
- - - - -
7e251731 by David Waern at 2010-03-15T23:15:30+00:00
Bump version number
- - - - -
c9cd0ddc by David Waern at 2010-03-16T00:28:34+00:00
Fix warning
- - - - -
1cac2d93 by Simon Peyton Jones at 2010-01-04T15:22:16+00:00
Fix imports for new location of splitKindFunTys
- - - - -
474f26f6 by Simon Peyton Jones at 2010-02-10T14:36:06+00:00
Update Haddock for quasiquotes
- - - - -
0dcc06c0 by Simon Peyton Jones at 2010-02-10T10:59:45+00:00
Track changes in HsTyVarBndr
- - - - -
2d84733a by Simon Peyton Jones at 2010-02-10T14:52:44+00:00
Track HsSyn chnages
- - - - -
9e3adb8b by Ian Lynagh at 2010-02-20T17:09:42+00:00
Resolve conflicts
- - - - -
a3e72ff8 by Simon Peyton Jones at 2010-03-04T13:05:16+00:00
Track change in HsUtils; and use a nicer function not an internal one
- - - - -
27994854 by David Waern at 2010-03-18T22:22:27+00:00
Fix build with GHC 6.12.1
- - - - -
11f6e488 by David Waern at 2010-03-18T22:24:09+00:00
Bump version in test reference files
- - - - -
0ef2f11b by David Waern at 2010-03-20T00:56:30+00:00
Fix library part of cabal file when in ghc tree
- - - - -
3f6146ff by Mark Lentczner at 2010-03-20T22:30:11+00:00
First, experimental XHTML rendering
    switch to using the xhtml package

    copied Html.hs to Xhtml.hs
        and split into sub-modules under Haddock/Backends/Xhtml
        and detabify

    moved footer into div, got ready for iface change
    headers converted to semantic markup
    contents in semantic markup
    summary as semantic markup
    description in semantic markup, info block in header fixed

    factored out rendering so during debug it can be readable
        (see renderToString)


- - - - -
b8ab329b by Mark Lentczner at 2010-03-20T22:54:01+00:00
apply changes to Html.hs to Xhtml/*.hs
	incorporate changes that were made between the time Html.hs
	was copied and split into Xhtml.hs and Xhtml/*.hs
	includes patchs after "Wibble" (!) through "Fix build with GHC 6.12.1"

- - - - -
73df2433 by Ian Lynagh at 2010-03-20T21:56:37+00:00
Follow LazyUniqFM->UniqFM in GHC
- - - - -
db4f602b by David Waern at 2010-03-29T22:00:01+00:00
Fix build with GHC 6.12
- - - - -
d8dca088 by Simon Hengel at 2010-04-02T16:39:55+00:00
Add missing dependencies to cabal file
- - - - -
e2adc437 by Simon Hengel at 2010-04-02T14:08:40+00:00
Add markup support for interactive examples
- - - - -
e882ac05 by Simon Hengel at 2010-04-02T14:11:53+00:00
Add tests for interactive examples
- - - - -
5a07a6d3 by David Waern at 2010-04-07T17:05:20+00:00
Propagate source positions from Lex.x to Parse.y
- - - - -
6493b46f by David Waern at 2010-04-07T21:48:57+00:00
Let runtests.hs die when haddock has not been built
- - - - -
5e34423e by David Waern at 2010-04-07T22:01:13+00:00
Make runtests.hs slightly more readable
- - - - -
321d59b3 by David Waern at 2010-04-07T22:13:27+00:00
Fix haskell/haddock#75

Add colons to the $ident character set. 

- - - - -
37b08b8d by David Waern at 2010-04-08T00:32:52+00:00
Fix haskell/haddock#118

Avoid being too greedy when lexing URL markup (<..>), in order to allow
multiple URLs on the same line. Do the same thing with <<..>> and #..#.

- - - - -
df8feac9 by David Waern at 2010-04-08T00:57:33+00:00
Make it easier to add new package deps to test suite

This is a hack - we should use Cabal to get the package details instead.

- - - - -
1ca6f84b by David Waern at 2010-04-08T01:03:06+00:00
Add ghc-prim to test suite deps
- - - - -
27371e3a by Simon Hengel at 2010-04-08T19:26:34+00:00
Let parsing fails on paragraphs that are immediately followed by an
example

This is more consistent with the way we treat code blocks.

- - - - -
83096e4a by David Waern at 2010-04-08T21:20:00+00:00
Improve function name
- - - - -
439983ce by David Waern at 2010-04-10T10:46:14+00:00
Fix haskell/haddock#112

No link was generated for 'Addr#' in a doc comment. The reason was simply that
the identifier didn't parse. We were using parseIdentifier from the GHC API,
with a parser state built from 'defaultDynFlags'. If we pass the dynflags of
the module instead, the right options are turned on on while parsing the
identifer (in this case -XMagicHash), and the parse succeeds.

- - - - -
5c0d35d7 by David Waern at 2010-04-10T10:54:06+00:00
Rename startGhc into withGhc
- - - - -
dca081fa by Simon Hengel at 2010-04-12T19:09:16+00:00
Add documentation for interactive examples
- - - - -
c7f26bfa by David Waern at 2010-04-13T00:51:51+00:00
Slight fix to the documentation of examples
- - - - -
06eb7c4c by David Waern at 2010-04-13T00:57:05+00:00
Rename Interactive Examples into Examples (and simplify explanation)
- - - - -
264830cb by David Waern at 2010-05-10T20:07:27+00:00
Update CHANGES with info about 2.6.1
- - - - -
8e5d4514 by Simon Hengel at 2010-04-18T18:16:54+00:00
Add unit tests for parser
- - - - -
68297f40 by David Waern at 2010-05-10T21:53:37+00:00
Improve testsuite README
- - - - -
f04eb6e4 by David Waern at 2010-05-11T19:14:31+00:00
Re-organise the testsuite structure
- - - - -
a360f710 by David Waern at 2010-05-11T19:18:03+00:00
Shorten function name
- - - - -
1d5dd359 by David Waern at 2010-05-11T21:40:02+00:00
Update runtests.hs following testsuite re-organisation
- - - - -
ffebe217 by David Waern at 2010-05-11T21:40:10+00:00
Update runtests.hs to use base-4.2.0.1
- - - - -
635de402 by David Waern at 2010-05-11T21:41:11+00:00
Update runparsetests.hs following testsuite reorganisation
- - - - -
72137910 by Ian Lynagh at 2010-05-06T20:43:06+00:00
Fix build
- - - - -
1a80b76e by Ian Lynagh at 2010-05-06T22:25:29+00:00
Remove redundant import
- - - - -
1031a80c by Simon Peyton Jones at 2010-05-07T13:21:09+00:00
Minor wibbles to HsBang stuff
- - - - -
dd8e7fe5 by Ian Lynagh at 2010-05-08T15:22:00+00:00
GHC build system: Follow "rm" variable changes
- - - - -
7f5e6748 by David Waern at 2010-05-13T11:53:02+00:00
Fix build with GHC 6.12.2
- - - - -
7953d4d8 by David Waern at 2010-05-13T18:45:01+00:00
Fixes to comments only
- - - - -
8ae8eb64 by David Waern at 2010-05-13T18:57:26+00:00
ModuleMap -> IfaceMap
- - - - -
1c3eadc6 by David Waern at 2010-05-13T19:03:13+00:00
Fix whitespace style issues
- - - - -
e96783c0 by David Waern at 2010-05-13T19:08:53+00:00
Fix comment
- - - - -
c998a78b by David Waern at 2010-05-13T19:39:00+00:00
Position the module header the same way everywhere
Silly, but nice with some consistency :-)

- - - - -
b48a714e by David Waern at 2010-05-13T19:41:32+00:00
Position of module header, this time in the HTML backends
- - - - -
f9bfb12e by David Waern at 2010-05-13T19:43:05+00:00
Two newlines between declarations in Main
- - - - -
071d44c7 by David Waern at 2010-05-13T19:44:21+00:00
Newlines in Convert
- - - - -
036346db by David Waern at 2010-05-13T19:46:47+00:00
Fix a few stylistic issues in H.InterfaceFile
- - - - -
f0b8379e by David Waern at 2010-05-13T19:47:53+00:00
Add newlines to H.ModuleTree
- - - - -
27409f8e by David Waern at 2010-05-13T19:51:10+00:00
Fix stylistic issues in H.Utils
- - - - -
24774a11 by David Waern at 2010-05-13T20:00:43+00:00
Structure H.Types better
- - - - -
7b6f5e40 by David Waern at 2010-05-13T20:01:04+00:00
Remove bad Arbitrary instance
- - - - -
fac9f1f6 by David Waern at 2010-05-13T20:05:50+00:00
Get rid of H.Utils.pathJoin and use System.FilePath.joinPath instead
- - - - -
fe6d00c4 by David Waern at 2010-05-13T20:51:55+00:00
Export a couple of more types from the API
- - - - -
b2e33a5f by David Waern at 2010-05-13T21:27:51+00:00
Improve doc comment for Interface
- - - - -
c585f2ce by David Waern at 2010-05-13T21:30:14+00:00
Improve documentation of Haddock.Interface
- - - - -
e6791db2 by David Waern at 2010-05-13T22:07:35+00:00
Remove meaningless comments
- - - - -
7801b390 by David Waern at 2010-05-14T17:53:33+00:00
Remove unused modules
- - - - -
f813e937 by David Waern at 2010-05-14T17:55:17+00:00
Re-direct compilation output to a temporary directory
Also add a flag --no-tmp-comp-dir that can be used to get the old behaviour of
writing compilation files to GHC's output directory (default ".").

- - - - -
e56737ec by David Waern at 2010-05-14T18:06:11+00:00
Wibble
- - - - -
e40b0447 by David Waern at 2010-05-14T19:01:52+00:00
Move flag evaluation code from Main to Haddock.Options
Determining the value of "singular" flags (by e.g. taking the last occurrence
of the flag) and other flag evaluation should done in Haddock.Options which is
the module that is supposed to define the command line interface. This makes
Main a bit easier on the eyes as well.

- - - - -
27091f57 by David Waern at 2010-05-14T19:05:10+00:00
Wibble
- - - - -
c658cf61 by David Waern at 2010-05-14T19:06:49+00:00
Re-order things in Haddock.Options a bit
- - - - -
8cfdd342 by David Waern at 2010-05-14T19:20:29+00:00
De-tabify Haddock.Options and fix other whitespace issues
- - - - -
0df16b62 by David Waern at 2010-05-14T19:25:07+00:00
Improve comments
- - - - -
80b38e2b by David Waern at 2010-05-14T19:26:42+00:00
Whitespace police
- - - - -
fe580255 by David Waern at 2010-05-14T19:31:23+00:00
Wibbles to comments
- - - - -
a2b43fad by David Waern at 2010-05-14T20:24:32+00:00
Move some more flag functions to Haddock.Options
- - - - -
3f895547 by David Waern at 2010-05-14T20:37:12+00:00
Make renderStep a top-level function in Main
- - - - -
5cdca11d by David Waern at 2010-05-14T20:39:27+00:00
Spelling in comment
- - - - -
ad98d14c by David Waern at 2010-05-14T20:40:26+00:00
Comment fixes
- - - - -
0bb9218f by David Waern at 2010-05-14T20:49:01+00:00
Whitespace police
- - - - -
0f0a533f by David Waern at 2010-05-15T16:42:29+00:00
Improve description of --dump-interface
- - - - -
5b2833ac by David Waern at 2010-05-15T17:16:53+00:00
Document --no-tmp-comp-dir
- - - - -
8160b170 by David Waern at 2010-05-15T17:18:59+00:00
Wibble
- - - - -
570dbe33 by David Waern at 2010-05-18T21:15:38+00:00
HLint police
- - - - -
204e425f by David Waern at 2010-05-18T21:16:30+00:00
HLint police
- - - - -
6db657ac by David Waern at 2010-05-18T21:16:37+00:00
Wibble
- - - - -
b942ccd7 by Simon Marlow at 2010-06-02T08:27:30+00:00
Interrupted disappeared in GHC 6.13 (GHC ticket haskell/haddock#4100)
- - - - -
3b94a819 by Simon Marlow at 2010-06-02T08:45:08+00:00
Allow base-4.3
- - - - -
c5a1fb7c by Simon Marlow at 2010-06-02T09:03:04+00:00
Fix compilation with GHC 6.13
- - - - -
6181296c by David Waern at 2010-06-08T21:09:05+00:00
Display name of prologue file when parsing it fails
- - - - -
7cbc6f60 by Ian Lynagh at 2010-06-13T16:20:25+00:00
Remove redundant imports
- - - - -
980c804b by Simon Marlow at 2010-06-22T08:41:50+00:00
isLocalAndTypeInferenced: fix for local module names overlapping package modules
- - - - -
d74d4a12 by Simon Marlow at 2010-06-23T12:03:27+00:00
Unresolved identifiers in Doc get replaced with DocMonospaced
rather than plain strings

- - - - -
d8546783 by Simon Marlow at 2010-06-30T12:45:17+00:00
LaTeX backend (new options: --latex, --latex-style=<style>)
- - - - -
437afa9e by David Waern at 2010-07-01T12:02:44+00:00
Fix a few stylistic whitespace issues in LaTeX backend
- - - - -
85bc1fae by David Waern at 2010-07-01T15:42:45+00:00
Make runtest.hs work with GHC 6.12.3 (we should really stop hard coding this)
- - - - -
7d2eb86f by David Waern at 2010-07-01T15:43:33+00:00
Update test following Simon's patch to render unresolved names in monospaced font
- - - - -
08fcbcd2 by David Waern at 2010-07-01T16:12:18+00:00
Warning police
- - - - -
d04a8d7a by David Waern at 2010-07-04T14:53:39+00:00
Fix a bug in attachInstances

We didn't look for instance docs in all the interfaces of the package. This had
the effect of instance docs not always showing up under a declaration. I took
the opportunity to clean up the code in H.I.AttachInstances a bit as well. More
cleanup is needed, however.

- - - - -
d10344eb by Simon Hengel at 2010-07-10T09:19:04+00:00
Add missing dependencies to cabal file
- - - - -
24090531 by Mark Lentczner at 2010-03-21T04:51:16+00:00
add exports to Xhtml modules
- - - - -
84f9a333 by Mark Lentczner at 2010-04-03T19:14:22+00:00
clean up Doc formatting code
- add CSS for lists 
- renderToString now uses showHtml since prettyHtml messes up <pre> sections

- - - - -
bebccf52 by Mark Lentczner at 2010-04-04T04:51:08+00:00
tweak list css
- - - - -
0c2aeb5e by Mark Lentczner at 2010-04-04T06:24:14+00:00
all decls now generate Html not HtmlTable
	- ppDecl return Html, and so now do all of the functions it calls
	- added some internal tables to some decls, which is wrong, and will have
		to be fixed
	- decl "Box" functions became "Elem" functions to make clear they aren't
		in a table anymore (see Layout.hs)
	- docBox went away, as only used in one place (and its days are numbered)
	- cleaned up logic in a number of places, removed dead code
	- added maybeDocToHtml which simplified a number of places in the code

- - - - -
dbf73e6e by Mark Lentczner at 2010-04-05T05:02:43+00:00
clean up processExport and place a div around each decl
- - - - -
e25b7e9f by Mark Lentczner at 2010-04-10T21:23:21+00:00
data decls are now a sequence of paragraphs, not a table
- - - - -
89ee0294 by Mark Lentczner at 2010-04-10T21:29:16+00:00
removed commented out code that can't be maintained
- - - - -
d466f536 by Mark Lentczner at 2010-04-12T04:56:27+00:00
removed declWithDoc and cleaned up data decls in summary
- - - - -
ed755832 by Mark Lentczner at 2010-04-12T05:07:53+00:00
merge in markupExample changes
- - - - -
c36f51fd by Mark Lentczner at 2010-04-25T04:56:37+00:00
made record fields be an unordList, not a table
- - - - -
ed3a28d6 by Mark Lentczner at 2010-04-25T05:23:28+00:00
fixed surround of instance and constructor tables
- - - - -
0e35bbc4 by Mark Lentczner at 2010-04-25T05:36:59+00:00
fix class member boxes in summary
- - - - -
5041749b by Mark Lentczner at 2010-04-25T05:38:35+00:00
remove unused bodyBox
- - - - -
e91724db by Mark Lentczner at 2010-04-25T06:26:10+00:00
fixed javascript quoting/escpaing issue
- - - - -
f4abbb73 by Mark Lentczner at 2010-05-03T23:04:31+00:00
adjust css for current markup
- - - - -
e75fec4c by Mark Lentczner at 2010-05-04T06:14:34+00:00
added assoicated types and methods back into class decls
- - - - -
84169323 by Mark Lentczner at 2010-05-24T13:13:42+00:00
merge in changes from the big-whitespace cleanup
- - - - -
3c1c872e by Mark Lentczner at 2010-06-11T21:03:58+00:00
adjust synopsis and bottom bar spacing
- - - - -
3c1f9ef7 by Mark Lentczner at 2010-06-11T21:14:44+00:00
fix missing space in "module" lines in synoposis
- - - - -
9a137e6d by Mark Lentczner at 2010-06-11T21:34:08+00:00
changed tt elements to code elements
- - - - -
50f71ef1 by Mark Lentczner at 2010-06-11T23:27:46+00:00
factored out ppInstances
- - - - -
3b9a9de5 by Mark Lentczner at 2010-06-17T17:36:01+00:00
push single constructors (newtype) onto line with decl
- - - - -
e0f8f2ec by Mark Lentczner at 2010-06-17T22:20:56+00:00
remove <++> connector
- - - - -
56c075dd by Mark Lentczner at 2010-07-13T05:26:21+00:00
change to new page structure
- - - - -
04be6ca7 by Mark Lentczner at 2010-07-14T04:21:55+00:00
constructors and args as dl lists, built in Layout.hs
- - - - -
65aeafc2 by Mark Lentczner at 2010-07-14T05:38:32+00:00
better interface to subDecls
- - - - -
72032189 by Mark Lentczner at 2010-07-14T07:04:10+00:00
made subDecl tables looks just so
- - - - -
b782eca2 by Mark Lentczner at 2010-07-14T16:00:54+00:00
convert args to SubDecl format
- - - - -
cc75e98f by Mark Lentczner at 2010-07-14T16:28:53+00:00
convert instances to SubDecl
- - - - -
34e2aa5a by Mark Lentczner at 2010-07-14T21:07:32+00:00
removing old table cruft from Layout.hs
- - - - -
d5810d95 by Mark Lentczner at 2010-07-14T21:54:58+00:00
methods and associated types in new layout scheme
- - - - -
65ef9579 by Mark Lentczner at 2010-07-14T23:43:42+00:00
clean up synopsis lists
- - - - -
e523318f by Mark Lentczner at 2010-07-15T05:02:26+00:00
clean up of anchors
- - - - -
1215dfc5 by Mark Lentczner at 2010-07-15T23:53:01+00:00
added two new themes and rough css switcher
- - - - -
7f0fd36f by Mark Lentczner at 2010-07-16T04:57:38+00:00
fixed package catpion, added style menu
- - - - -
0dd4999c by Mark Lentczner at 2010-07-16T20:12:39+00:00
new output for mini_ pages
- - - - -
64b2810b by Mark Lentczner at 2010-07-16T20:58:41+00:00
reformat index-frames
- - - - -
3173f555 by Mark Lentczner at 2010-07-16T22:41:53+00:00
convert index to new markup
- - - - -
b0a4b7c9 by Mark Lentczner at 2010-07-17T04:07:22+00:00
convert index.html to new markup, adjust module markup
- - - - -
8261ae1e by Mark Lentczner at 2010-07-17T05:07:29+00:00
classing styling of ancillary pages
- - - - -
2a4fb025 by Mark Lentczner at 2010-07-17T05:11:45+00:00
clean up Layout.hs: no more vanillaTable
- - - - -
87eec685 by Mark Lentczner at 2010-07-17T05:35:16+00:00
clean up Util.hs
- - - - -
d304e9b0 by Mark Lentczner at 2010-07-17T05:38:50+00:00
qualify import of XHtml as XHtml
- - - - -
7dc05807 by Mark Lentczner at 2010-07-17T06:17:53+00:00
factored out head element generation
- - - - -
9cdaec9e by Mark Lentczner at 2010-07-17T06:44:54+00:00
refactored out main page body generation
- - - - -
8a51019e by Mark Lentczner at 2010-07-17T06:48:20+00:00
moved footer into only place that used it
- - - - -
efa479da by Mark Lentczner at 2010-07-17T18:48:30+00:00
styling auxillary pages for tibbe and snappy themes
- - - - -
81de5509 by Mark Lentczner at 2010-07-18T04:41:38+00:00
fixed alphabet on index page, and styling of it and packages in module lists
- - - - -
20718c1a by Mark Lentczner at 2010-07-18T05:34:29+00:00
cleaned up div functions in Layout.hs
- - - - -
60d50453 by Mark Lentczner at 2010-07-18T05:48:39+00:00
added content div to main pages
- - - - -
ed16561c by Mark Lentczner at 2010-07-18T06:12:22+00:00
add .doc class to documentation blocks
- - - - -
f5c781b0 by Mark Lentczner at 2010-07-19T05:20:53+00:00
refactoring of anchor ID and fragment handling
- - - - -
a69a93bf by Mark Lentczner at 2010-07-19T05:35:55+00:00
remove an explicit bold tag - replace with .def class
- - - - -
d76c7225 by Mark Lentczner at 2010-07-19T06:56:15+00:00
rename Haddock.Backends.Xhtml.Util to Utils
- - - - -
5a58c0da by David Waern at 2010-07-21T13:30:54+00:00
Remove trailing whitespace in Haddock.Backends.Xhtml
- - - - -
0652aa17 by David Waern at 2010-07-21T13:33:21+00:00
Align a few comments
- - - - -
785776c3 by David Waern at 2010-07-21T13:39:04+00:00
Remove trailing whitespace in H.B.X.Decl
- - - - -
71a30710 by David Waern at 2010-07-21T13:44:27+00:00
Remove more trailing whitespace
- - - - -
38750394 by David Waern at 2010-07-21T13:50:43+00:00
Style police
- - - - -
3023d940 by David Waern at 2010-07-21T14:01:22+00:00
Style police in H.B.X.Decl
- - - - -
df16e9e6 by David Waern at 2010-07-21T14:14:45+00:00
Style police in H.B.X.DocMarkup
- - - - -
6020e321 by David Waern at 2010-07-21T14:17:32+00:00
More style police
- - - - -
86ad8bf5 by David Waern at 2010-07-21T14:21:02+00:00
Style police in H.B.Xhtml
- - - - -
aea27d03 by David Waern at 2010-07-21T14:42:03+00:00
Fix warnings in LaTeX backend
- - - - -
2aff34a9 by David Waern at 2010-07-21T14:50:46+00:00
Style police in LaTeX backend (mainly more newlines)
- - - - -
e517162d by David Waern at 2010-07-21T15:05:47+00:00
Doc sections in Main
- - - - -
b971aa0c by David Waern at 2010-07-21T15:06:17+00:00
Trailing whitespace in Documentation.Haddock
- - - - -
f11628fb by David Waern at 2010-07-21T15:07:06+00:00
Trailing whitespace in Haddock.Convert
- - - - -
cbaf284c by David Waern at 2010-07-21T15:08:11+00:00
Style police in Haddock.GhcUtils
- - - - -
71feb77b by David Waern at 2010-07-21T15:09:06+00:00
Style police in Haddock.InterfaceFile
- - - - -
0a9c80e6 by David Waern at 2010-07-21T15:11:33+00:00
Whitespace police
- - - - -
6168376c by David Waern at 2010-07-21T15:16:35+00:00
Style police in Haddock.Utils
- - - - -
9fe4dd90 by David Waern at 2010-07-21T15:19:31+00:00
Add -fwarn-tabs
- - - - -
a000d752 by Mark Lentczner at 2010-07-20T17:25:52+00:00
move CSS Theme functions into Themes.hs
- - - - -
b52b440f by Mark Lentczner at 2010-07-20T17:29:35+00:00
add Thomas Schilling's theme
- - - - -
e43fa7e8 by Mark Lentczner at 2010-07-21T04:49:34+00:00
correct icon used with Snappy theme
- - - - -
ba5092d3 by Mark Lentczner at 2010-07-21T04:56:47+00:00
apply Tibbe's updates to his theme
- - - - -
7804eef6 by Mark Lentczner at 2010-07-21T05:15:49+00:00
space between "Style" and the downward triangle
- - - - -
7131d4c6 by Mark Lentczner at 2010-07-21T17:43:35+00:00
merge with David's source cleanups
- - - - -
ee65f1cb by David Waern at 2010-07-22T16:50:46+00:00
Fix a bug where we allowed --hoogle, --latex, etc without input files
- - - - -
e413ff7a by David Waern at 2010-07-22T17:21:58+00:00
Improve function name
- - - - -
a0fd14f3 by Simon Marlow at 2010-06-30T15:34:32+00:00
fix warnings
- - - - -
31f73d2a by David Waern at 2010-07-22T19:29:41+00:00
Solve conflicts
- - - - -
d563b4a5 by Simon Marlow at 2010-06-30T15:34:37+00:00
fix warning
- - - - -
412b6469 by David Waern at 2010-07-22T19:31:28+00:00
Solve conflict
- - - - -
35174b94 by Ian Lynagh at 2010-07-06T17:27:16+00:00
Follow mkPState argument order change
- - - - -
b5c3585c by Simon Marlow at 2010-07-14T08:49:21+00:00
common up code for instance rendering
- - - - -
d8009560 by Simon Marlow at 2010-07-14T12:37:11+00:00
fix warnings
- - - - -
a6d88695 by David Waern at 2010-07-24T15:33:33+00:00
Fix build with ghc < 6.13
- - - - -
94cf9de1 by David Waern at 2010-07-24T15:34:37+00:00
Remove conflict left-over
- - - - -
313b15c0 by Mark Lentczner at 2010-07-21T22:09:04+00:00
reorganization of nhaddock.css with tibbe
- - - - -
9defed80 by Mark Lentczner at 2010-07-21T22:42:14+00:00
further cleanup of nhaddock.css, float TOC, support aux. pages
- - - - -
6d944c1b by Mark Lentczner at 2010-07-22T06:22:23+00:00
remove old HTML backend
- - - - -
b3e8cba5 by Mark Lentczner at 2010-07-22T06:43:32+00:00
remove --html-help support - it was old, out-of-date, and mostly missing
- - - - -
d2654a08 by Mark Lentczner at 2010-07-22T21:45:34+00:00
tweaks to nhaddock.css
- - - - -
f73b285c by Mark Lentczner at 2010-07-23T06:19:35+00:00
command like processing for theme selection
  The bulk of the change is threadnig the selected theme set through functions
  in Xhtml.hs so that the selected themes can be used when generating the page
  output. There isn't much going on in most of these changes, just passing it
  along. The real work is all done in Themes.hs.

- - - - -
8bddc90d by Mark Lentczner at 2010-07-23T06:58:31+00:00
drop --themes support, add named theme support
  decided that --themes was silly - no one would do that, just use
    multiple --theme arguments
  made --theme a synonym for --css and -c
  made those arguments, if no file is found, look up the argument as the
    name of a built in theme

  all of this let's haddock be invoked with "--theme=classic" for example.

- - - - -
20cafd4f by Mark Lentczner at 2010-07-23T17:44:29+00:00
rename --default-themes to --built-in-themes
- - - - -
0fe41307 by Mark Lentczner at 2010-07-23T18:33:02+00:00
tweaks to theme for info table, headings, and tables
- - - - -
cba4fee0 by Mark Lentczner at 2010-07-23T19:13:59+00:00
tweaks for dl layout, though still not used
- - - - -
463fa294 by Mark Lentczner at 2010-07-23T21:07:19+00:00
tweak look of mini pages, keywords, and preblocks
- - - - -
5472fc02 by Mark Lentczner at 2010-07-24T05:36:15+00:00
slide out Synopsis drawer
- - - - -
9d5d5de5 by Mark Lentczner at 2010-07-24T06:02:42+00:00
extend package header and footer to edges of page
- - - - -
a47c91a2 by Mark Lentczner at 2010-07-24T06:28:44+00:00
fields are def lists, tweak css for style menu, mini pages, arguments
- - - - -
ca20f23b by Mark Lentczner at 2010-07-24T16:55:22+00:00
excisting last vestiges of the --xhtml flag
- - - - -
71fb012e by Mark Lentczner at 2010-07-25T18:47:49+00:00
change how collapsing sections are done
  make whole .caption be the target
  improve javascript for class toggling
  have plus/minus images come from .css, not img tags

- - - - -
c168c8d3 by Mark Lentczner at 2010-07-26T00:32:05+00:00
reorganize files in the html lib data dir
- - - - -
93324301 by Mark Lentczner at 2010-07-26T01:27:42+00:00
cleaned up Themes.hs
- - - - -
ad3b5dd4 by Mark Lentczner at 2010-07-26T02:39:15+00:00
make module list use new collapsers
- - - - -
1df9bfc6 by Mark Lentczner at 2010-07-27T19:09:25+00:00
remove Tibbe theme
- - - - -
8b9b01b3 by Mark Lentczner at 2010-07-27T20:04:03+00:00
move themes into html dir with .theme and .std-theme extensions
- - - - -
a7beb965 by Mark Lentczner at 2010-07-27T21:06:34+00:00
give a class to empty dd elements so they can be hidden
- - - - -
a258c117 by Mark Lentczner at 2010-07-27T21:23:58+00:00
remove custom version of copyFile in Xhtml.hs
- - - - -
b70dba6e by Mark Lentczner at 2010-07-27T22:12:45+00:00
apply margin changes to pre and headings as per group decision, and small cleanups
- - - - -
e6f722a2 by Mark Lentczner at 2010-07-28T00:03:12+00:00
make info block and package bar links be floatable by placing them first in the dom tree
- - - - -
c8278867 by Mark Lentczner at 2010-07-28T19:01:18+00:00
styling source links on declarations
- - - - -
88fdc399 by Mark Lentczner at 2010-07-29T01:12:46+00:00
styling tweaks
	don't generate an empty li for absent style menu in links area
	update css for Classic and Snappy to handle:
		dl lists
		links in package header and in declarations
		floating of links and info block in package and module headers

- - - - -
8a75b213 by Ian Lynagh at 2010-07-30T20:21:46+00:00
Fix build in GHC tree
- - - - -
ce8e18b3 by Simon Hengel at 2010-08-03T18:37:26+00:00
Adapt paths to data files in cabal file
- - - - -
9701a455 by Simon Hengel at 2010-08-07T13:20:27+00:00
Add missing dependency to cabal file
- - - - -
01b838d1 by Mark Lentczner at 2010-07-30T20:19:40+00:00
improved synopsis drawer: on click, not hover
- - - - -
7b6f3e59 by Mark Lentczner at 2010-07-30T23:38:55+00:00
put the synopsis back in the other themes
- - - - -
7b2904c9 by Mark Lentczner at 2010-08-11T11:11:26+00:00
close arrows on expanded synopsis drawer
- - - - -
ea19e177 by Mark Lentczner at 2010-08-12T21:16:45+00:00
width and font changes
	removed the max width restrictions on the page as a whole and the synopsis
	made the main font size smaller (nominally 14pt) and then tweaked most
	font sizes (relative) to be more consistent

- - - - -
5ced00c0 by Mark Lentczner at 2010-08-13T15:09:55+00:00
implemented YUI's CSS font approach
- - - - -
2799c548 by Mark Lentczner at 2010-08-13T15:11:59+00:00
adjusted margin to 2em, 1 wasn't enough
- - - - -
58f06893 by Mark Lentczner at 2010-08-13T15:48:44+00:00
removed underlining on hover for named anchors
	headings in interface lost thier a element, no need, just put id on heading
	css for a elements now only applies to those with href attribute

- - - - -
7aced4c4 by Mark Lentczner at 2010-08-13T15:50:22+00:00
more space between elements
- - - - -
5a3c1cce by Mark Lentczner at 2010-08-13T16:43:43+00:00
adjusted font sizes of auxilary pages per new scheme
- - - - -
487539ef by Mark Lentczner at 2010-08-13T21:43:41+00:00
add Frames button and clean up frames.html
- - - - -
c1a140b6 by Mark Lentczner at 2010-08-13T22:17:48+00:00
move frames button to js 
- - - - -
b0bdb68e by Mark Lentczner at 2010-08-14T03:44:46+00:00
build style menu in javascript
	moved to javascript, so as to not polute the content with the style menu
	removed menu building code in Themes.hs
	removed onclick in Utils.hs
changed text of button in header from "Source code" to "Source"
	more consistent with links in rest of page

- - - - -
43ab7120 by Mark Lentczner at 2010-08-16T15:15:37+00:00
font size and margin tweaks
- - - - -
c0b68652 by Mark Lentczner at 2010-08-17T18:19:52+00:00
clean up collapser logics
	javascript code for collapasble sections cleaned up
	rewrote class utilities in javascript to be more robust
	refactored utilities for generating collapsable sections
made toc be same color as synopsis
module list has needed clear attribute in CSS

- - - - -
5d573427 by Mark Lentczner at 2010-08-17T23:06:02+00:00
don't collapse entries in module list when clicking on links
- - - - -
8c307c4a by Mark Lentczner at 2010-08-17T23:21:43+00:00
add missing data file to .cabal
- - - - -
414bcfcf by Mark Lentczner at 2010-08-17T23:28:47+00:00
remove synopsis when in frames
- - - - -
ba0fa98a by Mark Lentczner at 2010-08-18T16:16:11+00:00
layout tweeks - mini page font size, toc color, etc.
- - - - -
63c1bed1 by Mark Lentczner at 2010-08-18T19:50:02+00:00
margin fiddling
- - - - -
c311c094 by Mark Lentczner at 2010-08-20T01:37:55+00:00
better synopsis handling logic - no flashing
- - - - -
f1fe5fa8 by Mark Lentczner at 2010-08-20T01:41:06+00:00
fix small layout issues
	mini frames should have same size top heading
	give info block dts some padding so they don't collide in some browsers

- - - - -
0de84d77 by Mark Lentczner at 2010-08-20T02:13:09+00:00
made style changing and cookies storage robust
- - - - -
1ef064f9 by Thomas Schilling at 2010-08-04T13:12:22+00:00
Make synopsis frame behave properly in Firefox.

In Firefox, pressing the back button first reverted the synopsis
frame, and only clicking the back button a second time would update
the main frame.

- - - - -
dd1c9a94 by Mark Lentczner at 2010-08-21T01:46:19+00:00
remove Snappy theme
- - - - -
2353a90d by Mark Lentczner at 2010-08-25T05:16:19+00:00
fix occasional v.scroll bars on pre blocks (I think)
- - - - -
459b8bf1 by Simon Hengel at 2010-08-08T10:12:45+00:00
Add createInterfaces' (a more high-level alternative to createInterfaces) to Haddock API
- - - - -
b1b68675 by David Waern at 2010-08-26T20:31:58+00:00
Follow recent API additions with some refactorings

Simon Hegel's patch prompted me to do some refactorings in Main,
Haddock.Documentation and Haddock.Interface. 

- - - - -
264d4d67 by David Waern at 2010-08-26T21:40:59+00:00
Get rid of GhcModule and related cruft

We can get everything we need directly from TypecheckedModule.

- - - - -
0feacec2 by Mark Lentczner at 2010-08-26T23:44:13+00:00
fixed CSS for ordered lists and def lists in doc blocks
- - - - -
2997e0c2 by Mark Lentczner at 2010-08-26T23:45:03+00:00
support both kinds of enumerated lists in doc markup
	The documentation for Haddock says enumerated lists can use either of
		(1) first item
		2. second item
	The second form wasn't actually supported


- - - - -
5d4ddeec by Mark Lentczner at 2010-08-27T21:29:48+00:00
fix broken header link margins
- - - - -
614456ba by Mark Lentczner at 2010-08-27T22:16:19+00:00
fix table of contents CSS
- - - - -
03f329a2 by David Waern at 2010-08-28T16:36:09+00:00
Update tests following switch to the Xhtml backend
- - - - -
ca689fa2 by Mark Lentczner at 2010-08-28T18:25:16+00:00
fix def lists
- - - - -
18e1d3d2 by Mark Lentczner at 2010-08-28T18:26:18+00:00
push footer to bottom of window
- - - - -
b0ab8d82 by David Waern at 2010-08-28T22:04:32+00:00
Whitespace police
- - - - -
2d217977 by David Waern at 2010-08-29T12:44:45+00:00
Remove Snappy data files
- - - - -
01e27d5f by David Waern at 2010-08-29T13:03:28+00:00
Add source entity path to --read-interface

You can now use this flag like this:

  --read-interface=<html path>,<source entity path>,<.haddock file> 

By "source entity path" I mean the same thing that is specified with the
--source-entity flag. The purpose of this is to be able to specify the source
entity path per package, to allow source links to work in the presence of
cross-package documentation.

When given two arguments or less the --read-interface flag behaves as before.

- - - - -
20bf4aaa by David Waern at 2010-08-29T13:11:03+00:00
Naming wibbles
- - - - -
ad22463f by Mark Lentczner at 2010-08-29T15:14:54+00:00
make portability block be a table - solves layout issues
- - - - -
97bd1ae6 by Mark Lentczner at 2010-08-29T15:17:42+00:00
update golden test for Test due to portability box change
- - - - -
d37e139e by Mark Lentczner at 2010-08-29T17:07:17+00:00
move TOC and Info blocks down 0.5em to improve layout issue w/Test.hs
- - - - -
acf52501 by David Waern at 2010-08-29T17:32:36+00:00
Allow building with ghc < 6.16
- - - - -
1cb34ed8 by Ian Lynagh at 2010-07-24T23:18:49+00:00
Flatten the dynflags before parsing
- - - - -
b36845b4 by Ian Lynagh at 2010-07-24T23:26:49+00:00
Follow flattenLanguageFlags -> flattenExtensionFlags rename
- - - - -
7f7fcc7e by David Waern at 2010-08-29T17:46:23+00:00
Use flattenExtensionFlags with ghc >= 6.13 only
- - - - -
13cf9411 by Ian Lynagh at 2010-08-01T18:09:54+00:00
Make the main haddock script versioned, and make plain "haddock" a symlink
- - - - -
495cbff2 by Ian Lynagh at 2010-08-18T18:57:24+00:00
Fix installation in the GHC build system
Data-files are now in subdirectories, so we need to handle that

- - - - -
88ebab0a by Ian Lynagh at 2010-08-18T19:43:53+00:00
GHC build system: Add all the data files to BINDIST_EXTRAS
- - - - -
65837172 by David Waern at 2010-08-29T20:12:34+00:00
Update Test
- - - - -
094bbaa2 by David Waern at 2010-08-29T20:55:14+00:00
Revert update to Test
- - - - -
a881cfb3 by David Waern at 2010-08-31T18:24:15+00:00
Bump version number
- - - - -
1fc8a3eb by David Waern at 2010-08-31T22:32:27+00:00
Update ANNOUNCE
- - - - -
ee1df9d0 by David Waern at 2010-08-31T22:33:11+00:00
Update CHANGES
- - - - -
394cc854 by David Waern at 2010-08-31T22:33:23+00:00
Update interface file versioning to work with ghc 6.14/15
- - - - -
7d03b79b by David Waern at 2010-08-31T22:36:00+00:00
Update test output following version change
- - - - -
a48d82d1 by Mark Lentczner at 2010-09-01T04:29:35+00:00
sort options in doc to match --help output
	removed --html-help option, as it is no longer supported

- - - - -
06561aeb by Mark Lentczner at 2010-09-01T05:29:32+00:00
update options documentation
	rewrote doc for --html
	added doc for --theme and --built-in-themes
	added --use-contents and --gen-contents

- - - - -
57dea832 by Mark Lentczner at 2010-09-01T05:31:27+00:00
slight wording change about Frames mode
- - - - -
fa1f6da3 by David Waern at 2010-09-01T10:57:44+00:00
Update doc configure script to find docbook stylesheets on arch linux
- - - - -
addff770 by David Waern at 2010-09-01T11:02:29+00:00
Wibble
- - - - -
8399006d by David Waern at 2010-09-01T11:19:21+00:00
Replace ghci> with >>> in example syntax
- - - - -
35074cf8 by David Waern at 2010-09-01T19:03:27+00:00
Improve docs for --no-tmp-comp-dir
- - - - -
0f8f8cfd by David Waern at 2010-09-02T11:22:27+00:00
Add a list of contributors to the user guide

Break out everyone thanked in the `Acknowledgements` chapter into a
separate contributor list and add everyone from `darcs show authors`.
We consider everyone who is thanked to be a contributor as a conservative
estimation :-)

I have added some more contributors that I know about, who were not in the
darcs history, but others may be missing. So please add anyone that you think 
is missing from the list.

- - - - -
42ccf099 by David Waern at 2010-09-02T11:29:22+00:00
Update copyright years in license
- - - - -
0d560479 by David Waern at 2010-09-02T11:38:52+00:00
Update release instructions
- - - - -
72ab7796 by David Waern at 2010-09-02T19:27:08+00:00
Add a note to ANNOUNCE
- - - - -
bf9d9c5d by David Waern at 2010-09-02T19:27:48+00:00
H.Utils needs FFI on Win+MinGW 
- - - - -
048ae44a by Mark Lentczner at 2010-09-04T23:19:47+00:00
make TOC group header identifiers validate
- - - - -
8c6faf36 by Simon Michael at 2010-09-22T07:12:34+00:00
add hints for cleaner darcs show authors output
- - - - -
9909bd17 by Simon Michael at 2010-09-22T17:58:06+00:00
print haddock coverage info on stdout when generating docs
A module's haddockable items are its exports and the module itself.
The output is lightly formatted so you can align the :'s and sort
for readability.

- - - - -
6da72171 by David Waern at 2010-10-03T21:31:24+00:00
Style wibble
- - - - -
2f8d8e4d by Tobias Brandt at 2010-08-27T07:01:21+00:00
adding the option to fully qualify identifiers
- - - - -
833be6c6 by Tobias Brandt at 2010-08-27T15:50:28+00:00
adding support for local and relative name qualification
- - - - -
df15c4e9 by Tobias Brandt at 2010-08-27T15:56:37+00:00
corrected qualification help message
- - - - -
449e9ce1 by David Waern at 2010-10-16T17:34:30+00:00
Solve conflicts
- - - - -
3469bda5 by David Waern at 2010-10-16T18:42:40+00:00
Use "qual" as an abbreviation for qualification instead of "quali" for consistency
- - - - -
97c2d728 by David Waern at 2010-10-16T18:47:07+00:00
Style police
- - - - -
ce14fbea by David Waern at 2010-10-16T21:15:25+00:00
Style police
- - - - -
fdf29e9d by David Waern at 2010-10-17T00:30:44+00:00
Add a pointer to the style guide
- - - - -
8e6b44e8 by rrnewton at 2010-10-24T03:19:28+00:00
Change to index pages: include an 'All' option even when subdividing A-Z.
- - - - -
755b131c by David Waern at 2010-11-14T19:39:36+00:00
Bump version
- - - - -
d0345a04 by David Waern at 2010-11-14T19:41:59+00:00
TAG 2.8.1
- - - - -
f6221508 by Simon Peyton Jones at 2010-09-13T09:53:00+00:00
Adapt to minor changes in internal GHC functions
- - - - -
1290713d by Ian Lynagh at 2010-09-15T10:37:18+00:00
Remove duplicate Outputable instance for Data.Map.Map
- - - - -
87f69eef by Ian Lynagh at 2010-09-21T15:01:10+00:00
Bump GHC dep upper bound
- - - - -
af36e087 by Ian Lynagh at 2010-09-21T15:12:02+00:00
Fix up __GLASGOW_HASKELL__ tests
- - - - -
ad67716c by Ian Lynagh at 2010-09-21T20:31:35+00:00
Don't build haddock is HADDOCK_DOCS is NO
- - - - -
63b3f1f5 by Ian Lynagh at 2010-09-21T21:39:51+00:00
Fixes for when HADDOCK_DOCS=NO
- - - - -
e92bfa42 by Ian Lynagh at 2010-09-29T21:15:38+00:00
Fix URL creation on Windows: Use / not \ in URLs. Fixes haskell/haddock#4353
- - - - -
66c55e05 by Ian Lynagh at 2010-09-30T17:03:34+00:00
Tidy up haddock symlink installation
In particular, it now doesn't get created if we aren't installing
haddock.

- - - - -
549b5556 by Ian Lynagh at 2010-10-23T21:17:14+00:00
Follow extension-flattening change in GHC
- - - - -
d7c2f72b by David Waern at 2010-11-14T20:17:55+00:00
Bump version to 2.8.2
- - - - -
6989a3a9 by David Waern at 2010-11-14T20:26:01+00:00
Solve conflict
- - - - -
055c6910 by Ian Lynagh at 2010-09-22T15:36:20+00:00
Bump GHC dep
- - - - -
c96c0763 by Simon Marlow at 2010-10-27T11:09:44+00:00
follow changes in the GHC API
- - - - -
45907129 by David Waern at 2010-11-07T14:00:58+00:00
Update the HCAR entry
- - - - -
61940b95 by David Waern at 2010-11-07T14:07:34+00:00
Make the HCAR entry smaller
- - - - -
aa590b7d by David Waern at 2010-11-14T21:30:59+00:00
Update HCAR entry with November 2010 version
- - - - -
587f9847 by David Waern at 2010-11-14T23:48:17+00:00
Require ghc >= 7.0
- - - - -
ff5c647c by David Waern at 2010-11-14T23:49:09+00:00
TAG 2.8.2
- - - - -
937fcb4f by David Waern at 2010-11-14T23:49:45+00:00
Solve conflict
- - - - -
8e5d0c1a by David Waern at 2010-11-15T21:09:50+00:00
Remove code for ghc < 7
- - - - -
3d47b70a by David Waern at 2010-11-15T21:11:06+00:00
Fix bad merge
- - - - -
7f4a0d8a by David Waern at 2010-11-15T21:13:57+00:00
Remove more ghc < 7 code
- - - - -
9ee34b50 by David Waern at 2010-11-15T21:31:25+00:00
Match all AsyncExceptions in exception handler
- - - - -
42849c70 by David Waern at 2010-11-15T21:35:31+00:00
Just say "internal error" instead of "internal Haddock or GHC error"
- - - - -
c88c809b by David Waern at 2010-11-15T21:44:19+00:00
Remove docNameOcc under the motto "don't name compositions"
- - - - -
b798fc7c by David Waern at 2010-11-15T23:27:13+00:00
Wibble
- - - - -
2228197e by David Waern at 2010-11-15T23:28:24+00:00
Rename the HCAR entry file
- - - - -
8a3f9090 by David Waern at 2010-11-16T00:05:29+00:00
Remove Haskell 2010 extensions from .cabal file
- - - - -
c7a0c597 by David Waern at 2010-11-16T00:10:28+00:00
Style wibbles
- - - - -
cde707a5 by David Waern at 2010-11-16T00:12:00+00:00
Remove LANGUAGE ForeignFunctionInterface pragmas
- - - - -
1dbda8ed by David Waern at 2010-11-16T00:17:21+00:00
Make a little more use of DoAndIfThenElse
- - - - -
4c45ff6e by David Waern at 2010-11-16T00:59:41+00:00
hlint police
- - - - -
d2feaf09 by David Waern at 2010-11-16T01:14:15+00:00
hlint police
- - - - -
99876e97 by David Waern at 2010-11-20T19:06:00+00:00
Haddock documentation updates
- - - - -
65ce6987 by David Waern at 2010-11-20T19:42:51+00:00
Follow the style guide closer in Haddock.Types and improve docs
- - - - -
28ca304a by tob.brandt at 2010-11-20T17:04:40+00:00
add full qualification for undocumented names
- - - - -
d61341e3 by David Waern at 2010-11-20T20:04:15+00:00
Re-structure qualification code a little
- - - - -
0057e4d6 by David Waern at 2010-11-20T20:07:55+00:00
Re-order functions
- - - - -
d7279afd by David Waern at 2010-11-21T03:39:54+00:00
Add BangPatterns to alex and happy source files
- - - - -
629fe60e by tob.brandt at 2010-11-23T23:35:11+00:00
documentation for qualification
- - - - -
37031cee by David Waern at 2010-11-23T21:06:44+00:00
Update CHANGES - don't mention 2.8.2, we won't release it
- - - - -
f2489e19 by David Waern at 2010-12-01T21:57:11+00:00
Update deps of runtests.hs to work with ghc 7.0.1
- - - - -
d3657e9a by David Waern at 2010-12-01T22:04:57+00:00
Make tests compile with ghc 7.0.1
- - - - -
a2f09d9b by David Waern at 2010-12-01T22:06:59+00:00
Update tests following version bump
- - - - -
50883ebb by David Waern at 2010-12-06T14:09:18+00:00
Update tests following recent changes
- - - - -
fc2fadeb by David Waern at 2010-12-06T14:17:29+00:00
Add a flag --pretty-html for rendering indented html with newlines
- - - - -
30832ef2 by David Waern at 2010-12-06T14:17:35+00:00
Use --pretty-html when running the test suite. Makes it easier to compare output
- - - - -
a0b81b31 by David Waern at 2010-12-06T14:18:27+00:00
Wibble
- - - - -
3aaa23fe by David Waern at 2010-12-06T14:19:29+00:00
Haddockify ppHtml comments
- - - - -
24bb24f0 by David Waern at 2010-12-06T14:23:15+00:00
Remove --debug. It was't used, and --verbosity should take its place
- - - - -
6bc076e5 by David Waern at 2010-12-06T14:25:37+00:00
Rename golden-tests into html-tests. "golden tests" sounds strange
- - - - -
53301e55 by David Waern at 2010-12-06T14:26:26+00:00
QUALI -> QUAL in the description --qual for consistency
- - - - -
98b6affb by David Waern at 2010-12-06T21:54:02+00:00
Bump version
- - - - -
371bf1b3 by David Waern at 2010-12-06T22:08:55+00:00
Update tests following version bump
- - - - -
25be762d by David Waern at 2010-12-06T22:21:03+00:00
Update CHANGES
- - - - -
7c7dac71 by David Waern at 2010-12-06T22:33:43+00:00
Update ANNOUNCE
- - - - -
30d7a5f2 by Simon Peyton Jones at 2010-11-15T08:38:38+00:00
Alex generates BangPatterns, so make Lex.x accept them

(It'd be better for Alex to generate this pragma.)

- - - - -
605e8018 by Simon Marlow at 2010-11-17T11:37:24+00:00
Add {-# LANGUAGE BangPatterns #-} to mollify GHC
- - - - -
a46607ba by David Waern at 2010-12-07T14:08:10+00:00
Solve conflicts
- - - - -
b28cda66 by David Waern at 2010-12-09T20:41:35+00:00
Docs: Mention that \ is a special character in markup
- - - - -
a435bfdd by Ian Lynagh at 2010-11-17T14:01:19+00:00
TAG GHC 7.0.1 release
- - - - -
5a15a05a by David Waern at 2010-12-11T17:51:19+00:00
Fix indentation problem
- - - - -
4232289a by Lennart Kolmodin at 2010-12-17T18:32:03+00:00
Revise haddock.cabal given that we now require ghc-7
default-language should be Haskell2010, slight new semantics for extensions.
Rewrite into clearer dependencies of base and Cabal.

- - - - -
a36302dc by David Waern at 2010-12-19T17:12:37+00:00
Update CHANGES
- - - - -
7c8b85b3 by David Waern at 2010-12-19T17:14:24+00:00
Bump version
- - - - -
cff22813 by Ian Lynagh at 2011-01-05T18:24:27+00:00
Write hoogle output in utf8; fixes GHC build on Windows
- - - - -
c7e762ea by David Waern at 2011-01-22T00:00:35+00:00
Put title outside doc div when HTML:fying title+prologue

Avoids indenting the title, and makes more sense since the title
is not a doc string anyway.

- - - - -
5f639054 by David Waern at 2011-01-22T16:09:44+00:00
Fix spelling error - contributed by Marco Silva
- - - - -
c11dce78 by Ian Lynagh at 2011-01-07T02:33:11+00:00
Follow GHC build system changes
- - - - -
101cfaf5 by David Waern at 2011-01-08T14:06:44+00:00
Bump version
- - - - -
af62348b by David Waern at 2011-01-08T14:07:07+00:00
TAG 2.9.2
- - - - -
4d1f6461 by Ian Lynagh at 2011-01-07T23:06:57+00:00
Name the haddock script haddock-ghc-7.0.2 instead of haddock-7.0.2; haskell/haddock#4882
"7.0.2" looked like a haddock version number before

- - - - -
8ee4d5d3 by Simon Peyton Jones at 2011-01-10T17:31:12+00:00
Update Haddock to reflect change in hs_tyclds field of HsGroup
- - - - -
06f3e3db by Ian Lynagh at 2011-03-03T15:02:37+00:00
TAG GHC 7.0.2 release
- - - - -
7de0667d by David Waern at 2011-03-10T22:47:13+00:00
Update CHANGES
- - - - -
33a9f1c8 by David Waern at 2011-03-10T22:47:31+00:00
Fix build with ghc 7.0.1
- - - - -
4616f861 by David Waern at 2011-03-10T22:47:50+00:00
TAG 2.9.2-actual
- - - - -
0dab5e3c by Simon Hengel at 2011-04-08T15:53:01+00:00
Set shell script for unit tests back to work
- - - - -
85c54dee by Simon Hengel at 2011-04-08T16:01:24+00:00
Set unit tests back to work

Here "ghci>" was still used instead of ">>>".

- - - - -
1cea9b78 by Simon Hengel at 2011-04-08T16:25:36+00:00
Update runtests.hs for GHC 7.0.2
- - - - -
8e5b3bbb by Simon Hengel at 2011-04-08T16:28:49+00:00
Update Haddock version in *.html.ref
- - - - -
2545e955 by Simon Hengel at 2011-04-08T17:09:28+00:00
Add support for blank lines in the result of examples

Result lines that only contain the string "<BLANKLINE>" are treated as a blank
line.

- - - - -
adf64d2e by Simon Hengel at 2011-04-08T17:36:50+00:00
Add documentation for "support for blank lines in the result of examples"
- - - - -
c51352ca by David Waern at 2011-05-21T23:57:56+00:00
Improve a haddock comment
- - - - -
7419cf2c by David Waern at 2011-05-22T15:41:52+00:00
Use cabal's test suite support to run the test suite

This gives up proper dependency tracking of the test script.

- - - - -
7770070c by David Waern at 2011-05-22T01:45:44+00:00
We don't need to send DocOptions nor a flag to mkExportItems
- - - - -
9d95b7b6 by David Waern at 2011-05-22T21:39:03+00:00
Fix a bug
- - - - -
1f93699b by David Waern at 2011-05-22T21:40:21+00:00
Break out fullContentsOf, give it a better name and some documentation

The documentation describes how we want this function to eventually behave,
once we have fixed a few problems with the current implementation.

- - - - -
9a86432f by David Waern at 2011-05-22T21:53:52+00:00
Fix some stylistic issues in mkExportItems
- - - - -
c271ff0c by David Waern at 2011-05-22T22:09:11+00:00
Indentation
- - - - -
93e602b1 by David Waern at 2011-06-10T01:35:31+00:00
Add git commits since switchover:

  darcs format (followed by a conflict resolution):

  commit 6f92cdd12d1354dfbd80f8323ca333bea700896a
  Merge: f420cc4 28df3a1
  Author: Simon Peyton Jones <simonpj at microsoft.com>
  Date:   Thu May 19 17:54:34 2011 +0100

      Merge remote branch 'origin/master' into ghc-generics

  commit 28df3a119f770fdfe85c687dd73d5f6712b8e7d0
  Author: Max Bolingbroke <batterseapower at hotmail.com>
  Date:   Sat May 14 22:37:02 2011 +0100

      Unicode fix for getExecDir on Windows

  commit 89813e729be8bce26765b95419a171a7826f6d70
  Merge: 6df3a04 797ab27
  Author: Simon Peyton Jones <simonpj at microsoft.com>
  Date:   Mon May 9 11:55:17 2011 +0100

      Merge branch 'ghc-new-co'

  commit 6df3a040da3dbddee67c6e30a892f87e6b164383
  Author: Ian Lynagh <igloo at earth.li>
  Date:   Sun May 8 17:05:50 2011 +0100

      Follow changes in SDoc

  commit f420cc48b9259f0b1afd2438b12f9a2bde57053d
  Author: Jose Pedro Magalhaes <jpm at cs.uu.nl>
  Date:   Wed May 4 17:31:52 2011 +0200

      Adapt haddock to the removal of HsNumTy and TypePat.

  commit 797ab27bdccf39c73ccad374fea265f124cb52ea
  Merge: 1d81436 5a91450
  Author: Simon Peyton Jones <simonpj at microsoft.com>
  Date:   Mon May 2 12:05:03 2011 +0100

      Merge remote branch 'origin/master' into ghc-new-co

  commit 1d8143659a81cf9611668348e33fd0775c7ab1d2
  Author: Simon Peyton Jones <simonpj at microsoft.com>
  Date:   Mon May 2 12:03:46 2011 +0100

      Wibbles for ghc-new-co branch

  commit 5a91450e2ea5a93c70bd3904b022445c9cc82488
  Author: Ian Lynagh <igloo at earth.li>
  Date:   Fri Apr 22 00:51:56 2011 +0100

      Follow defaultDynFlags change in GHC

- - - - -
498da5ae by David Waern at 2011-06-11T00:33:33+00:00
* Merge in git patch from Michal Terepeta

>From 6fc71d067738ef4b7de159327bb6dc3d0596be29 Mon Sep 17 00:00:00 2001
From: Michal Terepeta <michal.terepeta at gmail.com>
Date: Sat, 14 May 2011 19:18:22 +0200
Subject: [PATCH] Follow the change of TypeSig in GHC.

This follows the change in GHC to make TypeSig take a list
of names (instead of just one); GHC ticket haskell/haddock#1595. This
should also improve the Haddock output in case the user
writes a type signature that refers to many names:
  -- | Some comment..
  foo, bar :: ...
will now generate the expected output with one signature for
both names.

- - - - -
094607fe by Ian Lynagh at 2011-06-17T19:10:29+01:00
Fix build

- - - - -
8fa35740 by Ian Lynagh at 2011-06-26T21:06:40+01:00
Bump GHC dep to allow 7.2

- - - - -
e4d2ca3c by Ian Lynagh at 2011-07-07T23:06:28+01:00
Relax base dep

- - - - -
b948fde9 by Ian Lynagh at 2011-07-28T16:39:45+01:00
GHC build system: Don't install the datafiles twice

- - - - -
f82f6d70 by Simon Marlow at 2011-08-11T12:08:15+01:00
Hack this to make it work with both Alex 2.x and Alex 3.x.  Unicode in
documentation strings is (still) mangled.  I don't think it's possible
to make it so that we get the current behaviour with Alex 2.x but
magic Unicode support if you use Alex 3.x.  At some point we have to
decide that Alex 3.x is a requirement, then we can do Unicode.

- - - - -
b341cc12 by Max Bolingbroke at 2011-08-22T20:25:27+01:00
Fix compilation with no-pred-ty GHC

- - - - -
30494581 by Max Bolingbroke at 2011-08-23T10:20:54+01:00
Remaining fixes for PredTy removal

- - - - -
0b197138 by Max Bolingbroke at 2011-08-26T08:27:45+01:00
Rename factKind to constraintKind

- - - - -
a379bec5 by Max Bolingbroke at 2011-09-04T12:54:47+01:00
Deal with change to IParam handling in GHC

- - - - -
f94e421b by Max Bolingbroke at 2011-09-06T17:34:31+01:00
Adapt Haddock for the ConstraintKind extension changes

- - - - -
8821e5cc by Max Bolingbroke at 2011-09-09T08:24:59+01:00
Ignore associated type defaults (just as we ignore default methods)

- - - - -
31a0afd4 by Max Bolingbroke at 2011-09-09T09:06:00+01:00
Merge branch 'no-pred-ty' of ssh://darcs.haskell.org/srv/darcs/haddock into no-pred-ty

- - - - -
dd3b530a by Max Bolingbroke at 2011-09-09T14:10:25+01:00
Merge branch 'no-pred-ty'

Conflicts:
	src/Haddock/Convert.hs

- - - - -
5f25ec96 by Max Bolingbroke at 2011-09-09T14:10:40+01:00
Replace FactTuple with ConstraintTuple

- - - - -
cd30b9cc by David Waern at 2011-09-26T02:17:55+02:00
Bump to version 2.9.3

- - - - -
4fbfd397 by Max Bolingbroke at 2011-09-27T14:55:21+01:00
Follow changes to BinIface Name serialization

- - - - -
92257d90 by David Waern at 2011-09-30T23:45:07+02:00
Fix problem with test files not added to distribution tarball

- - - - -
00255bda by David Waern at 2011-09-30T23:48:24+02:00
Merge branch 'development'

- - - - -
5421264f by David Waern at 2011-10-01T01:25:39+02:00
Merge in darcs patch from Simon Meier:

  Wed Jun  1 19:41:16 CEST 2011  iridcode at gmail.com
    * prettier haddock coverage info
    The new coverage info rendering uses less horizontal space. This reduces the
    number of unnecessary line-wrappings. Moreover, the most important information,
    how much has been documented already, is now put up front. Hopefully, this
    makes it more likely that a library author is bothered by the low coverage of
    his modules and fixes that issue ;-)

- - - - -
07d318ef by David Waern at 2011-10-01T01:34:10+02:00
Use printException instead of deprecated printExceptionAndWarnings

- - - - -
40d52ee4 by David Waern at 2011-10-01T01:41:13+02:00
Merge in darcs pach:

  Mon Apr 11 18:09:54 JST 2011  Liyang HU <haddock at liyang.hu>
    * Remember collapsed sections in index.html / haddock-util.js

- - - - -
279d6dd4 by David Waern at 2011-10-01T01:55:45+02:00
Merge in darcs patch:

  Joachim Breitner <mail at joachim-breitner.de>**20110619201645
  Ignore-this: f6c51228205b0902ad5bfad5040b989a

  As reported on http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=578301,
  generating the global index takes much too long if type-level (with lots of
  auto-generated types) is installed. The patch avoids a quadratic runtime in the
  subfunction getIfaceIndex of ppHtmlIndex by using a temporary set. Runtime improvement observed here from 25.36s to 2.86s.

- - - - -
d1612383 by David Waern at 2011-10-01T01:56:48+02:00
Merge branch 'development'

- - - - -
347520c1 by David Waern at 2011-10-01T01:56:54+02:00
Merge branch 'master' of http://darcs.haskell.org/haddock

- - - - -
9a0c95e8 by David Waern at 2011-10-01T02:19:10+02:00
Improve .cabal file

- - - - -
6967dc64 by Ian Lynagh at 2011-10-01T01:34:06+01:00
Follow changes to ForeignImport/ForeignExport in GHC

- - - - -
565cb26b by Simon Marlow at 2011-10-04T00:15:04+02:00
Hack this to make it work with both Alex 2.x and Alex 3.x.  Unicode in
documentation strings is (still) mangled.  I don't think it's possible
to make it so that we get the current behaviour with Alex 2.x but
magic Unicode support if you use Alex 3.x.  At some point we have to
decide that Alex 3.x is a requirement, then we can do Unicode.

- - - - -
8b74f512 by David Waern at 2011-10-04T00:18:17+02:00
Requre ghc >= 7.2

- - - - -
271d360c by David Waern at 2011-10-04T00:22:50+02:00
Bump version to 2.9.4

- - - - -
37f3edb0 by David Waern at 2011-10-06T02:30:21+02:00
Add alex and happy to build-tools.

- - - - -
7ac2bb6e by David Terei at 2011-10-12T14:02:55-07:00
Add safe haskell indication to haddock output

- - - - -
42c91a47 by David Terei at 2011-10-12T14:06:03-07:00
Fix CSS issue with info table not being contained in module header

- - - - -
0eddab6c by David Terei at 2011-10-12T14:06:58-07:00
Add safe haskell indication to haddock output

- - - - -
3df058eb by David Terei at 2011-10-12T14:07:07-07:00
Fix CSS issue with info table not being contained in module header

- - - - -
a40a6c3f by David Waern at 2011-10-22T11:29:06+02:00
Bump .haddock file version since the format has changed recently

- - - - -
8a6254be by David Waern at 2011-10-22T11:30:42+02:00
Merge branch 'development'

- - - - -
642e3e02 by David Waern at 2011-10-23T21:23:39+02:00
Sort import list

- - - - -
36371cf8 by David Waern at 2011-10-23T22:48:18+02:00
Remove NEW_GHC_LAYOUT conditional.

- - - - -
5604b499 by David Waern at 2011-10-27T00:15:03+02:00
Add --print-ghc-path.

- - - - -
463499fa by David Waern at 2011-10-27T00:16:22+02:00
Make testsuite able to find its dependencies automatically.

- - - - -
a3506172 by Ryan Newton at 2011-11-05T05:59:58-04:00
Improved declNames internal error.  Added a case to handle DocD.

- - - - -
001b8baf by David Waern at 2011-11-05T20:37:29+01:00
Rename copy.hs -> accept.hs.

- - - - -
55d808d3 by David Waern at 2011-11-05T23:30:02+01:00
Fix build.

- - - - -
deb5c3be by David Waern at 2011-11-06T00:01:47+01:00
Merge branch 'master' of http://darcs.haskell.org/haddock

- - - - -
9b663554 by David Waern at 2011-11-06T00:03:45+01:00
Merge https://github.com/rrnewton/haddock

- - - - -
1abb0ff6 by David Waern at 2011-11-06T01:20:37+01:00
Use getDeclMainBinder instead of declNames.

- - - - -
4b005c01 by David Waern at 2011-11-06T19:09:53+01:00
Fix build.

- - - - -
c2c51bc7 by Ian Lynagh at 2011-11-06T23:01:33+00:00
Remove -DNEW_GHC_LAYOUT in ghc.mk

- - - - -
f847d703 by Jose Pedro Magalhaes at 2011-11-11T09:07:39+00:00
New kind-polymorphic core

This big patch implements a kind-polymorphic core for GHC. The current
implementation focuses on making sure that all kind-monomorphic programs still
work in the new core; it is not yet guaranteed that kind-polymorphic programs
(using the new -XPolyKinds flag) will work.

For more information, see http://haskell.org/haskellwiki/GHC/Kinds

- - - - -
7d7c3b09 by Jose Pedro Magalhaes at 2011-11-16T21:42:22+01:00
Follow changes to tuple sorts in master

- - - - -
8430e03e by Simon Peyton Jones at 2011-11-17T10:20:27+00:00
Remove redundant imports

- - - - -
d1b06832 by Ian Lynagh at 2011-11-19T01:33:21+00:00
Follow GHC build system change to the way we call rm

- - - - -
9e2230ed by David Waern at 2011-11-24T15:00:24+01:00
Fix a bug in test runner and get rid of regex-compat dependency.

- - - - -
52039b21 by David Waern at 2011-11-24T23:55:36+01:00
Avoid haskell98 dependency in test

- - - - -
92e1220d by David Waern at 2011-11-25T00:03:33+01:00
Avoid depency on regex-compat also in accept.hs.

- - - - -
ddac6b6f by David Waern at 2011-11-25T02:13:38+01:00
Accept test output.

- - - - -
5a720455 by David Waern at 2011-11-25T02:16:20+01:00
Some more changes to test scripts.

- - - - -
170a9004 by David Waern at 2011-11-25T02:30:41+01:00
Add flag --interface-version.

- - - - -
d225576c by David Waern at 2011-11-25T02:39:26+01:00
Remove #ifs for older compiler versions.

- - - - -
f0d0a4f5 by David Waern at 2011-11-26T04:20:12+01:00
Give preference to type over data constructors for doc comment links at renaming time.

Previously this was done in the backends.

Also, warn when a doc comment refers to something that is in scope but which we
don't have the .haddock file for.

These changes mean we can make DocIdentifier [a] into DocIdentifier a.

- - - - -
eef0e776 by David Waern at 2011-11-26T17:01:06+01:00
Allow doc comments to link to out-of-scope things (#78).

(A bug that should have been fixed long ago.)

- - - - -
565ad529 by David Waern at 2011-11-26T19:56:21+01:00
Update tests.

- - - - -
fb3ce7b9 by David Waern at 2011-11-26T21:44:28+01:00
Cleanup.

- - - - -
d0328126 by David Waern at 2011-11-26T22:10:28+01:00
Fix module reference bug.

- - - - -
c03765f8 by David Waern at 2011-12-03T05:20:20+01:00
Slightly better behaviour on top-levels without type signatures.

- Docs don't get attached to the next top-level with signature by
mistake.

- If there's an export list and the top-level is part of it,
its doc comment shows up in the documentation.

- - - - -
48461d31 by David Waern at 2011-12-03T05:38:10+01:00
Add a test for Unicode doc comments.

- - - - -
549c4b4e by David Waern at 2011-12-03T19:07:55+01:00
Cleanup.

- - - - -
7bfecf91 by David Waern at 2011-12-03T20:13:08+01:00
More cleanup.

- - - - -
14fab722 by Ian Lynagh at 2011-12-12T21:21:35+00:00
Update dependencies and binaryInterfaceVersion

- - - - -
469e6568 by Ian Lynagh at 2011-12-18T12:56:16+00:00
Fix (untested) building from source tarball without alex/happy

haddock's .cabal file was declaring that it needed alex and happy to
build, but in the GHC source tarballs it doesn't.

- - - - -
895c9a8c by David Waern at 2011-12-27T12:57:43+01:00
Go back to having a doc, sub and decl map instead of one big decl map.

This setup makes more sense since when we add value bindings to the
processed declarations (for type inference), we will have multiple
declarations which should share documentation. Also, we already have
a separate doc map for instances which we can now merge into the
main doc map. Another benefit is that we don't need the DeclInfo
type any longer.

- - - - -
736767d9 by David Waern at 2011-12-27T13:33:41+01:00
Merge ../../../haddock

Conflicts:
	src/Haddock/InterfaceFile.hs

- - - - -
20016f79 by David Waern at 2011-12-27T13:57:23+01:00
Bump version.

- - - - -
31f276fb by David Waern at 2011-12-27T13:57:32+01:00
Merge ../ghc/utils/haddock

- - - - -
95b367cd by David Waern at 2011-12-27T14:57:29+01:00
Update tests following version bump.

- - - - -
fa3c94cd by David Waern at 2011-12-27T14:57:51+01:00
Get rid of quite unnecessary use of different lists.

- - - - -
9c4d3c54 by David Waern at 2011-12-27T15:26:42+01:00
Cleanup.

- - - - -
2caf9f90 by David Waern at 2011-12-27T16:18:05+01:00
Wibbles.

- - - - -
3757d09b by David Waern at 2011-12-27T20:50:26+01:00
Complete support for inferring types for top-level bindings.

- - - - -
53418734 by David Waern at 2011-12-28T15:02:13+01:00
Minor fixes and cleanup.

- - - - -
0c9d0385 by Ian Lynagh at 2012-01-03T18:31:29+00:00
Follow rename of Instance to ClsInst in GHC

- - - - -
c9bc969a by Simon Hengel at 2012-01-12T21:28:14+01:00
Make sure that generated xhtml is valid (close haskell/haddock#186)

Thanks to Phyx.

- - - - -
836a0b9a by David Waern at 2012-02-01T02:30:05+01:00
Fix bug introduced in my recent refactoring.

- - - - -
c7d733eb by David Waern at 2012-02-01T02:30:26+01:00
Cleanup mkMaps and avoid quadratic behaviour.

- - - - -
da3cda8f by David Waern at 2012-02-01T02:56:56+01:00
Require ghc >= 7.4.

- - - - -
83a3287e by David Waern at 2012-02-01T02:57:36+01:00
Update CHANGES.

- - - - -
93408f0b by Simon Hengel at 2012-02-04T00:48:04+01:00
Add reference renderings

- - - - -
49d00d2c by Simon Hengel at 2012-02-04T00:48:25+01:00
Set unit tests for parser back to work

- - - - -
eb450980 by Simon Hengel at 2012-02-04T00:49:07+01:00
Add .gitignore

- - - - -
a841602c by Simon Hengel at 2012-02-04T00:49:16+01:00
Add .ghci file

- - - - -
8861199d by Simon Hengel at 2012-02-04T00:49:29+01:00
tests/html-tests/copy.hs: Use mapM_ instead of mapM

So we do net get a list of () on stdout when running with runhaskell.

- - - - -
b477d9b5 by Simon Hengel at 2012-02-04T00:49:46+01:00
Remove index files from golden tests

- - - - -
9dbda34e by Simon Hengel at 2012-02-04T00:49:57+01:00
Add /tests/html-tests/tests/*index*.ref to .gitignore

- - - - -
a9434817 by Simon Hengel at 2012-02-04T00:50:04+01:00
Add DocWarning to Doc

The Xhtml backend has special markup for that, Hoogle and LaTeX reuse
what we have for DocEmphasis.

- - - - -
de2fb6fa by Simon Hengel at 2012-02-04T00:50:13+01:00
Add support for module warnings

- - - - -
0640920e by Simon Hengel at 2012-02-04T00:50:21+01:00
Add tests for module warnings

- - - - -
30ce0d77 by Simon Hengel at 2012-02-04T00:50:29+01:00
Add support for warnings

- - - - -
bb367960 by Simon Hengel at 2012-02-04T00:50:37+01:00
Add tests for warnings

- - - - -
6af1dc2d by Simon Hengel at 2012-02-04T00:50:50+01:00
Expand type signatures in export list (fixes haskell/haddock#192)

- - - - -
a06cbf25 by Simon Hengel at 2012-02-04T00:51:04+01:00
Expand type signatures for modules without explicit export list

- - - - -
57dda796 by Simon Hengel at 2012-02-04T00:51:15+01:00
Remove obsolete TODO

- - - - -
270c3253 by David Waern at 2012-02-04T00:51:24+01:00
Fix issues in support for warnings.

* Match against local names only.
* Simplify (it's OK to map over the warnings).

- - - - -
683634bd by David Waern at 2012-02-04T00:55:11+01:00
Some cleanup and make sure we filter warnings through exports.

- - - - -
210cb4ca by David Waern at 2012-02-04T03:01:30+01:00
Merge branch 'fix-for-186' of https://github.com/sol/haddock into ghc-7.4

- - - - -
e8db9031 by David Waern at 2012-02-04T03:07:51+01:00
Style police.

- - - - -
261f9462 by David Waern at 2012-02-04T03:20:16+01:00
Update tests.

- - - - -
823cfc7c by David Waern at 2012-02-04T03:21:12+01:00
Use mapM_ in accept.hs as well.

- - - - -
873dd619 by David Waern at 2012-02-04T03:21:33+01:00
Remove copy.hs - use accept.hs instead.

- - - - -
0e31a14a by David Waern at 2012-02-04T03:47:33+01:00
Use <> instead of mappend.

- - - - -
2ff7544f by David Waern at 2012-02-04T03:48:55+01:00
Remove code for older ghc versions.

- - - - -
dacf2786 by David Waern at 2012-02-04T15:52:51+01:00
Clean up some code from last SoC project.

- - - - -
00cbb117 by David Waern at 2012-02-04T21:43:49+01:00
Mostly hlint-inspired cleanup.

- - - - -
7dc86cc2 by Simon Peyton Jones at 2012-02-06T09:14:41+00:00
Track changes in HsDecls

- - - - -
f91f82fe by Ian Lynagh at 2012-02-16T13:40:11+00:00
Follow changes in GHC caused by the CAPI CTYPE pragma

- - - - -
a0ea6b0b by Ian Lynagh at 2012-02-22T02:26:12+00:00
Follow changes in GHC

- - - - -
b23b07d1 by Simon Peyton Jones at 2012-03-02T16:36:41+00:00
Follow changes in data representation from the big PolyKinds commit

- - - - -
43406022 by Simon Hengel at 2012-03-05T11:18:34+01:00
Save/restore global state for static flags when running GHC actions

This is necessary if we want to run createInterfaces (from
Documentation.Haddock) multiple times in the same process.

- - - - -
9fba16fe by Paolo Capriotti at 2012-03-06T10:57:33+00:00
Update .gitignore.

- - - - -
a9325044 by Simon Peyton Jones at 2012-03-14T17:35:42+00:00
Follow changes to tcdKindSig (Trac haskell/haddock#5937)

- - - - -
fd48065a by Iavor Diatchki at 2012-03-15T22:43:35-07:00
Add support for type-level literals.

- - - - -
2e8206dd by Simon Peyton Jones at 2012-03-16T14:18:22+00:00
Follow changes to tcdKindSig (Trac haskell/haddock#5937)

- - - - -
93e13319 by Simon Peyton Jones at 2012-03-17T01:04:05+00:00
Merge branch 'master' of http://darcs.haskell.org//haddock

Conflicts:
	src/Haddock/Convert.hs

- - - - -
d253fa71 by Iavor Diatchki at 2012-03-19T20:12:18-07:00
Merge remote-tracking branch 'origin/master' into type-nats

- - - - -
fc40acc8 by Iavor Diatchki at 2012-03-19T20:31:27-07:00
Add a missing case for type literals.

- - - - -
fd2ad699 by Iavor Diatchki at 2012-03-24T13:28:29-07:00
Rename variable to avoid shadowing warning.

- - - - -
9369dd3c by Simon Peyton Jones at 2012-03-26T09:14:23+01:00
Follow refactoring of TyClDecl/HsTyDefn

- - - - -
38825ca5 by Simon Peyton Jones at 2012-03-26T09:14:37+01:00
Merge branch 'master' of http://darcs.haskell.org//haddock

- - - - -
4324ac0f by David Waern at 2012-04-01T01:51:19+02:00
Disable unicode test.

- - - - -
3165b750 by David Waern at 2012-04-01T01:51:34+02:00
Take reader environment directly from TypecheckedSource.

- - - - -
213b644c by David Waern at 2012-04-01T01:55:20+02:00
Cleanup.

- - - - -
3118b4ba by David Waern at 2012-04-01T02:16:15+02:00
Don't filter out unexported names from the four maps - fixes a regression.

- - - - -
d6524e17 by David Waern at 2012-04-01T02:40:34+02:00
Fix crash when using --qual. Naughty GHC API!

- - - - -
ea3c43d8 by Henning Thielemann at 2012-04-01T13:03:07+02:00
add QualOption type for distinction between qualification argument given by the user
and the actual qualification for a concrete module
- - - - -
5422ff05 by Henning Thielemann at 2012-04-01T16:25:02+02:00
emit an error message when the --qual option is used incorrectly
- - - - -
026e3404 by David Waern at 2012-04-01T18:10:30+02:00
Don't crash on unicode strings in doc comments.

- - - - -
ce006632 by David Waern at 2012-04-01T20:13:35+02:00
Add test for --ignore-all-exports flag/ignore-exports pragma.

- - - - -
6e4dd33c by David Waern at 2012-04-01T20:21:03+02:00
Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.4

- - - - -
734ae124 by Henning Thielemann at 2012-04-01T20:22:10+02:00
Merge branch 'ghc-7.4' of http://darcs.haskell.org/haddock into ghc-7.4

- - - - -
622f9ba5 by David Waern at 2012-04-01T21:26:13+02:00
Merge http://code.haskell.org/~thielema/haddock/ into ghc-7.4

- - - - -
55ce17cb by Henning Thielemann at 2012-04-01T22:03:25+02:00
'abbreviate' qualification style - basic support
Currently we ignore the package a module is imported from.
This means that a module import would shadow another one
with the same module name from a different package.
- - - - -
c85314ef by David Waern at 2012-04-01T22:05:12+02:00
Check qualification option before processing modules.

- - - - -
ae4b626c by Henning Thielemann at 2012-04-02T00:19:36+02:00
abbreviated qualification: use Packages.lookupModuleInAllPackages for finding the package that a module belongs to
- - - - -
60bdbcf5 by Henning Thielemann at 2012-04-02T00:25:31+02:00
Merge branch 'ghc-7.4' of http://darcs.haskell.org/haddock into ghc-7.4

- - - - -
df44301d by Henning Thielemann at 2012-04-02T00:29:05+02:00
qualification style 'abbreviated' -> 'aliased'

- - - - -
f4192a64 by David Waern at 2012-04-02T01:05:47+02:00
Merge http://code.haskell.org/~thielema/haddock/ into ghc-7.4

- - - - -
7ba09067 by David Terei at 2012-04-04T15:08:21-07:00
Fix reporting of modules safe haskell mode (#5989)

- - - - -
d0cc33d0 by David Terei at 2012-04-06T15:50:41+01:00
Fix reporting of modules safe haskell mode (#5989)

- - - - -
6e3434c5 by Simon Peyton Jones at 2012-04-20T18:37:46+01:00
Track changes in HsSyn

- - - - -
22014ed0 by Simon Peyton Jones at 2012-05-11T22:45:15+01:00
Follow changes to LHsTyVarBndrs

- - - - -
d9a07b24 by David Waern at 2012-05-15T01:46:35+02:00
Merge branch 'ghc-7.4' of http://darcs.haskell.org/haddock into ghc-7.4

- - - - -
a6c4ebc6 by David Waern at 2012-05-16T02:18:32+02:00
Update CHANGES.

- - - - -
8e181d29 by David Waern at 2012-05-16T02:27:56+02:00
Merge http://code.haskell.org/~thielema/haddock/ into ghc-7.4

- - - - -
e358210d by David Waern at 2012-05-16T02:35:33+02:00
Mention the new aliased --qual mode in CHANGES.

- - - - -
efd36a28 by David Waern at 2012-05-16T21:33:13+02:00
Bump version number.

- - - - -
d6b3af14 by Simon Hengel at 2012-05-17T19:08:20+02:00
Add test for deprecated record field

- - - - -
927f800e by Simon Hengel at 2012-05-17T19:08:20+02:00
Use >>= instead of fmap and join

- - - - -
048b41d5 by Simon Hengel at 2012-05-17T19:08:20+02:00
newtype-wrap Doc nodes for things that may have warnings attached

- - - - -
e3a89fc3 by Simon Hengel at 2012-05-17T19:08:20+02:00
Attach warnings to `Documentation` type

- - - - -
5d4cc43d by Simon Hengel at 2012-05-17T19:08:20+02:00
Simplify lookupWarning

- - - - -
cf8ae69d by Simon Hengel at 2012-05-17T19:08:20+02:00
Add test for haskell/haddock#205

- - - - -
cb409b19 by Simon Peyton Jones at 2012-05-25T08:30:11+01:00
Follow changes in LHsTyVarBndrs

- - - - -
2d5f4179 by Simon Hengel at 2012-05-26T19:21:29+02:00
Add Applicative instance for (GenRnM a)

- - - - -
e4373060 by Simon Hengel at 2012-05-26T19:21:33+02:00
Use a map for warnings, as suggested by @waern

- - - - -
597a68c7 by Simon Hengel at 2012-05-27T08:48:24+02:00
Add an optional label to URLs

- - - - -
ef1ac7fe by Simon Hengel at 2012-05-27T08:48:24+02:00
Add support for hyperlink labels to parser

- - - - -
41f2adce by Simon Hengel at 2012-05-27T08:48:24+02:00
Add golden test for hyperlinks

- - - - -
83d5e764 by Simon Hengel at 2012-05-27T08:50:02+02:00
Use LANGUAGE pragmas instead of default-extensions in cabal file

- - - - -
ddb755e5 by Simon Hengel at 2012-05-27T08:50:02+02:00
Fix typo in comment

- - - - -
110676b4 by Simon Hengel at 2012-05-27T08:50:02+02:00
Add a type signature for a where-binding

- - - - -
7d9ba2a0 by Ian Lynagh at 2012-06-12T14:38:01+01:00
Follow changes in GHC

- - - - -
47c704f2 by Ian Lynagh at 2012-06-12T18:52:16+01:00
Follow changes in GHC

- - - - -
e1efe1ab by Simon Peyton Jones at 2012-06-13T17:25:29+01:00
Follow changes for the implementation of implicit parameters

- - - - -
69abc81c by Ian Lynagh at 2012-06-19T22:52:58+01:00
Follow changes in base

- - - - -
9d074a21 by Paolo Capriotti at 2012-06-22T18:26:47+01:00
Use right docMap to get decl documentation.

- - - - -
e3292ef6 by Ian Lynagh at 2012-07-15T01:31:19+01:00
Follow changes in GHC

- - - - -
ceae56b0 by Ian Lynagh at 2012-07-16T21:22:48+01:00
Fix haddock following some GHC changes

Passing _|_ as the Settings for defaultDynFlags no longer works well
enough

- - - - -
9df72735 by Paolo Capriotti at 2012-07-19T16:49:32+01:00
Forward port changes from stable.

- - - - -
572f5fcf by Ian Lynagh at 2012-07-19T20:38:26+01:00
Merge branch 'master' of darcs.haskell.org:/srv/darcs//haddock

- - - - -
9195aca4 by Paolo Capriotti at 2012-07-20T10:27:28+01:00
Update dependencies.

- - - - -
33db3923 by Ian Lynagh at 2012-07-20T17:54:43+01:00
Build with GHC 7.7

- - - - -
925a2cea by David Waern at 2012-07-23T16:50:40+02:00
Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6

Conflicts:
	src/Haddock/InterfaceFile.hs

- - - - -
d710ef97 by David Waern at 2012-07-23T16:52:07+02:00
Bump version number.

- - - - -
eb0c2f83 by David Waern at 2012-07-23T16:57:58+02:00
Update CHANGES.

- - - - -
b3f56943 by Roman Cheplyaka at 2012-07-27T13:00:13+03:00
Hide "internal" instances

This fixes haskell/haddock#37 (http://trac.haskell.org/haddock/ticket/37)

Precisely, we show an instance iff its class and all the types are exported by
non-hidden modules.

- - - - -
a70aa412 by Roman Cheplyaka at 2012-07-27T13:00:13+03:00
Tests for hiding instances (#37)

- - - - -
c0f4aa58 by Simon Hengel at 2012-07-27T13:00:13+03:00
Add an other test for hiding instances (#37)

- - - - -
a7ed6268 by Ian Lynagh at 2012-08-07T14:48:13+01:00
Follow changes in GHC

- - - - -
0ab30d38 by Ian Lynagh at 2012-08-13T22:12:27+01:00
Improve haddock memory usage

- - - - -
0eaa4e30 by Ian Lynagh at 2012-08-13T23:58:46+01:00
Improve haddock memory usage

- - - - -
659d26cf by Ian Lynagh at 2012-08-14T13:16:48+01:00
Remove some temporary pragmas I accidentally recorded

- - - - -
d97fceb6 by Simon Hengel at 2012-08-25T13:19:34+02:00
Add missing dependency to library

- - - - -
4c910697 by Simon Hengel at 2012-08-28T07:39:14+02:00
Move .ghci to project root

- - - - -
fc3c601a by Simon Hengel at 2012-08-28T07:39:14+02:00
accept.hs: Ignore some files

- - - - -
1af9b984 by Simon Hengel at 2012-08-28T07:40:04+02:00
Update reference renderings (bump version)

- - - - -
980dc253 by Simon Hengel at 2012-08-28T07:40:32+02:00
Update reference renderings (remove links for ())

- - - - -
33651dbf by Simon Hengel at 2012-08-28T07:41:50+02:00
Update documentation of `runInteractiveProcess` in reference rendering

- - - - -
7ab25078 by David Waern at 2012-09-07T10:38:50+02:00
Merge branch 'hiddenInstances2' of http://github.com/feuerbach/haddock into ghc-7.6

- - - - -
c3de3a4b by David Waern at 2012-09-07T14:29:27+02:00
Follow changes in GHC.

- - - - -
298c43ac by David Waern at 2012-09-07T14:59:24+02:00
Update CHANGES.

- - - - -
e797993a by David Waern at 2012-09-07T15:21:30+02:00
Update ANNOUNCE.

- - - - -
d0b44790 by David Waern at 2012-09-07T15:22:43+02:00
Merge branch 'hidden-instances' into ghc-7.6

- - - - -
41a4adc8 by Simon Hengel at 2012-09-08T12:08:37+02:00
Update doc/README

- - - - -
71ad1040 by Simon Hengel at 2012-09-08T12:17:17+02:00
Add documentation for URL labels

- - - - -
9bb41afd by Simon Peyton Jones at 2012-09-20T18:14:26+01:00
Follow data type changes in the tc-untouchables branch

Relating entirely to SynTyConRhs

- - - - -
b8139bfa by Simon Hengel at 2012-09-21T14:24:16+02:00
Disable Unicode test for now

- - - - -
a5fafdd7 by Simon Hengel at 2012-09-21T14:35:45+02:00
Update TypeOperators test for GHC 7.6.1

Type operators can't be used as type variables anymore!

- - - - -
6ccf0025 by Simon Hengel at 2012-09-21T16:02:24+02:00
Remove (Monad (Either e)) instance from ref. rendering of CrossPackageDocs

I do not really understand why the behavior changed, so I'll open a
ticket, so that we can further investigate.

- - - - -
b5c6c138 by Ian Lynagh at 2012-09-27T02:00:57+01:00
Follow changes in GHC build system

- - - - -
b98eded0 by David Waern at 2012-09-27T15:37:02+02:00
Merge branch 'ghc-7.6' of http://darcs.haskell.org/haddock into ghc-7.6

- - - - -
76cc2051 by David Waern at 2012-09-27T15:48:19+02:00
Update hidden instances tests.

- - - - -
aeaa1c59 by David Waern at 2012-09-28T10:21:32+02:00
Make API buildable with GHC 7.6.

- - - - -
d76be1b0 by Simon Peyton Jones at 2012-09-28T15:57:05+01:00
Merge remote-tracking branch 'origin/master' into tc-untouchables

- - - - -
a1922af8 by David Waern at 2012-09-28T19:50:20+02:00
Fix spurious superclass constraints bug.

- - - - -
bc41bdbb by Simon Hengel at 2012-10-01T11:30:51+02:00
Remove old examples

- - - - -
bed7d3dd by Simon Hengel at 2012-10-01T11:30:51+02:00
Adapt parsetests for GHC 7.6.1

- - - - -
dcdb22bb by Simon Hengel at 2012-10-01T11:30:51+02:00
Add test-suite section for parsetests to cabal file

+ get rid of HUnit dependency

- - - - -
1e5263c9 by Simon Hengel at 2012-10-01T11:30:51+02:00
Remove test flag from cabal file

This was not really used.

- - - - -
4beee98b by David Waern at 2012-09-28T23:42:28+02:00
Merge branch 'ghc-7.6' of http://darcs.haskell.org/haddock into ghc-7.6

- - - - -
11dd2256 by Ian Lynagh at 2012-10-03T16:17:35+01:00
Follow change in GHC build system

- - - - -
fbd77962 by Simon Hengel at 2012-10-03T18:49:40+02:00
Remove redundant dependency from cabal file

- - - - -
09218989 by Simon Hengel at 2012-10-04T16:03:05+02:00
Fix typo

- - - - -
93a2d5f9 by Simon Hengel at 2012-10-04T16:11:41+02:00
Remove trailing whitespace from cabal file

- - - - -
c8b46cd3 by Simon Hengel at 2012-10-04T16:12:17+02:00
Export Haddock's main entry point from library

- - - - -
b411e77b by Simon Hengel at 2012-10-04T16:29:46+02:00
Depend on library for executable

The main motivation for this is to increase build speed.  In GHC's
source tree the library is not build, but all modules are now required
for the executable, so that GHC's validate will now detect build
failures for the library.

- - - - -
f8f0979f by Simon Hengel at 2012-10-05T00:32:57+02:00
Set executable flag for Setup.lhs

- - - - -
dd045998 by Simon Hengel at 2012-10-07T16:44:06+02:00
Extend rather than set environment when running HTML tests

On some platforms (e.g. ppc64) GHC requires gcc in the path.

- - - - -
7b39c3ae by Simon Hengel at 2012-10-07T17:05:45+02:00
cross-package test: re-export IsString instead of Monad

There is a monad instance for Q, which is not available on platforms
that do not have GHCi support.  This caused CrossPackageDocs to fail on
those platforms.  Re-exporting IsString should test the same thing, but
it works on all platforms.

- - - - -
0700c605 by Simon Hengel at 2012-10-07T19:06:34+02:00
runtests.hs: Fix some warnings

- - - - -
f78eca79 by Simon Hengel at 2012-10-07T19:06:34+02:00
runtests.hs: Make -Wall proof

- - - - -
6beec041 by Simon Hengel at 2012-10-07T19:06:34+02:00
runtests.hs: Use listToMaybe/fromMaybe instead of safeHead/maybe

- - - - -
44b8ce86 by Ian Lynagh at 2012-10-08T21:59:46+01:00
Follow changes in GHC

- - - - -
6da5f702 by Simon Hengel at 2012-10-09T11:16:19+02:00
Update .ghci

- - - - -
9ac1a1b9 by Kazu Yamamoto at 2012-10-09T12:45:31+02:00
Add markup support for properties

- - - - -
1944cb42 by Simon Hengel at 2012-10-09T12:45:31+02:00
Simplify lexing/parsing of properties

In contrast to what we do for examples, we do not really need to capture
the "prompt" here.

- - - - -
bffd8e62 by Simon Hengel at 2012-10-09T13:40:14+02:00
Add HTML test for properties

- - - - -
2fe9c5cb by Simon Hengel at 2012-10-09T13:40:21+02:00
Add unit tests for properties

- - - - -
874e361b by Simon Hengel at 2012-10-09T13:40:33+02:00
Bump interface version

- - - - -
2506cc37 by Simon Hengel at 2012-10-09T15:15:04+02:00
Fix parser bug

- - - - -
743d2b7d by Simon Hengel at 2012-10-09T15:31:06+02:00
Allow to load interface files with compatible versions

- - - - -
981a1660 by Simon Hengel at 2012-10-10T10:32:05+02:00
Export more types from Documentation.Haddock (fixes haskell/haddock#216)

- - - - -
dff7dc76 by Simon Hengel at 2012-10-10T11:15:19+02:00
Update ANNOUNCE and CHANGES

- - - - -
edd2bb01 by Simon Hengel at 2012-10-10T11:22:50+02:00
Bump version

- - - - -
5039163b by Simon Hengel at 2012-10-10T13:56:04+02:00
Fix typo in documentation

- - - - -
e4ce34da by Simon Hengel at 2012-10-10T14:28:35+02:00
Add documentation for properties

- - - - -
9555ebca by Simon Hengel at 2012-10-11T10:49:04+02:00
Remove redundant if-defs, more source documentation

- - - - -
87aa67e1 by Simon Hengel at 2012-10-11T12:32:51+02:00
Adapt cabal file

- - - - -
c44c1dee by Simon Hengel at 2012-10-11T12:41:58+02:00
Require ghc 7.6

- - - - -
8383bc34 by Simon Hengel at 2012-10-11T12:50:24+02:00
Bump version

- - - - -
1030eb38 by Simon Hengel at 2012-10-11T12:55:44+02:00
Update ANNOUNCE and CHANGES

- - - - -
74955088 by Simon Hengel at 2012-10-12T09:49:31+02:00
Improve note about `binaryInterfaceVersion` (thanks David)

- - - - -
ee30f6b7 by Simon Hengel at 2012-10-13T13:40:59+02:00
Update version in html tests, rpm spec file, and user manual

- - - - -
f2861f18 by Simon Hengel at 2012-10-13T14:40:33+02:00
Remove unused MonadFix constraint

- - - - -
dfdf1a74 by Simon Hengel at 2012-10-13T15:15:38+02:00
Minor code simplification

- - - - -
4ecd1e70 by Simon Hengel at 2012-10-13T15:33:43+02:00
Increase code locality

- - - - -
f7df5cc9 by Simon Hengel at 2012-10-13T16:03:12+02:00
Minor code simplification

- - - - -
e737eb6e by Simon Hengel at 2012-10-13T19:03:04+02:00
Handle HsExplicitListTy in renameer (fixes haskell/haddock#213)

- - - - -
c2dc8f17 by Simon Hengel at 2012-10-13T20:46:31+02:00
Better error messages

- - - - -
14d48b4c by Simon Hengel at 2012-10-14T00:21:07+02:00
Simplify RnM type

- - - - -
6c2cc547 by Simon Hengel at 2012-10-14T00:23:35+02:00
Simplify lookupRn

- - - - -
bc77ce85 by Simon Hengel at 2012-10-14T01:51:32+02:00
Organize unite tests hierarchically

- - - - -
2306d117 by Simon Hengel at 2012-10-14T10:34:58+02:00
Handle more cases in renameType

- - - - -
8a864203 by Simon Hengel at 2012-10-14T11:47:59+02:00
Add mini_HiddenInstances.html.ref and mini_HiddenInstancesB.html.ref

- - - - -
3a978eca by Simon Hengel at 2012-10-14T11:49:28+02:00
Add /tests/html-tests/output/ to .gitignore

- - - - -
db18888a by Simon Hengel at 2012-10-14T13:38:21+02:00
Allow haddock markup in deprecation messages

- - - - -
e7cfee9f by Simon Hengel at 2012-10-14T14:00:23+02:00
If parsing of deprecation message fails, include it verbatim

- - - - -
242a85be by Simon Hengel at 2012-10-14T14:13:24+02:00
Add description for PruneWithWarning test

- - - - -
43d33df1 by Simon Hengel at 2012-10-14T15:40:53+02:00
Minor formatting change

- - - - -
22768c44 by Simon Hengel at 2012-10-14T16:03:43+02:00
Properly handle deprecation messages for re-exported things (fixes haskell/haddock#220)

- - - - -
cb4b9111 by Simon Hengel at 2012-10-14T17:30:28+02:00
Add build artifacts for documentation to .gitignore

- - - - -
854cd8de by Simon Hengel at 2012-10-14T23:34:51+02:00
unit-tests: Improve readability

Add IsString instance for (Doc RdrName) + use <> instead of DocAppend.

- - - - -
c4446d54 by Simon Hengel at 2012-10-14T23:37:21+02:00
unit-tests: Minor refactoring

Rename parse to parseParas.

- - - - -
04f2703c by Simon Hengel at 2012-10-15T00:36:42+02:00
Fix typo

- - - - -
3d109e44 by Simon Hengel at 2012-10-15T10:30:07+02:00
Add description for DeprecatedReExport test

- - - - -
84f0985c by Simon Hengel at 2012-10-15T14:54:19+02:00
Move resources to /resources directory

- - - - -
a5de7ca6 by Simon Hengel at 2012-10-15T15:46:18+02:00
Move HTML tests to directory /html-test/

- - - - -
e21f727d by Simon Hengel at 2012-10-15T19:32:42+02:00
Move HTML reference renderings to /html-test/ref/

- - - - -
3a3c6c75 by Simon Hengel at 2012-10-15T19:32:42+02:00
Copy css, images, etc. on accept

- - - - -
40ead6dc by Simon Hengel at 2012-10-15T19:32:42+02:00
Move unit tests to /test directory

- - - - -
99a28231 by Simon Hengel at 2012-10-15T19:32:42+02:00
Fix Setup.lhs

/usr/bin/runhaskell is not installed on all systems.

- - - - -
95faf45e by Simon Hengel at 2012-10-15T19:32:42+02:00
Make test management scripts more robust

 * They are now independent from the current directory, and hence can be
   called from everywhere

 * On UNIX/Linux they can now be run as scripts

- - - - -
027aaa2d by Simon Hengel at 2012-10-15T19:53:40+02:00
Add 'dev' flag to cabal file, that builds without -O2

That way --disable-optimization can be used, which decreases build time
considerably.

- - - - -
e0266ede by Simon Hengel at 2012-10-15T20:03:43+02:00
Add test case for "spurious superclass constraints bug"

- - - - -
52a2aa92 by Simon Hengel at 2012-10-15T20:28:55+02:00
Adapt accept.lhs, so that it ignores more index files

- - - - -
53530781 by Simon Hengel at 2012-10-15T20:49:39+02:00
Rename html-test/runtests.lhs to html-test/run.lhs

- - - - -
84518797 by Simon Hengel at 2012-10-15T20:49:39+02:00
Move source files for HTML tests to html-test/src

- - - - -
a911dc6c by Simon Hengel at 2012-10-15T20:49:39+02:00
Adapt output directory for HTML tests

- - - - -
d3c15857 by Ian Lynagh at 2012-10-16T16:54:43+01:00
Follow dopt->gopt rename

- - - - -
956665a5 by Simon Hengel at 2012-10-18T08:42:48+02:00
Update html-test/README

- - - - -
903b1029 by Simon Hengel at 2012-10-18T08:50:26+02:00
Use markdown for html-test/README

- - - - -
150b4d63 by Ian Lynagh at 2012-10-18T16:36:00+01:00
Follow changes in GHC: 'flags' has been renamed 'generalFlags'

- - - - -
41e04ff9 by Simon Hengel at 2012-11-28T09:54:35+01:00
Export missing types from Documentation.Haddock

- - - - -
9be59237 by Ian Lynagh at 2012-11-30T23:20:47+00:00
Update dependencies

- - - - -
e06842f5 by Simon Hengel at 2012-12-07T20:58:05+01:00
Bump version

- - - - -
e3dbede0 by Simon Hengel at 2012-12-07T20:58:05+01:00
Add missing test files to cabal file (fixes haskell/haddock#230)

- - - - -
ee0dcca7 by Simon Hengel at 2012-12-07T20:58:05+01:00
Update CHANGES

- - - - -
51601bdb by Simon Peyton Jones at 2012-12-19T17:28:35+00:00
Track changes in UNPACK pragma stuff

- - - - -
f2573bc1 by Richard Eisenberg at 2012-12-21T20:56:25-05:00
Implement overlapping type family instances.

An ordered, overlapping type family instance is introduced by 'type
instance
where', followed by equations. See the new section in the user manual
(7.7.2.2) for details. The canonical example is Boolean equality at the
type
level:

type family Equals (a :: k) (b :: k) :: Bool
type instance where
  Equals a a = True
  Equals a b = False

A branched family instance, such as this one, checks its equations in
order
and applies only the first the matches. As explained in the note
[Instance
checking within groups] in FamInstEnv.lhs, we must be careful not to
simplify,
say, (Equals Int b) to False, because b might later unify with Int.

This commit includes all of the commits on the overlapping-tyfams
branch. SPJ
requested that I combine all my commits over the past several months
into one
monolithic commit. The following GHC repos are affected: ghc, testsuite,
utils/haddock, libraries/template-haskell, and libraries/dph.

Here are some details for the interested:

- The definition of CoAxiom has been moved from TyCon.lhs to a
  new file CoAxiom.lhs. I made this decision because of the
  number of definitions necessary to support BranchList.

- BranchList is a GADT whose type tracks whether it is a
  singleton list or not-necessarily-a-singleton-list. The reason
  I introduced this type is to increase static checking of places
  where GHC code assumes that a FamInst or CoAxiom is indeed a
  singleton. This assumption takes place roughly 10 times
  throughout the code. I was worried that a future change to GHC
  would invalidate the assumption, and GHC might subtly fail to
  do the right thing. By explicitly labeling CoAxioms and
  FamInsts as being Unbranched (singleton) or
  Branched (not-necessarily-singleton), we make this assumption
  explicit and checkable. Furthermore, to enforce the accuracy of
  this label, the list of branches of a CoAxiom or FamInst is
  stored using a BranchList, whose constructors constrain its
  type index appropriately.

I think that the decision to use BranchList is probably the most
controversial decision I made from a code design point of view.
Although I provide conversions to/from ordinary lists, it is more
efficient to use the brList... functions provided in CoAxiom than
always to convert. The use of these functions does not wander far
from the core CoAxiom/FamInst logic.

BranchLists are motivated and explained in the note [Branched axioms] in
CoAxiom.lhs.

- The CoAxiom type has changed significantly. You can see the new
  type in CoAxiom.lhs. It uses a CoAxBranch type to track
  branches of the CoAxiom. Correspondingly various functions
  producing and consuming CoAxioms had to change, including the
  binary layout of interface files.

- To get branched axioms to work correctly, it is important to have a
  notion
  of type "apartness": two types are apart if they cannot unify, and no
  substitution of variables can ever get them to unify, even after type
family
  simplification. (This is different than the normal failure to unify
because
  of the type family bit.) This notion in encoded in tcApartTys, in
Unify.lhs.
  Because apartness is finer-grained than unification, the tcUnifyTys
now
  calls tcApartTys.

- CoreLinting axioms has been updated, both to reflect the new
  form of CoAxiom and to enforce the apartness rules of branch
  application. The formalization of the new rules is in
  docs/core-spec/core-spec.pdf.

- The FamInst type (in types/FamInstEnv.lhs) has changed
  significantly, paralleling the changes to CoAxiom. Of course,
  this forced minor changes in many files.

- There are several new Notes in FamInstEnv.lhs, including one
  discussing confluent overlap and why we're not doing it.

- lookupFamInstEnv, lookupFamInstEnvConflicts, and
  lookup_fam_inst_env' (the function that actually does the work)
  have all been more-or-less completely rewritten. There is a
  Note [lookup_fam_inst_env' implementation] describing the
  implementation. One of the changes that affects other files is
  to change the type of matches from a pair of (FamInst, [Type])
  to a new datatype (which now includes the index of the matching
  branch). This seemed a better design.

- The TySynInstD constructor in Template Haskell was updated to
  use the new datatype TySynEqn. I also bumped the TH version
  number, requiring changes to DPH cabal files. (That's why the
  DPH repo has an overlapping-tyfams branch.)

- As SPJ requested, I refactored some of the code in HsDecls:

 * splitting up TyDecl into SynDecl and DataDecl, correspondingly
   changing HsTyDefn to HsDataDefn (with only one constructor)

 * splitting FamInstD into TyFamInstD and DataFamInstD and
   splitting FamInstDecl into DataFamInstDecl and TyFamInstDecl

 * making the ClsInstD take a ClsInstDecl, for parallelism with
   InstDecl's other constructors

 * changing constructor TyFamily into FamDecl

 * creating a FamilyDecl type that stores the details for a family
   declaration; this is useful because FamilyDecls can appear in classes
but
   other decls cannot

 * restricting the associated types and associated type defaults for a
 * class
   to be the new, more restrictive types

 * splitting cid_fam_insts into cid_tyfam_insts and cid_datafam_insts,
   according to the new types

 * perhaps one or two more that I'm overlooking

None of these changes has far-reaching implications.

- The user manual, section 7.7.2.2, is updated to describe the new type
  family
  instances.

- - - - -
f788d0fb by Simon Peyton Jones at 2012-12-23T15:49:58+00:00
Track changes in HsBang

- - - - -
ca460a0c by Simon Peyton Jones at 2012-12-23T15:50:28+00:00
Merge branch 'master' of http://darcs.haskell.org//haddock

- - - - -
f078fea6 by Simon Peyton Jones at 2013-01-02T08:33:13+00:00
Use InstEnv.instanceSig rather than instanceHead (name change)

- - - - -
88e41305 by Simon Peyton Jones at 2013-01-14T17:10:27+00:00
Track change to HsBang type

- - - - -
e1ad4e19 by Kazu Yamamoto at 2013-02-01T11:59:24+09:00
Merge branch 'ghc-7.6' into ghc-7.6-merge-2

Conflicts:
	haddock.cabal
	src/Haddock/Interface/AttachInstances.hs
	src/Haddock/Interface/Create.hs
	src/Haddock/Interface/LexParseRn.hs
	src/Haddock/InterfaceFile.hs
	src/Haddock/Types.hs

Only GHC HEAD can compile this. GHC 7.6.x cannot compile this.

Some test fail.

- - - - -
62bec012 by Kazu Yamamoto at 2013-02-06T11:12:28+09:00
Using tcSplitSigmaTy in instanceHead' (FIXME is resolved.)

- - - - -
013fd2e4 by Kazu Yamamoto at 2013-02-06T17:56:21+09:00
Refactoring instanceHead'.

- - - - -
3148ce0e by Kazu Yamamoto at 2013-02-07T17:45:10+09:00
Using new syntax in html-test/src/GADTRecords.hs.

- - - - -
626dabe7 by Gabor Greif at 2013-02-15T22:42:01+01:00
Typo

- - - - -
1eb667ae by Ian Lynagh at 2013-02-16T17:02:07+00:00
Follow changes in base

- - - - -
3ef8253a by Ian Lynagh at 2013-03-01T23:23:57+00:00
Follow changes in GHC's build system

- - - - -
1a265a3c by Ian Lynagh at 2013-03-03T23:12:07+00:00
Follow changes in GHC build system

- - - - -
69941c79 by Max Bolingbroke at 2013-03-10T09:38:28-07:00
Use Alex 3's Unicode support to properly lex source files as UTF-8

Signed-off-by: David Waern <david.waern at gmail.com>

- - - - -
ea687dad by Simon Peyton Jones at 2013-03-15T14:16:10+00:00
Adapt to tcRnGetInfo returning family instances too

This API change was part of the fix to Trac haskell/haddock#4175.  But it offers new
information to Haddock: the type-family instances, as well as the
class instances, of this type.

This patch just drops the new information on the floor, but there's an
open opportunity to use it in the information that Haddock displays.

- - - - -
971a30b0 by Andreas Voellmy at 2013-05-19T20:47:39+01:00
Fix for haskell/haddock#7879.

Changed copy of utils/haddock/html/resources/html to use "cp -RL" rather than "cp -R". This allows users to run validate in a build tree, where the build tree was setup using lndir with a relative path to the source directory.

- - - - -
31fb7694 by Ian Lynagh at 2013-05-19T20:47:49+01:00
Use "cp -L" when making $(INPLACE_LIB)/latex too

- - - - -
e9952233 by Simon Hengel at 2013-06-01T18:06:50+02:00
Add -itest to .ghci

- - - - -
b06873b3 by Mateusz Kowalczyk at 2013-06-01T18:06:50+02:00
Workaround for a failing build with --enable-tests.

- - - - -
e7858d16 by Simon Hengel at 2013-06-01T19:29:28+02:00
Fix broken test

- - - - -
0690acb1 by Richard Eisenberg at 2013-06-21T14:08:25+01:00
Updates to reflect changes in HsDecls to support closed type families.

- - - - -
7fd347ec by Simon Hengel at 2013-07-08T10:28:48+02:00
Fix failing test

- - - - -
53ed81b6 by Simon Hengel at 2013-07-08T10:28:48+02:00
Fix failing test

- - - - -
931c4f4f by Richard Eisenberg at 2013-07-24T13:15:59+01:00
Remove (error "synifyKind") to use WithinType, to allow haddock to process base.

- - - - -
55a9c804 by Richard Eisenberg at 2013-08-02T15:54:55+01:00
Changes to reflect changes in GHC's type HsTyVarBndr

- - - - -
b6e9226c by Mathieu Boespflug at 2013-08-04T10:39:43-07:00
Output Copright and License keys in Xhtml backend.

This information is as relevant in the documentation as it is in the
source files themselves.

Signed-off-by: David Waern <david.waern at gmail.com>

- - - - -
4c66028a by David Waern at 2013-08-04T15:27:36-07:00
Bump interface file version.

- - - - -
67340163 by David Waern at 2013-08-09T16:12:51-07:00
Update tests.

- - - - -
2087569b by Mateusz Kowalczyk at 2013-08-25T09:24:13+02:00
Add spec tests.

This adds tests for all elements we can create during regular
parsing. This also adds tests for text with unicode in it.

- - - - -
97f36a11 by Mateusz Kowalczyk at 2013-08-27T06:59:12+01:00
Fix ticket haskell/haddock#247.

I do the same thing that the XHTML backend does: give these no special
treatment and just act as if they are regular functions.

- - - - -
60681b4f by Mateusz Kowalczyk at 2013-08-27T21:22:48+02:00
LaTeX tests setup

- - - - -
fa4c27b2 by Mateusz Kowalczyk at 2013-09-02T23:21:43+01:00
Fixes haskell/haddock#253

- - - - -
1a202490 by Mateusz Kowalczyk at 2013-09-03T01:12:50+01:00
Use Hspec instead of nanospec

This is motivated by the fact that Haddock tests are not ran by the
GHC's ‘validate’ script so we're pretty liberal on dependencies in that
area. Full Hspec gives us some nice features such as Quickcheck integration.

- - - - -
8cde3b20 by David Luposchainsky at 2013-09-08T07:27:28-05:00
Fix AMP warnings

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
d10661f2 by Herbert Valerio Riedel at 2013-09-11T15:15:01+02:00
Update Git repo URL in `.cabal` file

- - - - -
16a44eb5 by Richard Eisenberg at 2013-09-17T09:34:26-04:00
Revision to reflect new role annotation syntax in GHC.

- - - - -
4b9833b9 by Herbert Valerio Riedel at 2013-09-18T10:15:28+02:00
Add missing `traverse` method for `GenLocated`

As `Traversable` needs at least one of `traverse` or `sequenceA` to be
overridden.

Signed-off-by: Herbert Valerio Riedel <hvr at gnu.org>

- - - - -
b71fed5d by Simon Hengel at 2013-09-18T22:43:34+02:00
Add test helper

- - - - -
4fc1ea86 by Mateusz Kowalczyk at 2013-09-18T22:43:34+02:00
Fixes haskell/haddock#231

- - - - -
435872f6 by Mateusz Kowalczyk at 2013-09-18T22:43:34+02:00
Fixes haskell/haddock#256

We inject -dynamic-too into flags before we run all our actions in the
GHC monad.

- - - - -
b8b24abb by Mateusz Kowalczyk at 2013-09-18T22:43:35+02:00
Add new field to DynFlags

- - - - -
49558795 by Simon Hengel at 2013-09-18T22:43:35+02:00
Fallback to ./resources when Cabal data is not found

(so that themes are found during development)

- - - - -
bf79d05c by Mateusz Kowalczyk at 2013-09-18T22:43:35+02:00
Fixes haskell/haddock#5

- - - - -
e1baebc2 by Mateusz Kowalczyk at 2013-09-18T22:43:35+02:00
Print missing documentation. Fixes haskell/haddock#258.

- - - - -
02ea74de by Austin Seipp at 2013-10-09T10:52:22-05:00
Don't consider StaticFlags when parsing arguments.

Instead, discard any static flags before parsing the command line using
GHC's DynFlags parser.

See http://ghc.haskell.org/trac/ghc/ticket/8276

Based off a patch from Simon Hengel.

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
704fd5bb by Simon Hengel at 2013-11-09T00:15:13+01:00
Update HTML tests

- - - - -
f9fed49e by Simon Hengel at 2013-11-10T18:43:58+01:00
Bump version

- - - - -
97ae1999 by Simon Peyton Jones at 2013-11-25T17:25:14+00:00
Track changes in HsSpliceTy data constructor

- - - - -
59ad8268 by Simon Peyton Jones at 2014-01-10T18:17:43+00:00
Adapt to small change in Pretty's exports

- - - - -
8b12e6aa by Simon Hengel at 2014-01-12T14:48:35-06:00
Some code simplification by using traverse

- - - - -
fc5ea9a2 by Simon Hengel at 2014-01-12T14:48:35-06:00
Fix warnings in test helper

- - - - -
6dbb3ba5 by Mateusz Kowalczyk at 2014-01-12T14:48:35-06:00
Add ByteString version of Attoparsec

- - - - -
968d7774 by Mateusz Kowalczyk at 2014-01-12T14:48:35-06:00
One pass parser and tests.

We remove the HTML test as it is no longer necessary. We cover the
test case in spec tests and other HTML tests but keeping this around
fails: this is because the new parser has different semantics there.
In fact, I suspect the original behaviour was a bug that wasn't
caught/fixed but simply included as-is during the testing.

- - - - -
37a07c9c by Simon Hengel at 2014-01-12T14:48:35-06:00
Rename Haddock.ParseSpec to Haddock.ParserSpec

- - - - -
f0f68fe9 by Simon Hengel at 2014-01-12T14:48:35-06:00
Don't append newline to parseString input

We also check that we have parsed everything with endOfInput.

- - - - -
95d60093 by Simon Hengel at 2014-01-12T14:48:35-06:00
Fix totality, unicode, examples, paragraph parsing

Also simplify specs and parsers while we're at it. Some parsers were
made more generic.

This commit is a part of GHC pre-merge squash, email
fuuzetsu at fuuzetsu.co.uk if you need the full commit history.

- - - - -
7d99108c by Simon Hengel at 2014-01-12T14:48:35-06:00
Update acceptance tests

- - - - -
d1b59640 by Mateusz Kowalczyk at 2014-01-12T14:48:35-06:00
Support for bold.

Conflicts:
	src/Haddock/Backends/Hoogle.hs
	src/Haddock/Interface/Rename.hs
	src/Haddock/Parser.hs

- - - - -
4b412b39 by Mateusz Kowalczyk at 2014-01-12T14:48:35-06:00
Allow for headings inside function documentation.

LaTeX will treat the h3-h6 headings the same as we'd have to hack the
style file heavily otherwise and it would make the headings tiny
anyway.

Hoogle upstream said they will put in the functionality on their end.

Conflicts:
	src/Haddock/Interface/Rename.hs
	src/Haddock/Types.hs
	test/Haddock/ParserSpec.hs

- - - - -
fdcca428 by Mateusz Kowalczyk at 2014-01-12T14:48:35-06:00
Per-module extension flags and language listing.

Any extensions that are not enabled by a used language (Haskell2010
&c) will be shown. Furthermore, any implicitly enabled are also going
to be shown. While we could eliminate this either by using the GHC API
or a dirty hack, I opted not to: if a user doesn't want the implied
flags to show, they are recommended to use enable extensions more
carefully or individually. Perhaps this will encourage users to not
enable the most powerful flags needlessly. Enabled with show-extensions.

Conflicts:
	src/Haddock/InterfaceFile.hs

- - - - -
368942a2 by Mateusz Kowalczyk at 2014-01-12T14:48:36-06:00
Bump interface version

There were some breaking changes over the last few patches so we bump
the interface version. This causes a big problem with testing:

1. To generate cross package docs, we first need to generate docs for
the package used.
2. To generate package docs with new interface version, we need to use
Haddock which has the version bumped.
3. To get Haddock with the version bump, we first need to test cross
package docs
4. GOTO 1

So the problem is the chicken and the egg problem. It seems that the
only solution would be to generate some interface files on the fly but
it is non-trivial.

To run this test, you'll have to:

* build Haddock without the test (make sure everything else passes)
* rebuild the packages used in the test with your shiny new binary
  making sure they are visible to Haddock
* remove the ‘_hidden’ suffix and re-run the tests

Note: because the packages currently used for this test are those
provided by GHC, it's probably non-trivial to just re-build them.
Preferably something less tedious to rebuild should be used and
something that is not subject to change.

- - - - -
124ae7a9 by Mateusz Kowalczyk at 2014-01-12T14:48:36-06:00
Allow for nesting of paragraphs under lists.

The nesting rules are similar to Markdown's with the exception that we
can not simply indent the first line of a hard wrapped indented
paragraph and have it treated as if it was fully indented. The reason is
differences in markup as some of our constructs care about whitespace
while others just swallow everything up so it's just a lot easier to not
bother with it rather than making arbitrary rules.

Note that we now drop trailing for string entities inside of lists. They
weren't needed and it makes the output look uniform whether we use a
single or double newline between list elements.

Conflicts:
	src/Haddock/Parser.hs
	test/Haddock/ParserSpec.hs

- - - - -
c7913535 by Mateusz Kowalczyk at 2014-01-12T14:48:36-06:00
Allow escaping in URLs and pictures.

Some tests were moved under parseString as they weren't about paragraph
level markup.

Conflicts:
	src/Haddock/Parser.hs
	test/Haddock/ParserSpec.hs

- - - - -
32326680 by Mateusz Kowalczyk at 2014-01-12T14:48:36-06:00
Update documentation.

- - - - -
fbef6406 by Mateusz Kowalczyk at 2014-01-12T14:48:36-06:00
Update maintainer

- - - - -
b40e82f4 by Mateusz Kowalczyk at 2014-01-13T02:39:25-06:00
Fixes haskell/haddock#271

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
f4eafbf8 by Gergő Érdi at 2014-01-19T15:35:16-06:00
Support for -XPatternSynonyms

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
a8939591 by Austin Seipp at 2014-01-29T08:09:04-06:00
Update CPP check for __GLASGOW_HASKELL__

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
30d7e9d5 by Gergő Érdi at 2014-01-31T00:15:01+08:00
<+>: Don't insert a space when concatenating empty nodes

- - - - -
a25ccd4d by Mateusz Kowalczyk at 2014-01-30T17:22:34+01:00
Fix @ code blocks

In cases where we had some horizontal space before the closing ‘@’, the
parser would not accept the block as a code block and we'd get ugly
output.

- - - - -
0f67305a by Mateusz Kowalczyk at 2014-01-30T17:22:34+01:00
Update tests

This updates tests due to Haddock Trac haskell/haddock#271 fix and due to removal of
TypeHoles as an extension from GHC.

- - - - -
157322a7 by Gergő Érdi at 2014-01-31T01:03:17+08:00
Handle infix vs prefix names correctly everywhere, by explicitly specifying the context

The basic idea is that "a" and "+" are either pretty-printed as "a" and "(+)"  or "`a`" and "+"

- - - - -
aa6d9685 by Mateusz Kowalczyk at 2014-01-30T17:21:50+00:00
Correct whitespace in ‘hidden’ test for <+> change

- - - - -
121872f0 by Mateusz Kowalczyk at 2014-02-09T17:59:12+00:00
Document module header.

Fixes Haddock Trac haskell/haddock#270.

- - - - -
e3253746 by Mateusz Kowalczyk at 2014-02-10T21:37:48+00:00
Insert a space between module link and description

Fixes Haddock Trac haskell/haddock#277.

- - - - -
771d2384 by Mateusz Kowalczyk at 2014-02-10T23:27:21+00:00
Ensure a space between type signature and ‘Source’

This is briefly related to Haddock Trac haskell/haddock#249 and employs effectively the
suggested fix _but_ it doesn't actually fix the reported issue. This
commit simply makes copying the full line a bit less of a pain.

- - - - -
8cda9eff by nand at 2014-02-11T15:48:30+00:00
Add support for type/data families

This adds support for type/data families with their respective
instances, as well as closed type families and associated type/data
families.

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
3f22c510 by nand at 2014-02-11T15:53:50+00:00
Improve display of poly-kinded type operators

This now displays them as (==) k a b c ... to mirror GHC's behavior,
instead of the old (k == a) b c ... which was just wrong.

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
effb2d6b by nand at 2014-02-11T15:56:50+00:00
Add test case for PatternSynonyms

This just tests various stuff including poly-kinded patterns and
operator patterns to make sure the rendering isn't broken.

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
b38faf0d by Niklas Haas at 2014-02-13T21:53:32+00:00
Get rid of re-implementation of sortBy

I have no idea what this was doing lying around here, and due to the
usage of tuples it's actually slower, too.

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
ac1e0413 by Mateusz Kowalczyk at 2014-02-13T23:57:16+00:00
Only warn about missing docs when docs are missing

This fixes the ‘Missing documentation for…’ message for modules with
100% coverage.

- - - - -
cae2e36a by Niklas Haas at 2014-02-15T21:56:18+00:00
Add test case for inter-module type/data family instances

These should show up in every place where the class is visible, and
indeed they do right now.

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
8bea5c3a by Mateusz Kowalczyk at 2014-02-19T05:11:34+00:00
Use a bespoke data type to indicate fixity

This deals with what I imagine was an ancient TODO and makes it much
clearer what the argument actually does rather than having the user
chase down the comment.

- - - - -
5b52d57c by Niklas Haas at 2014-02-22T21:31:03+01:00
Strip a single leading space from bird tracks (#201)

This makes bird tracks in the form

> foo
> bar
> bat

parse as if they had been written as

>foo
>bar
>bat

ie. without the leading whitespace in front of every line.

Ideally we also want to look into how leading whitespace affects code
blocks written using the @ @ syntax, which are currently unaffected by
this patch.

- - - - -
5a1315a5 by Simon Hengel at 2014-02-22T21:55:35+01:00
Turn a source code comment into specs

- - - - -
784cfe58 by Mateusz Kowalczyk at 2014-02-23T05:02:22+00:00
Update test case for lifted GADT type rendering

The parsing of these seems to have been fixed by GHC folk and it now
renders differently. IMHO it now renders in a better way so I'm updating
the test to reflect this.

- - - - -
c3c88c2f by Mateusz Kowalczyk at 2014-02-23T06:37:14+00:00
Don't shadow ‘strip’.

-Wall complains

- - - - -
293031d8 by Niklas Haas at 2014-02-23T15:21:52+01:00
Make ImplicitParams render correctly (#260)

This introduces a new precedence level for single contexts (because
implicit param contexts always need parens around them, but other types
of contexts don't necessarily, even when alone)

- - - - -
4200842d by Niklas Haas at 2014-02-23T15:37:13+01:00
Lower precedence of equality constraints

This drops them to the new precedence pREC_CTX, which makes single
eqaulity constraints show up as (a ~ b) => ty, in line with GHC's
rendering. Additional tests added to make sure other type operators
render as intended. Current behavior matches GHC

- - - - -
b59e3227 by Niklas Haas at 2014-02-23T16:11:22+01:00
Add RankNTypes test case to ImplicitParams.hs

This test actually tests what haskell/haddock#260 originally reported - I omitted the
RankNTypes scenario from the original fix because I realized it's not
relevant to the underlying issue and indeed, this renders as intended
now. Still good to have more tests.

- - - - -
c373dbf7 by Mateusz Kowalczyk at 2014-02-24T06:09:54+00:00
Fix rendering of Contents when links are present

Fixes Haddock Trac haskell/haddock#267.

- - - - -
9ecb0e56 by Mateusz Kowalczyk at 2014-02-24T06:26:50+00:00
Fix wording in the docs

- - - - -
4f4dcd8e by Mateusz Kowalczyk at 2014-02-27T03:00:33+00:00
Change rendering of duplicate record field docs

See Haddock Trac haskell/haddock#195. We now change this behaviour to only rendering
the documentation attached to the first instance of a duplicate field.

Perhaps we could improve this by rendering the first instance that has
documentation attached to it but for now, we'll stick with this.

- - - - -
ad8aa609 by Niklas Haas at 2014-03-08T09:43:26+01:00
Render fixity information

Affects functions, type synonyms, type families, class names, data type
names, constructors, data families, associated TFs/DFs, type synonyms,
pattern synonyms and everything else I could think of.

- - - - -
6a39c917 by Niklas Haas at 2014-03-09T07:43:39+01:00
Reorder topDeclElem to move the source/wiki links to the top

They appear in the same position due to the float: right attribute but
now they're always at the top of the box instead of at the bottom.

- - - - -
2d34b3b4 by Niklas Haas at 2014-03-09T07:53:46+01:00
Use optLast instead of listToMaybe for sourceUrls/wikiUrls

This lets you override them using eg. cabal haddock --haddock-options,
which can come in handy if you want to use a different layout or URL for
your source code links than cabal-install generates.

- - - - -
0eff4624 by Niklas Haas at 2014-03-09T07:53:46+01:00
Differentiate between TH splices (line-links) and regular names

This adds a new type of source code link, to a specific line rather than
a specific declaration/name - this is used to link to the location of a
TH splice that defines a certain name.

Rather hefty changes throughout and still one unresolved issue (the line
URLs aren't parsed from the third form of --read-interface which means
they're currently restricted to same-interface links). Not sure if
this issue is really worth all the hassle, especially since we could
just use line links in general.

This commit also contains some cleanup/clarification of the types in
Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the
process. Notably, the Bool parameter was replaced by a Unicode type
synonym to help clarify its presence in type signatures.

- - - - -
66d6f77b by Niklas Haas at 2014-03-09T20:02:43+01:00
Group similar fixities together

Identical fixities declared for the same line should now render using
syntax like: infix 4 <, >=, >, <=

- - - - -
6587f9f5 by Mateusz Kowalczyk at 2014-03-10T04:24:18+00:00
Update changelog

- - - - -
7387ddad by Niklas Haas at 2014-03-11T10:26:04+01:00
Include fixity information in the Interface file

This resolves fixity information not appearing across package borders.

The binary file version has been increased accordingly.

- - - - -
ab46ef44 by Niklas Haas at 2014-03-11T10:26:04+01:00
Update changelog

- - - - -
565cab6f by Niklas Haas at 2014-03-11T10:26:04+01:00
Update appearance of fixity annotations

This moves them in-line with their corresponding lines, similar to a
presentation envision by @hvr and described in #ghc.

Redundant operator names are also omitted when no ambiguity is present.

- - - - -
5d7afd67 by Niklas Haas at 2014-03-11T10:26:05+01:00
Filter family instances of hidden types

Currently, this check does not extend to hidden right hand sides,
although it probably should hide them in that case.

- - - - -
ec291b0c by Niklas Haas at 2014-03-11T10:26:05+01:00
Add documentation for --source-entity-line

- - - - -
0922e581 by Niklas Haas at 2014-03-11T10:37:32+01:00
Revert "Reorder topDeclElem to move the source/wiki links to the top"

This reverts commit 843c42c4179526a2ad3526e4c7d38cbf4d50001d.

This change is no longer needed with the new rendering style, and it
messes with copy/pasting lines.

- - - - -
30618e8b by Mateusz Kowalczyk at 2014-03-11T09:41:07+00:00
Bump version to 2.15.0

- - - - -
adf3f1bb by Mateusz Kowalczyk at 2014-03-11T09:41:09+00:00
Fix up some whitespace

- - - - -
8905f57d by Niklas Haas at 2014-03-13T19:18:06+00:00
Hide RHS of TFs with non-exported right hand sides

Not sure what to do about data families yet, since technically it would
not make a lot of sense to display constructors that cannot be used by
the user.

- - - - -
5c44d5c2 by Niklas Haas at 2014-03-13T19:18:08+00:00
Add UnicodeSyntax alternatives for * and ->

I could not find a cleaner way to do this other than checking for
string equality with the given built-in types. But seeing as it's
actually equivalent to string rewriting in GHC's implementation of
UnicodeSyntax, it's probably fitting.

- - - - -
b04a63e6 by Niklas Haas at 2014-03-13T19:18:10+00:00
Display minimal complete definitions for type classes

This corresponds to the new {-# MINIMAL #-} pragma present in GHC 7.8+.
I also cleaned up some of the places in which ExportDecl is used to make
adding fields easier in the future.

Lots of test cases have been updated since they now render with
minimality information.

- - - - -
a4a20b16 by Niklas Haas at 2014-03-13T19:18:12+00:00
Strip links from recently added html tests

These were accidentally left there when the tests were originally added

- - - - -
d624f315 by Mateusz Kowalczyk at 2014-03-13T19:19:31+00:00
Update changelog

- - - - -
d27a21ac by Mateusz Kowalczyk at 2014-03-13T21:19:07+00:00
Always read in prologue files as UTF8 (#286).

- - - - -
54b2fd78 by Mateusz Kowalczyk at 2014-03-13T21:28:09+00:00
Style only

- - - - -
fa4fe650 by Simon Hengel at 2014-03-15T09:04:18+01:00
Add Fuuzetsu maintainers field in cabal file

- - - - -
f83484b7 by Niklas Haas at 2014-03-15T18:20:24+00:00
Hide minimal definition for only-method classes

Previously this was not covered by the All xs check since here it is not
actually an All, rather a single Var n.

This also adds the previously missing html-test/src/Minimal.hs.

- - - - -
0099d276 by Niklas Haas at 2014-03-15T18:20:26+00:00
Fix issue haskell/haddock#281

This is a regression from the data family instances change. Data
instances are now distinguished from regular lists by usage of the new
class "inst", and the style has been updated to only apply to those.

I've also updated the appropriate test case to test this a bit better,
including GADT instances with GADT-style records.

- - - - -
1f9687bd by Mateusz Kowalczyk at 2014-03-21T17:48:37+00:00
Please cabal sdist

- - - - -
75542693 by Mateusz Kowalczyk at 2014-03-22T16:36:16+00:00
Drop needless --split-objs which slows us down.

Involves tiny cleanup of all the dynflag bindings. Fixes haskell/haddock#292.

- - - - -
31214dc3 by Herbert Valerio Riedel at 2014-03-23T18:01:01+01:00
Fix a few typos

Signed-off-by: Herbert Valerio Riedel <hvr at gnu.org>

- - - - -
0b73e638 by Mateusz Kowalczyk at 2014-03-31T05:34:36+01:00
Print kind signatures on GADTs

- - - - -
2bab42f3 by Mateusz Kowalczyk at 2014-03-31T16:53:25+01:00
Add default for new PlatformConstraints field

- - - - -
42647c5f by Mateusz Kowalczyk at 2014-03-31T18:29:04+01:00
Drop leading whitespace in @-style blocks.

Fixes haskell/haddock#201.

- - - - -
98208294 by Niklas Haas at 2014-03-31T20:09:58+02:00
Crash when exporting record selectors of data family instances

This fixes bug haskell/haddock#294.

This also fixes a related but never-before-mentioned bug about the
display of GADT record selectors with non-polymorphic type signatures.

Note: Associated data type constructors fail to show up if nothing is
exported that they could be attached to. Exporting any of the data types
in the instance head, or the class + data family itself, causes them to
show up, but in the absence of either of these, exporting just the
associated data type with the constructor itself will result in it
being hidden.

The only scenario I can come up that would involve this kind of
situation involved OverlappingInstances, and even then it can be
mitigated by just exporting the class itself, so I'm not going to solve
it since the logic would most likely be very complicated.

- - - - -
3832d171 by Mateusz Kowalczyk at 2014-04-01T19:07:33+01:00
Make CHANGES consistent with what's now in 2.14.2

- - - - -
c386ae89 by Mateusz Kowalczyk at 2014-04-01T19:18:36+01:00
Actually bundle extra spec tests in sdist

- - - - -
bd57a6d3 by Mateusz Kowalczyk at 2014-04-03T21:13:48+01:00
Update test cases for GHC bug haskell/haddock#8945, Haddock haskell/haddock#188

The order of signature groups has been corrected upstream. Here we add a
test case and update some existing test-cases to reflect this change. We
remove grouped signature in test cases that we can (Minimal,
BugDeprecated &c) so that the test is as self-contained as possible.

- - - - -
708b88b1 by Mateusz Kowalczyk at 2014-04-03T21:16:07+01:00
Enforce strict GHC version in cabal file

This stops people with 7.6.3 trying to install 2.15.x which clearly
won't work. Unfortunately we shipped 2.14.x without realising this.

- - - - -
60334f7c by Mateusz Kowalczyk at 2014-04-03T21:19:24+01:00
Initialise some new PlatformConstants fields

- - - - -
ea77f668 by Mateusz Kowalczyk at 2014-04-11T16:52:23+01:00
We don't actually want unicode here

- - - - -
0b651cae by Mateusz Kowalczyk at 2014-04-11T18:13:30+01:00
Parse identifiers with ^ and ⋆ in them.

Fixes haskell/haddock#298.

- - - - -
e8ad0f5f by Mateusz Kowalczyk at 2014-04-11T18:47:41+01:00
Ignore version string during HTML tests.

- - - - -
de489089 by Mateusz Kowalczyk at 2014-04-11T18:59:30+01:00
Update CHANGES to follow 2.14.3

- - - - -
beb464a9 by Gergő Érdi at 2014-04-13T16:31:10+08:00
remove Origin flag from LHsBindsLR

- - - - -
cb16f07c by Herbert Valerio Riedel at 2014-04-21T17:16:50+02:00
Replace local `die` by new `System.Exit.die`

Starting with GHC 7.10, System.Exit exports the new `die`
which is essentially the same as Haddock.Util.die, so this
commit changes Haddock.Util.die to be a simple re-export
of System.Exit.die. See also

  https://ghc.haskell.org/trac/ghc/ticket/9016

for more details.

Signed-off-by: Herbert Valerio Riedel <hvr at gnu.org>

- - - - -
9b9b23c7 by Mateusz Kowalczyk at 2014-05-03T15:40:11+02:00
Disambiguate ‘die’ in test runners.

- - - - -
5d28a2b8 by Mateusz Kowalczyk at 2014-05-05T09:19:49+02:00
Prepare modules for parser split.

We have to generalise the Doc (now DocH) slightly to remove the
dependency on GHC-supplied type.

- - - - -
d3967ff3 by Mateusz Kowalczyk at 2014-05-05T11:00:41+02:00
Move parser + parser tests out to own package.

We move some types out that are necessary as well and then
re-export and specialise them in the core Haddock.

Reason for moving out spec tests is that if we're working on the parser,
we can simply work on that and we can ignore the rest of Haddock. The
downside is that it's a little inconvenient if at the end of the day we
want to see that everything passes.

- - - - -
522a448d by Mateusz Kowalczyk at 2014-05-05T11:14:47+02:00
Move out Show and Eq instances to Types

They are much more useful to the users here.

- - - - -
11a6f0f2 by Mateusz Kowalczyk at 2014-05-06T13:50:31+02:00
Remove no longer necessary parser error handling.

We can now drop some Maybe tests and even lets us strip an error
handling monad away in a few places.

- - - - -
6992c924 by Mateusz Kowalczyk at 2014-05-14T02:23:55+02:00
Please the GHC build-system.

As I can not figure out how to do this properly, if we're in GHC tree,
we treat the library as being the same package. If we're not in the
tree, we require that the library be installed separately.

- - - - -
7a8ad763 by Mateusz Kowalczyk at 2014-05-14T14:50:25+02:00
Update issue tracker URL

- - - - -
f616c521 by Mateusz Kowalczyk at 2014-05-14T14:53:32+02:00
Update issue tracker URL for haddock-library

- - - - -
66580ded by Gergő Érdi at 2014-05-25T14:24:16+08:00
Accomodate change in PatSyn representation

- - - - -
0e43b988 by Mateusz Kowalczyk at 2014-05-29T03:15:29+02:00
Revert "Accomodate change in PatSyn representation"

This reverts commit 57aa591362d7c8ba21285fccd6a958629a422091. I am
reverting this because I pushed it to master when it was meant to stay
on a wip-branch. Sorry Gergo and everyone who had trouble due to this.

- - - - -
e10d7ec8 by Mateusz Kowalczyk at 2014-05-29T03:24:11+02:00
Revert "Revert "Accomodate change in PatSyn representation""

This reverts commit e110e6e70e40eed06c06676fd2e62578da01d295.

Apparently as per GHC commit ac2796e6ddbd54c5762c53e2fcf29f20ea162fd5
this was actually intended. Embarrasing for me.

- - - - -
5861aca9 by Mateusz Kowalczyk at 2014-06-05T19:49:27+02:00
Clear up highlighting of identifiers with ‘'’s.

- - - - -
d7cc420f by Simon Peyton Jones at 2014-06-06T12:41:09+01:00
Follow change in patSynSig

- - - - -
938b4fd8 by Mateusz Kowalczyk at 2014-06-12T07:24:29+02:00
Slightly update the readme.

Style-sheets are no longer a recent thing, dead links, old maintainers,
different formats.

- - - - -
c7799dea by Mateusz Kowalczyk at 2014-06-18T00:05:56+02:00
Update cabal files

Update repository urls, use subdir property for haddock-library and use
a separate versioning scheme for haddock-library in preparation for release.

- - - - -
a2750b6a by Simon Hengel at 2014-06-18T11:01:18+08:00
Compatibility with older versions of base and bytestring

- - - - -
009b4b03 by Simon Hengel at 2014-06-18T11:14:01+08:00
Enable travis-ci for haddock-library

- - - - -
9b5862eb by Simon Hengel at 2014-06-18T11:14:01+08:00
haddock-library: Do not depend on haddock-library in test suite

I think you either add src to hs-source-dirs or the library to
build-depends.  But doing both does not make sense (AFAICT).

- - - - -
fb1f3279 by Simon Hengel at 2014-06-18T11:49:05+08:00
haddock-library: Use -Wall for specs

- - - - -
649340e1 by Mateusz Kowalczyk at 2014-06-18T06:58:54+02:00
Use Travis with multiple GHC versions

When using HEAD, we build haddock-library directly from repository as a
dependency (and thanks to --enable-tests, the tests get ran anyway). In
all other cases, we manually run the tests on haddock-library only and
don't test the main project.

- - - - -
d7eeeec2 by Mateusz Kowalczyk at 2014-06-18T07:49:04+02:00
Comment improvements + few words in cabal file

- - - - -
0f8db914 by Simon Hengel at 2014-06-18T13:52:23+08:00
Use doctest to check examples in documentation

- - - - -
2888a8dc by Simon Hengel at 2014-06-18T14:16:48+08:00
Remove doctest dependency

(so that we can use haddock-library with doctest)

- - - - -
626d5e85 by Mateusz Kowalczyk at 2014-06-18T08:41:25+02:00
Travis tweaks

- - - - -
41d4f9cc by Mateusz Kowalczyk at 2014-06-18T08:58:43+02:00
Don't actually forget to install specified GHC.

- - - - -
c6aa512a by John MacFarlane at 2014-06-18T10:43:57-07:00
Removed reliance on LambdaCase (which breaks build with ghc 7.4).

- - - - -
b9b93b6f by John MacFarlane at 2014-06-18T10:54:56-07:00
Fixed haddock warnings.

- - - - -
a41b0ab5 by Mateusz Kowalczyk at 2014-06-19T01:20:10+02:00
Update Travis, bump version

- - - - -
864bf62a by Mateusz Kowalczyk at 2014-06-25T10:36:54+02:00
Fix anchors. Closes haskell/haddock#308.

- - - - -
53df91bb by Mateusz Kowalczyk at 2014-06-25T15:04:49+02:00
Drop DocParagraph from front of headers

I can not remember why they were wrapped in paragraphs to begin with and
it seems unnecessary now that I test it. Closes haskell/haddock#307.

- - - - -
29b5f2fa by Mateusz Kowalczyk at 2014-06-25T15:17:20+02:00
Don't mangle append order for nested lists.

The benefit of this is that the ‘top-level’ element of such lists is
properly wrapped in <p> tags so any CSS working with these will be
applied properly. It also just makes more sense.

Pointed out at jgm/pandoc#1346.

- - - - -
05cb6e9c by Mateusz Kowalczyk at 2014-06-25T15:19:45+02:00
Bump haddock-library to 1.1.0 for release

- - - - -
70feab15 by Iavor Diatchki at 2014-07-01T03:37:07-07:00
Propagate overloading-mode for instance declarations in haddock (#9242)

- - - - -
d4ca34a7 by Simon Peyton Jones at 2014-07-14T16:23:15+01:00
Adapt to new definition of HsDecls.TyFamEqn

This is a knock-on from the refactoring from Trac haskell/haddock#9063.
I'll push the corresponding changes to GHC shortly.

- - - - -
f91e2276 by Edward Z. Yang at 2014-07-21T08:14:19-07:00
Track GHC PackageId to PackageKey renaming.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

Conflicts:
	src/Haddock/Interface/Create.hs

- - - - -
b010f9ef by Edward Z. Yang at 2014-07-25T16:28:46-07:00
Track changes for module reexports.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

Conflicts:
	src/Haddock/Interface/Create.hs

- - - - -
8b85f9f9 by Mateusz Kowalczyk at 2014-07-28T13:25:43+02:00
Catch mid-line URLs. Fixes haskell/haddock#314.

- - - - -
4c613a78 by Edward Z. Yang at 2014-08-05T03:11:00-07:00
Track type signature change of lookupModuleInAllPackages

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
e80b051c by Edward Z. Yang at 2014-08-05T17:34:26+01:00
If GhcProfiled, also build Haddock profiled.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
f9cccd29 by Edward Z. Yang at 2014-08-07T14:23:35+01:00
Ignore TAGS files.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
00b3af52 by Mateusz Kowalczyk at 2014-08-08T04:58:19+02:00
Update to attoparsec-0.12.1.1

There seems to be memory and speed improvement.

- - - - -
5457dc71 by Mateusz Kowalczyk at 2014-08-08T18:24:02+02:00
Fix forgotten src

- - - - -
3520cb04 by Mateusz Kowalczyk at 2014-08-14T20:19:07+01:00
Bump down the version for master to 2.14.4

- - - - -
dc98c21b by Mateusz Kowalczyk at 2014-08-14T20:23:27+01:00
Revert "Track type signature change of lookupModuleInAllPackages"

This reverts commit d59fec2c9551b5662a3507c0011e32a09a9c118f.

- - - - -
3f2038c0 by Mateusz Kowalczyk at 2014-08-14T20:23:31+01:00
Revert "Track changes for module reexports."

This reverts commit b99b57c0df072d12b67816b45eca2a03cb1da96d.

- - - - -
56d4e49e by Mateusz Kowalczyk at 2014-08-14T20:23:42+01:00
Revert "Track GHC PackageId to PackageKey renaming."

This reverts commit 8ac42d3327473939c013551750425cac191ff0fd.

- - - - -
726ea3cb by Mateusz Kowalczyk at 2014-08-14T20:23:47+01:00
Revert "Adapt to new definition of HsDecls.TyFamEqn"

This reverts commit cb96b4f1ed0462b4a394b9fda6612c3bea9886bd.

- - - - -
61a88ff0 by Mateusz Kowalczyk at 2014-08-14T20:23:52+01:00
Revert "Propagate overloading-mode for instance declarations in haddock (#9242)"

This reverts commit 8d20ca8d5a9bee73252ff2035ec45f9c03d0820c.

- - - - -
a32ba674 by Mateusz Kowalczyk at 2014-08-14T20:26:03+01:00
Revert "Disambiguate ‘die’ in test runners."

This reverts commit dba02d6df32534aac5d257f2d28596238d248942.

- - - - -
f335820f by Mateusz Kowalczyk at 2014-08-14T20:26:09+01:00
Revert "Replace local `die` by new `System.Exit.die`"

This reverts commit 08aa509ebac58bfb202ea79c7c41291ec280a1c5.

- - - - -
107078e4 by Mateusz Kowalczyk at 2014-08-14T20:27:34+01:00
Merge branch 'reverts'

This reverts any changes that were made to have Haddock compile with
7.9. When 7.10 release comes, we can simply re-apply all the patches and
any patches that occur on ghc-head branch from now on.

This allows us to build master with 7.8.3

- - - - -
b44b3871 by Mateusz Kowalczyk at 2014-08-15T02:47:40+01:00
Fix haskell/haddock#313 by doing some list munging.

I get rid of the Monoid instance because we weren't satisfying the laws.
Convenience of having <> didn't outweigh the shock-factor of having it
behave badly.

- - - - -
e1a62cde by Mateusz Kowalczyk at 2014-08-15T02:52:56+01:00
Stop testing haskell/haddock#188.

Because the change is in GHC 7.9 and we now work against 7.8.3, this
test no longer makes sense. We revert it until 7.10 becomes the standard
version. If anything, there should be a test for this in GHC itself.

- - - - -
54e8286d by Mateusz Kowalczyk at 2014-08-15T05:31:57+01:00
Add haskell/haddock#313 to CHANGES

- - - - -
9df7ad5d by Simon Hengel at 2014-08-20T11:25:32+08:00
Fix warning

- - - - -
ee2574d6 by Simon Hengel at 2014-08-20T12:07:01+08:00
Fix travis builds

- - - - -
384cf2e6 by Simon Hengel at 2014-08-20T12:14:31+08:00
Require GHC 7.8.3

- - - - -
d4779863 by Simon Hengel at 2014-08-22T12:14:16+08:00
Move Haddock API to a separate package

- - - - -
80f3e0e1 by Simon Hengel at 2014-08-22T14:57:38+08:00
Bump version to 2.15.0 and add version constraints

- - - - -
309a94ce by Simon Hengel at 2014-08-22T15:18:06+08:00
Add deprecated compatibility module

- - - - -
4d1e4e3f by Luite Stegeman at 2014-08-22T20:46:45+02:00
export things to allow customizing how the Ghc session is run

- - - - -
47884591 by Luite Stegeman at 2014-08-22T20:46:51+02:00
ghc 7.8.2 compatibility

- - - - -
5ea94e2c by Luite Stegeman at 2014-08-22T22:08:58+02:00
install dependencies for haddock-api on travis

- - - - -
9fb845b2 by Mateusz Kowalczyk at 2014-08-23T10:09:34+01:00
Move sources under haddock-api/src

- - - - -
85817dc4 by Mateusz Kowalczyk at 2014-08-23T10:10:48+01:00
Remove compat stuff

- - - - -
151c6169 by Niklas Haas at 2014-08-24T08:14:10+02:00
Fix extra whitespace on signatures and update all test cases

This was long overdue, now running ./accept.lhs on a clean test from
master will not generate a bunch of changes.

- - - - -
d320e0d2 by Niklas Haas at 2014-08-24T08:14:35+02:00
Omit unnecessary foralls and fix haskell/haddock#315

This also fixes haskell/haddock#86.

- - - - -
bdafe108 by Mateusz Kowalczyk at 2014-08-24T15:06:46+01:00
Update CHANGES

- - - - -
fafa6d6e by Mateusz Kowalczyk at 2014-08-24T15:14:23+01:00
Delete few unused/irrelevant/badly-place files.

- - - - -
3634923d by Duncan Coutts at 2014-08-27T13:49:31+01:00
Changes due to ghc api changes in package representation

Also fix a bug with finding the package name and version given a
module. This had become wrong due to the package key changes (it was
very hacky in the first place). We now look up the package key in the
package db to get the package info properly.

- - - - -
539a7e70 by Herbert Valerio Riedel at 2014-08-31T11:36:32+02:00
Import Data.Word w/o import-list

This is needed to keep the compilation warning free (and thus pass GHC's
./validate) regardless of whether Word is re-exported from Prelude or not

See https://ghc.haskell.org/trac/ghc/ticket/9531 for more details

- - - - -
9e3a0e5b by Mateusz Kowalczyk at 2014-08-31T12:54:43+01:00
Bump version in doc

- - - - -
4a177525 by Mateusz Kowalczyk at 2014-08-31T13:01:23+01:00
Bump haddock-library version

- - - - -
f99c1384 by Mateusz Kowalczyk at 2014-08-31T13:05:25+01:00
Remove references to deleted files

- - - - -
5e51a247 by Mateusz Kowalczyk at 2014-08-31T14:18:44+01:00
Make the doc parser not complain

- - - - -
2cedb49a by Mateusz Kowalczyk at 2014-09-03T03:33:15+01:00
CONTRIBUTING file for issues

- - - - -
88027143 by Mateusz Kowalczyk at 2014-09-04T00:46:59+01:00
Mention --print-missing-docs

- - - - -
42f6754f by Alan Zimmerman at 2014-09-05T18:13:24-05:00
Follow changes to TypeAnnot in GHC HEAD

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
e712719e by Austin Seipp at 2014-09-09T01:03:27-05:00
Fix import of 'empty' due to AMP.

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
71c29755 by Herbert Valerio Riedel at 2014-09-09T17:35:20+02:00
Bump `base` constraint for AMP

- - - - -
0bf9f3ed by Mateusz Kowalczyk at 2014-09-12T19:18:32+01:00
Delete stale ANNOUNCE

- - - - -
cac89ee6 by Krzysztof Gogolewski at 2014-09-14T17:17:09+02:00
Followup changes to addition of -fwarn-context-quantification (GHC Trac haskell/haddock#4426)

- - - - -
4d683426 by Edward Z. Yang at 2014-09-18T13:38:11-07:00
Properly render package ID (not package key) in index, fixes haskell/haddock#329.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
80697fd5 by Herbert Valerio Riedel at 2014-09-19T00:07:52+02:00
Disambiguate string-literals

GHC fails type-inference with `OverloadedStrings` + `Data.Foldable.elem`
otherwise.

- - - - -
c015eb70 by Herbert Valerio Riedel at 2014-09-19T00:10:36+02:00
Revert "Followup changes to addition of -fwarn-context-quantification"

This reverts commit 4023817d7c0e46db012ba2eea28022626841ca9b temporarily
as the respective feature hasn't landed in GHC HEAD yet, but this commit
blocks later commits from being referenced in GHC HEAD.

- - - - -
38ded784 by Edward Z. Yang at 2014-09-18T15:32:15-07:00
Revert "Revert "Followup changes to addition of -fwarn-context-quantification""

This reverts commit db14fd8ab4fab43694139bc203808b814eafb2dc.
It's in HEAD now.

- - - - -
f55d59c9 by Herbert Valerio Riedel at 2014-09-26T19:18:28+02:00
Revert "Fix import of 'empty' due to AMP."

This reverts commit 0cc5bc85e9fca92ab712b68a2ba2c0dd9d3d79f4 since
it turns out we don't need to re-export `empty` from Control.Monad after
all.

- - - - -
467050f1 by David Feuer at 2014-10-09T20:07:36-04:00
Fix improper lazy IO use

Make `getPrologue` force `parseParas dflags str` before returning. Without this, it will attempt to read from the file after it is closed, with unspecified and generally bad results.
- - - - -
cc47b699 by Edward Z. Yang at 2014-10-09T21:38:19-07:00
Fix use-after-close lazy IO bug

Make `getPrologue` force `parseParas dflags str` before returning. Without this,
it will attempt to read from the file after it is closed, with unspecified and
generally bad results.

Signed-off-by: David Feuer <David.Feuer at gmail.com>
Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
87babcbe by Austin Seipp at 2014-10-20T20:05:27-05:00
Add an .arcconfig file.

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
ab259516 by Austin Seipp at 2014-10-20T20:07:01-05:00
Add .arclint file.

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
b918093c by Mateusz Kowalczyk at 2014-10-29T03:59:39+00:00
Experimental support for collapsable headers

Closes haskell/haddock#335

- - - - -
849db129 by Mateusz Kowalczyk at 2014-10-29T10:07:26+01:00
Experimental support for collapsable headers

(cherry picked from commit e2ed3b9d8dfab09f1b1861dbc8e74f08e137ebcc)

- - - - -
a4cc4789 by Herbert Valerio Riedel at 2014-10-31T11:08:26+01:00
Collapse user-defined section by default (re haskell/haddock#335)

- - - - -
9da1b33e by Yuras Shumovich at 2014-10-31T16:11:04-05:00
reflect ForeignType constructore removal

Reviewers: austin

Reviewed By: austin

Differential Revision: https://phabricator.haskell.org/D358

- - - - -
c625aefc by Austin Seipp at 2014-10-31T19:34:10-05:00
Remove overlapping pattern match

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
c7738e5e by Simon Hengel at 2014-11-02T07:25:30+08:00
Remove -fobject-code from .ghci

(this slows down reloads on modifications)

- - - - -
d4a86e95 by Simon Hengel at 2014-11-03T09:26:11+08:00
Get rid of StandaloneDeriving

- - - - -
a974e311 by Simon Hengel at 2014-11-03T09:26:11+08:00
Derive more instances

- - - - -
8aa0c4d7 by Simon Hengel at 2014-11-03T09:27:08+08:00
Remove unused language extensions

- - - - -
3052d46a by Simon Hengel at 2014-11-03T09:30:46+08:00
Minor refactoring

- - - - -
4281d3cb by Simon Hengel at 2014-11-03T09:30:46+08:00
parser: Try to parse definition lists right before text paragraphs

- - - - -
8ba12bf9 by Simon Hengel at 2014-11-03T09:34:19+08:00
Add support for markdown links (closes haskell/haddock#336)

- - - - -
a2f8d747 by Simon Hengel at 2014-11-03T09:34:19+08:00
Allow markdown links at the beginning of a paragraph

- - - - -
53b11207 by Simon Hengel at 2014-11-03T09:34:20+08:00
Update documentation

- - - - -
652267c6 by Simon Hengel at 2014-11-03T09:34:20+08:00
Add support for markdown images

- - - - -
9d667502 by Simon Hengel at 2014-11-03T09:34:20+08:00
Allow an optional colon after the closing bracket of definition lists

This is to disambiguate them from markdown links and will be require
with a future release.

- - - - -
8167fc32 by Mateusz Kowalczyk at 2014-11-04T01:16:51+00:00
whitespace only

- - - - -
3da62981 by Mateusz Kowalczyk at 2014-11-04T01:17:31+00:00
Fix re-exports of built-in type families

Fixes haskell/haddock#310

- - - - -
edc76b34 by Mateusz Kowalczyk at 2014-11-04T02:54:28+00:00
Turn some uses of error into recoverable warnings

This should at the very least not abort when something weird happens. It
does feel like we should have a type that carries these errors until the
end however as the user might not see them unless they are printed at
the end.

- - - - -
0a137400 by Mateusz Kowalczyk at 2014-11-04T04:09:44+00:00
Fix warnings

- - - - -
d068fc21 by Mateusz Kowalczyk at 2014-11-04T21:04:07+00:00
Fix parsing of identifiers written in infix way

- - - - -
1a9f2f3d by Simon Hengel at 2014-11-08T11:32:42+08:00
Minor code simplification

- - - - -
6475e9b1 by Simon Hengel at 2014-11-08T17:28:33+08:00
newtype-wrap parser monad

- - - - -
dc1ea105 by Herbert Valerio Riedel at 2014-11-15T11:55:43+01:00
Make compatible with `deepseq-1.4.0.0`

...by not relying on the default method implementation of `rnf`

- - - - -
fbb1aca4 by Simon Hengel at 2014-11-16T08:51:38+08:00
State intention rather than implementation details in Haddock comment

- - - - -
97851ab2 by Simon Hengel at 2014-11-16T10:20:19+08:00
(wip) Add support for @since (closes haskell/haddock#26)

- - - - -
34bcd18e by Gergő Érdi at 2014-11-20T22:35:38+08:00
Update Haddock to new pattern synonym type signature syntax

- - - - -
304b7dc3 by Jan Stolarek at 2014-11-20T17:48:43+01:00
Follow changes from haskell/haddock#9812

- - - - -
920f9b03 by Richard Eisenberg at 2014-11-20T16:52:50-05:00
Changes to reflect refactoring in GHC as part of haskell/haddock#7484

- - - - -
0bfe4e78 by Alan Zimmerman at 2014-11-21T11:23:09-06:00
Follow API changes in D426

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
356ed45a by Thomas Winant at 2014-11-28T16:11:22-06:00
Support for PartialTypeSignatures

- - - - -
5dc8f3b1 by Gergő Érdi at 2014-11-29T15:39:09+08:00
For pattern synonyms, render "pattern" as a keyword

- - - - -
fe704480 by Mateusz Kowalczyk at 2014-12-09T03:38:32+00:00
List new module in cabal file

- - - - -
b9ad5a29 by Mateusz Kowalczyk at 2014-12-10T00:58:24+00:00
Allow the parser to spit out meta-info

Currently we only use it only for ‘since’ annotations but with these
patches it should be fairly simple to add new attributes if we wish to.

Closes haskell/haddock#26. It seems to work fine but due to 7.10 rush I don't have the
chance to do more exhaustive testing right now. The way the meta is
output (emphasis at the end of the whole comment) is fairly arbitrary
and subject to bikeshedding.

Note that this makes test for Bug310 fail due to interface version bump:
it can't find the docs for base with this interface version so it fails.
There is not much we can do to help this because it tests for ’built-in’
identifier, not something we can provide ourselves.

- - - - -
765af0e3 by Mateusz Kowalczyk at 2014-12-10T01:17:19+00:00
Update doctest parts of comments

- - - - -
8670272b by jpmoresmau at 2014-12-10T01:35:31+00:00
header could contain several lines

Closes haskell/haddock#348

- - - - -
4f9ae4f3 by Mateusz Kowalczyk at 2014-12-12T06:22:31+00:00
Revert "Merge branch 'reverts'"

This reverts commit 5c93cc347773c7634321edd5f808d5b55b46301f, reversing
changes made to 5b81a9e53894d2ae591ca0c6c96199632d39eb06.

Conflicts:
	haddock-api/src/Haddock/Convert.hs

- - - - -
e974ac94 by Duncan Coutts at 2014-12-12T06:26:11+00:00
Changes due to ghc api changes in package representation

Also fix a bug with finding the package name and version given a
module. This had become wrong due to the package key changes (it was
very hacky in the first place). We now look up the package key in the
package db to get the package info properly.

Conflicts:
	haddock-api/src/Haddock.hs

- - - - -
2f3a2365 by Herbert Valerio Riedel at 2014-12-12T06:26:51+00:00
Import Data.Word w/o import-list

This is needed to keep the compilation warning free (and thus pass GHC's
./validate) regardless of whether Word is re-exported from Prelude or not

See https://ghc.haskell.org/trac/ghc/ticket/9531 for more details

- - - - -
1dbd6390 by Alan Zimmerman at 2014-12-12T06:32:07+00:00
Follow changes to TypeAnnot in GHC HEAD

Signed-off-by: Austin Seipp <aseipp at pobox.com>

Conflicts:
	haddock-api/src/Haddock/Convert.hs

- - - - -
bb6ff1f4 by Mateusz Kowalczyk at 2014-12-12T06:35:07+00:00
Bump ‘base’ constraint

Follows the similar commit made on ghc-head branch

- - - - -
466fe4ab by Krzysztof Gogolewski at 2014-12-12T06:37:42+00:00
Followup changes to addition of -fwarn-context-quantification (GHC Trac haskell/haddock#4426)

- - - - -
97e080c9 by Edward Z. Yang at 2014-12-12T06:39:35+00:00
Properly render package ID (not package key) in index, fixes haskell/haddock#329.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

Conflicts:
	haddock-api/src/Haddock/ModuleTree.hs

- - - - -
20b2af56 by Herbert Valerio Riedel at 2014-12-12T06:42:50+00:00
Disambiguate string-literals

GHC fails type-inference with `OverloadedStrings` + `Data.Foldable.elem`
otherwise.

Conflicts:
	haddock-library/src/Documentation/Haddock/Parser.hs

- - - - -
b3ad269d by Austin Seipp at 2014-12-12T06:44:14+00:00
Add an .arcconfig file.

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
072df0dd by Austin Seipp at 2014-12-12T06:45:01+00:00
Add .arclint file.

Signed-off-by: Austin Seipp <austin at well-typed.com>

- - - - -
dbb9294a by Herbert Valerio Riedel at 2014-12-12T06:46:17+00:00
Collapse user-defined section by default (re haskell/haddock#335)

Conflicts:
	haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs

- - - - -
f23ab545 by Yuras Shumovich at 2014-12-12T06:46:41+00:00
reflect ForeignType constructore removal

Reviewers: austin

Reviewed By: austin

Differential Revision: https://phabricator.haskell.org/D358

- - - - -
753a4b67 by Austin Seipp at 2014-12-12T06:46:51+00:00
Remove overlapping pattern match

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
8954e8f5 by Herbert Valerio Riedel at 2014-12-12T06:50:53+00:00
Make compatible with `deepseq-1.4.0.0`

...by not relying on the default method implementation of `rnf`

- - - - -
d2b06d61 by Gergő Érdi at 2014-12-12T07:07:30+00:00
Update Haddock to new pattern synonym type signature syntax

Conflicts:
	haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
	haddock-api/src/Haddock/Convert.hs

- - - - -
1ff02426 by Jan Stolarek at 2014-12-12T07:13:24+00:00
Follow changes from haskell/haddock#9812

Conflicts:
	haddock-api/src/Haddock/Convert.hs

- - - - -
06ad7600 by Richard Eisenberg at 2014-12-12T07:13:43+00:00
Changes to reflect refactoring in GHC as part of haskell/haddock#7484

- - - - -
8fd2aa8b by Alan Zimmerman at 2014-12-12T07:22:25+00:00
Follow API changes in D426

Signed-off-by: Austin Seipp <aseipp at pobox.com>

Conflicts:
	haddock-api/src/Haddock/Backends/LaTeX.hs
	haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
	haddock-api/src/Haddock/Convert.hs

- - - - -
95c3db98 by Thomas Winant at 2014-12-12T07:35:49+00:00
Support for PartialTypeSignatures

Conflicts:
	haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
	haddock-api/src/Haddock/Convert.hs
	haddock-api/src/Haddock/Interface/Create.hs

- - - - -
45494428 by Gergő Érdi at 2014-12-12T07:36:18+00:00
For pattern synonyms, render "pattern" as a keyword

- - - - -
a237e3eb by Mateusz Kowalczyk at 2014-12-12T12:27:13+00:00
Various fixups and bumps for next release

- - - - -
22918bcd by Herbert Valerio Riedel at 2014-12-14T10:11:47+01:00
Remove redundant wild-card pattern match

(this would otherwise cause a build-failure with `-Werror`)

- - - - -
1d6ce947 by Herbert Valerio Riedel at 2014-12-14T10:17:06+01:00
Treat GHC 7.10 the same as GHC 7.9

...since the current GHC 7.9 is going to become GHC 7.10 real-soon-now anyway

- - - - -
f434ea89 by Herbert Valerio Riedel at 2014-12-14T18:26:50+01:00
Fixup ghc.mk (follow-up to 1739375eb23342)

This makes the GHC build-system aware of the data-files to be copied
into the bindist (as haddock.cabal doesn't list those anymore)

- - - - -
6fb839eb by Mateusz Kowalczyk at 2014-12-17T09:28:59+00:00
Only keep one Version instead of blindly appending

- - - - -
40645489 by Mateusz Kowalczyk at 2014-12-18T07:09:44+00:00
Fix dependency version

- - - - -
8b3b927b by Mateusz Kowalczyk at 2014-12-18T07:14:23+00:00
Print missing docs by default

Adds --no-print-missing-docs

- - - - -
59666694 by Mateusz Kowalczyk at 2014-12-18T07:21:37+00:00
update changelog

- - - - -
aa6d168e by Mateusz Kowalczyk at 2014-12-18T07:30:58+00:00
Update docs for @since

- - - - -
2d7043ee by Luite Stegeman at 2014-12-19T18:29:35-06:00
hide projectVersion from DynFlags since it clashes with Haddock.Version.projectVersion

- - - - -
aaa70fc0 by Luite Stegeman at 2014-12-22T15:58:43+01:00
Add missing import for standalone haddock-api package

- - - - -
9ce01269 by Herbert Valerio Riedel at 2014-12-22T17:48:45+01:00
Reset ghc-head with master's tree

(this is an overwriting git merge of master into ghc-head)

- - - - -
fcd6fec1 by Herbert Valerio Riedel at 2014-12-22T17:51:52+01:00
Bump versions for ghc-7.11

- - - - -
525ec900 by Mateusz Kowalczyk at 2014-12-23T13:36:24+00:00
travis-ci: test with HEAD

- - - - -
cbf494b5 by Simon Peyton Jones at 2014-12-23T15:22:56+00:00
Eliminate instanceHead' in favour of GHC's instanceSig

This is made possible by the elimination of "silent superclass
parameters" in GHC

- - - - -
50e01c99 by Mateusz Kowalczyk at 2014-12-29T15:28:47+00:00
Make travis use 7.10.x

- - - - -
475e60b0 by Njagi Mwaniki at 2014-12-29T15:30:44+00:00
Turn the README into GitHub Markdown format.

Closes haskell/haddock#354

- - - - -
8cacf48e by Luite Stegeman at 2015-01-05T16:25:37+01:00
bump haddock-api ghc dependency to allow release candidate and first release

- - - - -
6ed6cf1f by Simon Peyton Jones at 2015-01-06T16:37:47+00:00
Remove redundant constraints from haddock, discovered by -fwarn-redundant-constraints

- - - - -
8b484f33 by Simon Peyton Jones at 2015-01-08T15:50:22+00:00
Track naming change in DataCon

- - - - -
23c5c0b5 by Alan Zimmerman at 2015-01-16T10:15:11-06:00
Follow API changes in D538

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
e7a5532c by JP Moresmau at 2015-01-22T17:19:03+00:00
Ignore warnings, install Cabal 1.22

- - - - -
86942c84 by jpmoresmau at 2015-01-22T17:19:04+00:00
solve dataDir ambiguity

- - - - -
5ceb743e by jpmoresmau at 2015-01-22T19:17:32+00:00
support GHC 7.10: no Safe-Inferred, Foldable instance

- - - - -
6a3b3fb5 by Mateusz Kowalczyk at 2015-01-22T19:32:10+00:00
Update test files

Test: a correct behaviour for fields comma-separating values. I'm
surprised we had no bug open for this. Maybe it affects how haskell/haddock#301 renders
now but I doubt.

Operators: Seems GHC is giving us a new order for operators, something
must have changed on their side again. cc @haasn , this makes the fixity
to the side not match the order on the LHS which is a bit unpleasant.
Maybe the fixity can be made to match the GHC order?

Bug335: We expand examples by default now.

Bug310: Now inferred safe.

- - - - -
708f8b2f by jpmoresmau at 2015-01-22T19:36:59+00:00
Links to source location of class instance definitions

- - - - -
5cf8a6da by Vincent Berthoux at 2015-01-22T19:59:58+00:00
Filter '\r' from comments due to Windows problems.

On Windows this was causing newline to be rendered twice in code blocks.
Closes haskell/haddock#359, fixes haskell/haddock#356.

- - - - -
1749e6f0 by Mateusz Kowalczyk at 2015-01-22T20:31:27+00:00
Changelog only

- - - - -
c8145f90 by Mateusz Kowalczyk at 2015-01-22T23:34:05+00:00
--package-name and --package-version flags

Used for --hoogle amongst other things. Now we need to teach cabal to
use it. The situation is still a bit sub-par because if the flags aren't
passed in, the crash will occur. Closes haskell/haddock#353.

- - - - -
14248254 by Mateusz Kowalczyk at 2015-01-22T23:43:18+00:00
Sort out some module import warnings

- - - - -
d8a38989 by Simon Peyton Jones at 2015-01-23T07:10:16-06:00
Track naming change in DataCon

(cherry picked from commit 04cf63d0195837ed52075ed7d2676e71831e8a0b)

- - - - -
d3ac6ae4 by Alan Zimmerman at 2015-01-23T07:17:19-06:00
Follow API changes in D538

Signed-off-by: Austin Seipp <aseipp at pobox.com>
(cherry picked from commit d61bbc75890e4eb0ad508b9c2a27b91f691213e6)

- - - - -
4c1ffeb0 by Simon Peyton Jones at 2015-02-10T12:10:33+00:00
Track changes in HsSyn for quasi-quotes

- - - - -
775d20f7 by Mateusz Kowalczyk at 2015-03-15T08:11:48+01:00
--package-name and --package-version flags

Used for --hoogle amongst other things. Now we need to teach cabal to
use it. The situation is still a bit sub-par because if the flags aren't
passed in, the crash will occur. Closes haskell/haddock#353.

(cherry picked from commit 8e06728afb0784128ab2df0be7a5d7a191d30ff4)

- - - - -
f9245e72 by Phil Ruffwind at 2015-03-16T04:32:01-04:00
Prevent Synopsis from using up too much horizontal space

When long type signatures occur in the Synopsis, the element is
stretched beyond the width of the window.  Scrollbars don't appear, so
it's impossible to read anything when this happens.

- - - - -
cd8fa415 by Mateusz Kowalczyk at 2015-03-17T21:59:39+00:00
Update changelog

Closes haskell/haddock#151 due to 71170fc77962f10d7d001e3b8bc8b92bfeda99bc

- - - - -
b5248b47 by Ben Gamari at 2015-03-25T17:12:17+00:00
Make the error encountered when a package can't be found more
user-friendly

Closes haskell/haddock#369

- - - - -
b756b772 by Mateusz Kowalczyk at 2015-03-26T16:31:40+00:00
Remove now redundant imports

- - - - -
5ea5e8dd by Mateusz Kowalczyk at 2015-03-26T16:45:52+00:00
Update test to account for \r filtering

- - - - -
6539bfb3 by Mateusz Kowalczyk at 2015-03-27T00:20:09+00:00
Test for anchor defaulting

I delete the old tests because it turns out that:

* test runner would never put them in scope of each other even with
  imports so just one would suffice
* test runner actually needed some hacking to keep links so in the end
  we would end up with no anchors making them useless

- - - - -
1a01d950 by Mateusz Kowalczyk at 2015-03-27T00:20:09+00:00
Clearly default to variables in out of scope case

- - - - -
7943abe8 by Mateusz Kowalczyk at 2015-03-27T01:14:11+00:00
Fix Hoogle display of constructors

Fixes haskell/haddock#361

- - - - -
6d6e587e by Mateusz Kowalczyk at 2015-03-27T01:45:18+00:00
Fully qualify names in Hoogle instances output

Closes haskell/haddock#263

- - - - -
52dac365 by Mateusz Kowalczyk at 2015-03-27T01:55:01+00:00
Update changelog

- - - - -
ca5af9a8 by Mateusz Kowalczyk at 2015-03-27T02:43:55+00:00
Output method documentation in Hoogle backend

One thing of note is that we no longer preserve grouping of methods and
print each method on its own line. We could preserve it if no
documentation is present for any methods in the group if someone asks
for it though.

Fixes haskell/haddock#259

- - - - -
a33f0c10 by Mateusz Kowalczyk at 2015-03-27T03:04:21+00:00
Don't print instance safety information in Hoogle

Fixes haskell/haddock#168

- - - - -
df6c935a by Mateusz Kowalczyk at 2015-03-28T00:11:47+00:00
Post-release version bumps and changelog

- - - - -
dde8f7c0 by Mateusz Kowalczyk at 2015-03-28T20:39:10+00:00
Loosen bounds on haddock-*

- - - - -
de93bf89 by Mateusz Kowalczyk at 2015-03-28T20:39:10+00:00
Expand response files in arguments

Closes haskell/haddock#285

- - - - -
1f0b0856 by Zejun Wu at 2015-04-26T16:35:35-07:00
Do not insert anchor for section headings in contents box

- - - - -
860439d7 by Simon Peyton Jones at 2015-05-01T09:36:47+01:00
Track change in API of TyCon

- - - - -
a32f3e5f by Adam Gundry at 2015-05-04T15:32:59+01:00
Track API changes to support empty closed type familes

- - - - -
77e98bee by Ben Gamari at 2015-05-06T20:17:08+01:00
Ignore doc/haddock.{ps,pdf}

- - - - -
663d0204 by Murray Campbell at 2015-05-11T04:47:37-05:00
Change ModuleTree Node to carry PackageKey and SourcePackageId to resolve haskell/haddock#385

Signed-off-by: Austin Seipp <aseipp at pobox.com>

- - - - -
8bb0dcf5 by Murray Campbell at 2015-05-11T06:35:06-05:00
Change ModuleTree Node to carry PackageKey and SourcePackageId to resolve haskell/haddock#385

Signed-off-by: Austin Seipp <aseipp at pobox.com>
(cherry picked from commit 2380f07c430c525b205ce2eae6dab23c8388d899)

- - - - -
bad900ea by Adam Bergmark at 2015-05-11T15:29:39+01:00
haddock-library: require GHC >= 7.4

`Data.Monoid.<>` was added in base-4.5/GHC-7.4

Closes haskell/haddock#394

Signed-off-by: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

- - - - -
daceff85 by Simon Peyton Jones at 2015-05-13T12:04:21+01:00
Track the new location of setRdrNameSpace

- - - - -
1937d1c4 by Alan Zimmerman at 2015-05-25T21:27:15+02:00
ApiAnnotations : strings in warnings do not return SourceText

The strings used in a WARNING pragma are captured via

strings :: { Located ([AddAnn],[Located FastString]) }
    : STRING { sL1 $1 ([],[L (gl $1) (getSTRING $1)]) }
..

The STRING token has a method getSTRINGs that returns the original
source text for a string.

A warning of the form

{-# WARNING Logic
          , mkSolver
          , mkSimpleSolver
          , mkSolverForLogic
          , solverSetParams
          , solverPush
          , solverPop
          , solverReset
          , solverGetNumScopes
          , solverAssertCnstr
          , solverAssertAndTrack
          , solverCheck
          , solverCheckAndGetModel
          , solverGetReasonUnknown
          "New Z3 API support is still incomplete and fragile: \
          \you may experience segmentation faults!"
  #-}

returns the concatenated warning string rather than the original source.

- - - - -
ee0fb6c2 by Łukasz Hanuszczak at 2015-05-27T11:51:31+02:00
Create simple method for indentation parsing.
- - - - -
7d6fcad5 by Łukasz Hanuszczak at 2015-05-27T21:36:13+02:00
Make nested lists count indentation according to first item.
- - - - -
d6819398 by Łukasz Hanuszczak at 2015-05-27T22:46:13+02:00
Add simple test case for arbitrary-depth list nesting.
- - - - -
2929c54d by Łukasz Hanuszczak at 2015-06-03T02:11:31+02:00
Add arbitrary-indent spec test for parser.
- - - - -
9a0a9bb0 by Mateusz Kowalczyk at 2015-06-03T05:25:29+01:00
Update docs with info on new list nesting rule

Fixes haskell/haddock#278 through commits from PR haskell/haddock#401

- - - - -
12efc92c by Mateusz Kowalczyk at 2015-06-03T05:29:26+01:00
Update some meta data at the top of the docs

- - - - -
765ee49f by Bartosz Nitka at 2015-06-07T08:40:59-07:00
Add some Hacking docs for getting started

- - - - -
19aaf851 by Bartosz Nitka at 2015-06-07T08:44:30-07:00
Fix markdown

- - - - -
2a90cb70 by Mateusz Kowalczyk at 2015-06-08T15:08:36+01:00
Refine hacking instructions slightly

- - - - -
0894da6e by Thomas Winant at 2015-06-08T23:47:28-05:00
Update after wild card renaming refactoring in D613

Summary:
* Move `Post*` type instances to `Haddock.Types` as other modules than
  `Haddock.Interface.Rename` will rely on these type instances.
* Update after wild card renaming refactoring in D613.

Reviewers: simonpj, austin

Reviewed By: austin

Differential Revision: https://phabricator.haskell.org/D954

GHC Trac Issues: haskell/haddock#10098

- - - - -
10a9bb76 by Emanuel Borsboom at 2015-06-12T02:46:23+01:00
Build executable with '-threaded' (fixes haskell/haddock#399)

- - - - -
7696b94f by Mateusz Kowalczyk at 2015-06-12T02:59:19+01:00
Update changelog for -threaded

Closes haskell/haddock#400

- - - - -
d3c118ec by Bartosz Nitka at 2015-06-12T03:00:58+01:00
Fix haddock: internal error: spliceURL UnhelpfulSpan (#207)

Inferred type signatures don't have SrcSpans, so let's use the one from
the declaration.

I've tested this manually on the test-case from haskell/haddock#207, but I got stuck at
trying to run the test-suite.

- - - - -
b67e843b by Mateusz Kowalczyk at 2015-06-12T03:01:50+01:00
Changelog for haskell/haddock#207

Fixes haskell/haddock#207, closes haskell/haddock#402

- - - - -
841d785e by jpmoresmau at 2015-06-12T16:03:16+01:00
Attach to instance location the name that has the same location file

Fixes haskell/haddock#383

- - - - -
98791cae by Mateusz Kowalczyk at 2015-06-12T16:08:27+01:00
Update changelog

Closes haskell/haddock#398

- - - - -
7c0b5a87 by Phil Ruffwind at 2015-06-12T13:07:25-04:00
Fix alignment of Source links in instance table in Firefox

Due to a Firefox bug [1], a combination of 'whitespace: nowrap' on the
parent element with 'float: right' on the inner element can cause the
floated element to be displaced downwards for no apparent reason.

To work around this, the left side is wrapped in its own <span> and set
to 'float: left'.  As a precautionary measure to prevent the parent
element from collapsing entirely, we also add the classic "clearfix"
hack.  The latter is not strictly needed but it helps prevent bugs if
the layout is altered again in the future.

Fixes haskell/haddock#384.

Remark: line 159 of src/Haddock/Backends/Xhtml/Layout.hs was indented to
        prevent confusion over the operator precedence of (<+>) vs (<<).

[1]: https://bugzilla.mozilla.org/show_bug.cgi?id=488725

- - - - -
cfe86e73 by Mateusz Kowalczyk at 2015-06-14T10:49:01+01:00
Update tests for the CSS changes

- - - - -
2d4983c1 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Create scaffolding for Haskell source parser module.

- - - - -
29548785 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Implement function for tagging parsed chunks with source spans.
- - - - -
6a5e4074 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Implement simple string chunking based on HsColour library.
- - - - -
6e52291f by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Create basic token classification method.
- - - - -
da971a27 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Adapt source span tagging to work with current whitespace handling.
- - - - -
4feb5a22 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add record accessors to exports of hyperlinker parser module.
- - - - -
a8cc4e39 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Make parser module export all types and associated accessors.
- - - - -
fb8d468f by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Create simple HTML renderer for parsed source file.
- - - - -
80747822 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add support for specifying the CSS file path in HTML source renderer.
- - - - -
994dc1f5 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Fix identifier recognition in Haskell source parser.
- - - - -
b1bd0430 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Fix comment recognition in Haskell source parser.
- - - - -
11db85ae by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add support for recognizing compiler pragmas in source parser.
- - - - -
736c7bd3 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Create scaffolding of module for associating tokens with AST names.

- - - - -
7e149bc2 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Implement utility method for extracting variable identifiers from AST.

- - - - -
32eb640a by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Create simple mechanism for associating tokens with AST names.

- - - - -
d4eba5bc by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add dummy support for hyperlinking named tokens.
- - - - -
2b76141f by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Fix span matcher bug causing wrong items being hyperlinked.
- - - - -
2d48002e by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Constrain elements exported by hyperlinker modules.
- - - - -
9715eec6 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add support for type token recognition.
- - - - -
8fa401cb by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Add support for binding token recognition.
- - - - -
d062400b by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Implement go-to-definition mechanism for local bindings.
- - - - -
f4dc229b by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Implement module export- and import-list item hyperlinking.
- - - - -
c9a46d58 by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Fix span matching to allow parenthesized operators hyperlinking.
- - - - -
03aad95a by Łukasz Hanuszczak at 2015-06-30T22:37:48+02:00
Fix weird hyperlinking of parenthesized operators.
- - - - -
b4694a7d by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add support for type declaration anchors.
- - - - -
7358d2d2 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add support for top-level function declaration anchors.
- - - - -
dfc24b24 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Fix external anchors to contain HTML file extension.
- - - - -
a045926c by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Refactor the way AST names are handled within detailed tokens.
- - - - -
c76049b4 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Implement hyperlinking of imported module names.
- - - - -
2d2a1572 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Fix parsing of single line comments with broken up newlines.
- - - - -
11afdcf2 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Fix bug with improper newline handling.
- - - - -
8137f104 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Fix issues with escaped newlines in comments.
- - - - -
34759b19 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add support for parsing C preprocessor macros.
- - - - -
09f0f847 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add some documentation for parser module of source hyperlinker.
- - - - -
709a8389 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add some documentation for AST module of source hyperlinker.
- - - - -
4df5c227 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add command line option for generating hyperlinked source.
- - - - -
7a755ea2 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Extend module interface with rich source token stream field.
- - - - -
494f4ab1 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Implement source tokenization during interface creation process.
- - - - -
5f21c953 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Create hyperlinker module and plug it into the Haddock pipeline.
- - - - -
0cc8a216 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add support for providing custom CSS files for hyperlinked source.
- - - - -
a32bbdc1 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add support for fancy highlighting upon hovering over identifier.
- - - - -
d16d642a by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Make source hyperlinker generate output in apropriate directory.
- - - - -
ae12953d by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Create module with hyperlinker utility functions.
- - - - -
6d4952c5 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Make external hyperlinks point to locations specified by source URLs.
- - - - -
8417555d by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Rewrite source generation to fixed links and directory structure.
- - - - -
ce9cec01 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Add basic support for cross-package hyperlink generation.
- - - - -
7eaf025c by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Disable generating hyperlinks for module references.
- - - - -
a50bf92e by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Make Haddock generate source for all interfaces (also hidden ones).
- - - - -
f5ae2838 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Prevent source parser from throwing exception when lexing fails.
- - - - -
db9ffbe0 by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Implement workaround for Chrome highlighting issues.
- - - - -
0b6b453b by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Make hyperlinker generate correct anchors for data constructors.
- - - - -
c86d38bc by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Make hyperlinker generate anchors for record field declarations.
- - - - -
063abf7f by Łukasz Hanuszczak at 2015-06-30T22:37:49+02:00
Fix issue with hyperlink highlight styling in Chrome browser.
- - - - -
880fc611 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add support for hyperlinking constructor names in patters.
- - - - -
c9e89b95 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add support for hyperlinking field names in record patterns.
- - - - -
17a11996 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add support for hyperlinking field names in record expressions.
- - - - -
0eef932d by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Make hyperlinker respect pretty-printer flag and add documentation.
- - - - -
f87c1776 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Unexpose hyperlinker modules in Cabal configuration.
- - - - -
4c9e2b06 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Setup HSpec framework for Haddock API package.
- - - - -
4b20cb30 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add basic tests related to comment parsing.
- - - - -
6842e919 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add tests related to parsing basic language constructs.

- - - - -
87bffb35 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add simple tests for do-notation parsing.

- - - - -
e7af1841 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add very simple QuickCheck properties for source parser spec.
- - - - -
c84efcf1 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Create simple test runner for hyperlinker tests.
- - - - -
76b90447 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add test case for basic identifier hyperlinking.
- - - - -
0fbf4df6 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add test case for operator hyperlinking.
- - - - -
731aa039 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add test case for constructor hyperlinking.
- - - - -
995a78a2 by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add test case for record expressions and patterns hyperlinking.
- - - - -
3566875a by Łukasz Hanuszczak at 2015-06-30T22:37:50+02:00
Add test case for literal syntax highlighting.
- - - - -
68469a35 by Łukasz Hanuszczak at 2015-06-30T22:38:33+02:00
Add hyperlinker test runner to .cabal and .gitignore files. 
- - - - -
aa946c93 by Łukasz Hanuszczak at 2015-06-30T22:38:33+02:00
Adapt hyperlinker test runner to have the same interface as HTML one.
- - - - -
ce34da16 by Łukasz Hanuszczak at 2015-06-30T22:38:33+02:00
Fix hyperlinker test runner file paths and add pretty-printing option.
- - - - -
0d7dd65e by Łukasz Hanuszczak at 2015-06-30T22:38:33+02:00
Add reference files for hyperlinker test cases.
- - - - -
efa4a1e0 by Łukasz Hanuszczak at 2015-07-01T00:47:32+02:00
Make hyperlinker test runner strip local links from generated source.
- - - - -
3e96e584 by Łukasz Hanuszczak at 2015-07-01T01:14:59+02:00
Create simple script for accepting hyperlinker test case references.
- - - - -
526fe610 by Łukasz Hanuszczak at 2015-07-01T01:16:41+02:00
Re-accept hyperlinker test cases with local references stripped out.
- - - - -
892e2cb3 by Łukasz Hanuszczak at 2015-07-01T01:22:09+02:00
Fix bug with diffing wrong files in hyperlinker test runner.
- - - - -
9ff46039 by Łukasz Hanuszczak at 2015-07-01T18:04:46+02:00
Remove unused dependencies in Haddock API spec configuration.
- - - - -
47969c07 by Łukasz Hanuszczak at 2015-07-01T18:32:19+02:00
Add support for hyperlinking synonyms in patterns.
- - - - -
a73449e0 by Łukasz Hanuszczak at 2015-07-01T18:33:44+02:00
Create test case for hyperlinking @-patterns.
- - - - -
c2077ed8 by Łukasz Hanuszczak at 2015-07-01T19:06:04+02:00
Add support for hyperlinking universally quantified type variables.
- - - - -
68017342 by Łukasz Hanuszczak at 2015-07-01T19:28:32+02:00
Create hyperlinker test case with quantified type variables.
- - - - -
51c01a78 by Łukasz Hanuszczak at 2015-07-01T19:34:22+02:00
Add scoped type variables test for polymorphism test case.
- - - - -
13181ae2 by Łukasz Hanuszczak at 2015-07-01T19:56:27+02:00
Add record wildcards test for records hyperlinking test case.
- - - - -
991b81dd by Łukasz Hanuszczak at 2015-07-01T21:01:42+02:00
Document some functions in XHTML utlity module.
- - - - -
98c8dfe5 by Łukasz Hanuszczak at 2015-07-01T22:25:21+02:00
Make hyperlinker render qualified names as one entity.
- - - - -
75e13b9b by Łukasz Hanuszczak at 2015-07-01T22:27:38+02:00
Add qualified name test for identifiers hyperlinking test case.
- - - - -
de1e143f by Łukasz Hanuszczak at 2015-07-02T12:32:59+02:00
Fix crash happening when hyperlinking type family declarations.
- - - - -
7a8fb175 by Łukasz Hanuszczak at 2015-07-02T12:47:03+02:00
Add support for anchoring data family constructor declarations.
- - - - -
3b404e49 by Łukasz Hanuszczak at 2015-07-02T13:31:05+02:00
Improve support for hyperlinking type families.
- - - - -
59eb7143 by Łukasz Hanuszczak at 2015-07-02T13:33:34+02:00
Add hyperlinker test case for checking type and type family declarations.
- - - - -
d1cda0c0 by Łukasz Hanuszczak at 2015-07-02T13:41:38+02:00
Fix issue with operators being recognized as preprocessor directives.
- - - - -
da206c9d by Łukasz Hanuszczak at 2015-07-02T17:18:12+02:00
Fix broken tests for parsing and hyperlinking hash operators.
- - - - -
53750d1b by Łukasz Hanuszczak at 2015-07-02T18:53:28+02:00
Add support for anchoring signatures in type class declarations.
- - - - -
1fa5bb10 by Łukasz Hanuszczak at 2015-07-02T19:04:47+02:00
Make hyperlinker generate anchors only to top-level value bindings.
- - - - -
a542305c by Łukasz Hanuszczak at 2015-07-02T19:05:58+02:00
Create hyperlinker test case for type classes.
- - - - -
b0dd4581 by Łukasz Hanuszczak at 2015-07-04T16:28:26+02:00
Update docs with information about source hyperlinking.
- - - - -
9795302a by Łukasz Hanuszczak at 2015-07-04T16:52:15+02:00
Update docs on using `--read-interface` option.
- - - - -
9acdc002 by Łukasz Hanuszczak at 2015-07-04T17:15:26+02:00
Remove potentially dangerous record access in hyperlinker AST module.
- - - - -
fb3ab7be by Łukasz Hanuszczak at 2015-07-04T17:40:10+02:00
Make Haddock generate warnings about potential misuse of hyperlinker.
- - - - -
a324c504 by Łukasz Hanuszczak at 2015-07-04T17:43:22+02:00
Fix incorrect specification of source style option in doc file.
- - - - -
3f01a8e4 by Łukasz Hanuszczak at 2015-07-05T17:06:36+02:00
Refactor source path mapping to use modules as indices.
- - - - -
ac70f5b1 by Łukasz Hanuszczak at 2015-07-05T17:47:34+02:00
Fix bug where not all module interfaces were added to source mapping.
- - - - -
f5e57da9 by Łukasz Hanuszczak at 2015-07-06T16:39:57+02:00
Extract main hyperlinker types to separate module.
- - - - -
43974905 by Łukasz Hanuszczak at 2015-07-06T16:52:13+02:00
Move source paths types to hyperlinker types module.
- - - - -
3e236055 by Łukasz Hanuszczak at 2015-07-06T17:06:19+02:00
Add support for hyperlinking modules in import lists.
- - - - -
58233d9f by Łukasz Hanuszczak at 2015-07-06T17:26:49+02:00
Add short documentation for hyperlinker source map type.
- - - - -
14da016d by Łukasz Hanuszczak at 2015-07-06T18:07:20+02:00
Fix bug with module name being hyperlinked to `Prelude`.
- - - - -
8f79db52 by Łukasz Hanuszczak at 2015-07-06T18:23:47+02:00
Fix problem with spec build in Haddock API configuration.
- - - - -
e7cc056c by Adam Sandberg Eriksson at 2015-07-07T23:22:21+01:00
StrictData: print correct strictness marks

- - - - -
e8253ca8 by Mateusz Kowalczyk at 2015-07-07T23:58:28+01:00
Update changelog

- - - - -
0aba676b by Mateusz Kowalczyk at 2015-07-07T23:58:33+01:00
Relax upper bound on GHC a bit

- - - - -
7a595381 by Mateusz Kowalczyk at 2015-07-07T23:58:52+01:00
Delete trailing whitespace

- - - - -
50976d5e by Adam Sandberg Eriksson at 2015-07-08T15:03:04+02:00
StrictData: changes in HsBang type

- - - - -
83b045fa by Mateusz Kowalczyk at 2015-07-11T14:35:18+01:00
Fix expansion icon for user-collapsible sections

Closes haskell/haddock#412

- - - - -
b2a3b0d1 by Mateusz Kowalczyk at 2015-07-22T22:03:21+01:00
Make some version changes after 2.16.1 release

- - - - -
a8294423 by Ben Gamari at 2015-07-27T13:16:07+02:00
Merge pull request haskell/haddock#422 from adamse/adamse-D1033

Merge for GHC D1033
- - - - -
c0173f17 by randen at 2015-07-30T14:49:08-07:00
Break the response file by line termination rather
than spaces, since spaces may be within the parameters.
This simple approach avoids having the need for any
quoting and/or escaping (although a newline char will
not be possible in a parameter and has no escape
mechanism to allow it).

- - - - -
47c0ca14 by Alan Zimmerman at 2015-07-31T10:41:52+02:00
Replace (SourceText,FastString) with WithSourceText data type

Phab:D907 introduced SourceText for a number of data types, by replacing
FastString with (SourceText,FastString). Since this has an Outputable
instance, no warnings are generated when ppr is called on it, but
unexpected output is generated. See Phab:D1096 for an example of this.

Replace the (SourceText,FastString) tuples with a new data type

data WithSourceText = WithSourceText SourceText FastString

Trac ticket: haskell/haddock#10692

- - - - -
45a9d770 by Mateusz Kowalczyk at 2015-07-31T09:47:43+01:00
Update changelog

- - - - -
347a20a3 by Phil Ruffwind at 2015-08-02T23:15:26+01:00
Avoid JavaScript error during page load in non-frame mode

In non-frame mode, parent.window.synopsis refers to the synopsis div
rather than the nonexistent frame.  Unfortunately, the script wrongly
assumes that if it exists it must be a frame, leading to an error where
it tries to access the nonexistent attribute 'replace' of an undefined
value (synopsis.location).

Closes haskell/haddock#406

- - - - -
54ebd519 by Phil Ruffwind at 2015-08-02T23:27:10+01:00
Link to the definitions to themselves

Currently, the definitions already have an anchor tag that allows URLs
with fragment identifiers to locate them, but it is rather inconvenient
to obtain such a URL (so-called "permalink") as it would require finding
the a link to the corresponding item in the Synopsis or elsewhere.  This
commit adds hyperlinks to the definitions themselves, allowing users to
obtain links to them easily.

To preserve the original aesthetics of the definitions, we alter the
color of the link so as to be identical to what it was, except it now
has a hover effect indicating that it is clickable.

Additionally, the anchor now uses the 'id' attribute instead of the
(obsolete) 'name' attribute.

Closes haskell/haddock#407

- - - - -
02cc8bb7 by Phil Ruffwind at 2015-08-02T23:28:02+01:00
Fix typo in Haddock.Backends.Xhtml.Layout: divSynposis -> divSynopsis

Closes haskell/haddock#408

- - - - -
2eb0a458 by Phil Ruffwind at 2015-08-02T23:30:07+01:00
Fix record field alignment when name is too long

Change <dl> to <ul> and use display:table rather than floats to layout
the record fields.  This avoids bug haskell/haddock#301 that occurs whenever the field
name gets too long.

Slight aesthetic change: the entire cell of the field's source code is
now shaded gray rather than just the area where text exists.

Fixes haskell/haddock#301. Closes haskell/haddock#421

- - - - -
7abb3402 by Łukasz Hanuszczak at 2015-08-02T23:32:14+01:00
Add some utility definitions for generating line anchors.

- - - - -
e0b1d79b by Łukasz Hanuszczak at 2015-08-02T23:32:15+01:00
Make hyperlinked source renderer generate line anchors.
- - - - -
24dd4c9f by Łukasz Hanuszczak at 2015-08-02T23:32:15+01:00
Re-accept test cases after adding line anchors for each of them.
- - - - -
0372cfcb by Łukasz Hanuszczak at 2015-08-02T23:32:15+01:00
Override source line flags when source hyperlinker is enabled.
- - - - -
a81bcd07 by Mateusz Kowalczyk at 2015-08-02T23:58:25+01:00
Update tests to follow HTML changes

- - - - -
d2d7426f by Łukasz Hanuszczak at 2015-08-06T20:54:59+02:00
Fix quote syntax for promoted types.
- - - - -
668cf029 by Łukasz Hanuszczak at 2015-08-06T21:12:00+02:00
Apply promoted type quoting to type-level consing.
- - - - -
89f8e7c6 by Łukasz Hanuszczak at 2015-08-06T21:17:10+02:00
Extend advanced types test case with other examples.
- - - - -
86494bca by Łukasz Hanuszczak at 2015-08-06T21:22:06+02:00
Rename advanced types test case and accept new output.
- - - - -
dbb7c7c0 by Adam Sandberg Eriksson at 2015-08-09T23:01:05+02:00
HsBang is split into HsSrcBang and HsImplBang

With recent changes in GHC handling of strictness annotations in Haddock
is simplified.

- - - - -
2a7704fa by Ben Gamari at 2015-08-10T13:18:05+02:00
Merge pull request haskell/haddock#433 from adamse/split-hsbang

HsBang is split into HsSrcBang and HsImplBang
- - - - -
891954bc by Thomas Miedema at 2015-08-15T14:51:18+02:00
Follow changes in GHC build system

- - - - -
b55d32ab by Mateusz Kowalczyk at 2015-08-21T18:06:09+01:00
Make Travis use 7.10.2

- - - - -
97348b51 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Move SYB utilities to standalone module.
- - - - -
748ec081 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Implement `everywhere` transformation in SYB module.
- - - - -
011cc543 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Implement generic transformation constructor.
- - - - -
b9510db2 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Create simple utility module for type specialization.
- - - - -
43229fa6 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Make type of type specialization function more general.
- - - - -
fd844e90 by Łukasz Hanuszczak at 2015-08-21T18:22:29+01:00
Add basic HTML test case for checking instance specialization.
- - - - -
6ea0ad04 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Make HTML class instance printer take optional signature argument.
- - - - -
65aa41b6 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Refactor instance head type to record instead of a meaningless tuple.
- - - - -
3fc3bede by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Add expandable method section for each class instance declaration.
- - - - -
99ceb107 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Move dummy post-family instances for `DocName` to `Types` module.
- - - - -
e98f4708 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Create convenience functions for type specialization module.
- - - - -
b947552f by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Hook type specialization logic with HTML pretty-printer.
- - - - -
dcaa8030 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Create stub functions for sugaring specialized types.
- - - - -
fa84bc65 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Implement list syntax sugaring logic for specialized types.
- - - - -
e8b05b07 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Implement tuple syntax sugaring logic for specialized types.
- - - - -
68a2e5bc by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Get rid of code duplication in type specialization module.
- - - - -
4721c336 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Create scaffolding of a framework for renaming specialized types.
- - - - -
271b488d by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Fill in missing cases in specialized type renaming function.
- - - - -
bfa5f2a4 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Remove code duplication in specialized type renamer.
- - - - -
ea6bd0e8 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Change state of the type renaming monad.
- - - - -
77c5496e by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Implement simple mechanism for generating new type names.
- - - - -
91bfb48b by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Fill in stub behaviour with actual environment renaming.
- - - - -
d244517b by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Fix logic behind binder type renaming.
- - - - -
f3c5e360 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Add SYB-like utility function for performing stateful queries.
- - - - -
eb3f9154 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Create function for retrieving free variables from given type.
- - - - -
a94561d3 by Łukasz Hanuszczak at 2015-08-21T18:22:30+01:00
Fix compilation error caused by incorrect type signature.
- - - - -
8bb707cf by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Move `SetName` class definition to types module.
- - - - -
5800b13b by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Hook type renamer with instance method HTML pretty-printer.
- - - - -
6a480164 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Add some test cases for type renamer.
- - - - -
839842f7 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Make specialized signatures refer to original signature declaration.
- - - - -
4880f7c9 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Make specialized methods be nicely formatted again.
- - - - -
ab5a6a2e by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Attach source locations to the specialized class methods.
- - - - -
43f8a559 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Extend instances test case to also test multi-name type signatures.
- - - - -
59bc751c by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Fix tab-based indentation in instances test case.
- - - - -
c2126815 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Improve placement of instance methods expander button.
- - - - -
0a32e287 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Add new data type declaration to instance specialization test case. 
- - - - -
5281af1f by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Make type renamer first try single-letter names as  alternatives.
- - - - -
7d509475 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Fix type renamer bug with incorrect names being generated.
- - - - -
0f35bf7c by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Add some documentation and refactor type specialization module.
- - - - -
da1d0803 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Fix another bug where type renamer was generating incorrect names.
- - - - -
cd39b5cb by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Refactor type renamer to rebinding and pure renaming phases.
- - - - -
850251f4 by Łukasz Hanuszczak at 2015-08-21T18:22:31+01:00
Fix unwitting compilation bug.
- - - - -
e5e9fc01 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Integrate instance specification type into class instance definition.
- - - - -
825b0ea0 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Get rid of no longer neccessary instance specification type.
- - - - -
cdba44eb by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Fix declaration converter to use more appropriate mode for methods.
- - - - -
bc45c309 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Fix bug with types not being specialized at all.
- - - - -
5d8e5d89 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Fix bug where instance expander was opening wrong section.
- - - - -
6001ee41 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Fix another type renamer bug where not all names were rebound.
- - - - -
5f58ce2a by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Fix yet another renamer bug where some names were not unique.
- - - - -
8265e521 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Split instance subsection layout method to top-level declarations.
- - - - -
e5e66298 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Rearrange layout of instance methods in generated documentation.
- - - - -
a50b4eea by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Get rid of no longer used layout method.
- - - - -
2ff36ec2 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Attach section title to the instance methods block.
- - - - -
7ac15300 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Add basic tests for associated types in instances test case.
- - - - -
db0ea2f9 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Attach associated types information to instance header.
- - - - -
71cad4d5 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Make instance details section contain associated types information.
- - - - -
deee2809 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Improve look of rendered associated families in instance details.
- - - - -
839d13a5 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Introduce alternative type for family declarations.
- - - - -
d397f03f by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Make instance details record use new type for family declarations.
- - - - -
2b23fe97 by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Split printer of type family header to separate functions.
- - - - -
c3498cdc by Łukasz Hanuszczak at 2015-08-21T18:22:32+01:00
Implement HTML renderer for pseudo-family declarations.
- - - - -
c12bbb04 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Apply type specializer to associated type family declarations. 
- - - - -
2fd69ff2 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Create helper method for specializing type signatures.
- - - - -
475826e7 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Refactor specializer module to be independent from XHTML backend.
- - - - -
f00b431c by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Add some documentation for instance head specializer.
- - - - -
a9fef2dc by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Fix bug with missing space in documentation for associated types.
- - - - -
50e29056 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Fix issue with incorrect instance details sections being expanded.
- - - - -
e6dfdd03 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Accept tests affected by adding instance details section.
- - - - -
75565b2a by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Make section identifier of instance details more GHC-independent.
- - - - -
add0c23e by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Re-accept tests after applying deterministic section identifiers.
- - - - -
878f2534 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Make identifier generation also architecture-independent.
- - - - -
48be69f8 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Fix issue with instance expander hijacking type hyperlink click.
- - - - -
47830c1f by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Get rid of dreadful hashing function for generating identifiers.
- - - - -
956cd5af by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Move `InstOrigin` type declaration to more appropriate module.
- - - - -
bf672ed3 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Accept tests affected by changes related to instance expander.
- - - - -
8f2a949a by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Add examples with type operators to the instances test case.
- - - - -
64600a84 by Łukasz Hanuszczak at 2015-08-21T18:22:33+01:00
Add basic support for sugaring infix type operators.
- - - - -
747d71b8 by Łukasz Hanuszczak at 2015-08-21T18:22:34+01:00
Add support for sugaring built-in function syntax.
- - - - -
d4696ffb by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Remove default methods from Hoogle class output.
- - - - -
bf0e09d7 by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Add fixity declarations in Hoogle backend output.
- - - - -
90e91a51 by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Fix bug with incorrect fixities being generated in Hoogle backend.
- - - - -
48f11d35 by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Improve class type family declarations output in Hoogle backend.
- - - - -
661e8e8f by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Add missing default family equations in Hoogle output.
- - - - -
e2d64103 by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Improve formatting of class details output in Hoogle backend.
- - - - -
490fc377 by Łukasz Hanuszczak at 2015-08-21T18:31:31+01:00
Fix weird-looking Hoogle output for familyless classes.
- - - - -
ea115b64 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Create script file for new HTML test runner.
- - - - -
609913d3 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Set default behaviour if no arguments given.
- - - - -
dc115f67 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Add support for providing optional arguments for test runner.
- - - - -
d93ec867 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Improve output of test runner error messages.
- - - - -
0be9fe12 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Add support for executing Haddock process in test runner.
- - - - -
4e4d00d9 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Add GHC path to test runner configuration.
- - - - -
d67a2086 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Make GHC path a test runner command-line argument.
- - - - -
c810079a by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Extend test runner configuration with Haddock arguments.
- - - - -
fee18845 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Refactor test runner and create stub functions.
- - - - -
ff7c161f by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Make test runner actually run Haddock executable.
- - - - -
391f73e6 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Fix bug with test runner not producing any output files.
- - - - -
81a74e2d by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Setup skeleton of framework for running tests.
- - - - -
f8a79ec4 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Fix bug with modules not being found in global search mode.
- - - - -
7e700b4d by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Make Haddock standard output redirection be more configurable.
- - - - -
53b4c17a by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Incorporate old, ugly functions for comparing output files.
- - - - -
8277c8aa by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Refactor architecture of test runner output checking functions.
- - - - -
587bb414 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Implement actual diffing mechanism.
- - - - -
9ed2b5e4 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Improve code style to match popular guidelines.
- - - - -
14bffaf8 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Make it possible to choose alternative diff tool.
- - - - -
5cdfb005 by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Create stub methods for processing test output as XML documents.
- - - - -
7ef8e12e by Łukasz Hanuszczak at 2015-08-22T23:40:26+02:00
Implement link-stripping logic as simple SYB transformation.
- - - - -
8a1fcd4f by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Incorporate link stripping to output diffing mechanism.
- - - - -
37dba2bc by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Implement footer-stripping logic.
- - - - -
9cd52120 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Add missing dependencies in Cabal configuration file.
- - - - -
e0f83c6e by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Fix issue with output being printed in incorrect order.
- - - - -
0a94fbb0 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Make it possible to run tests without generating diff.
- - - - -
76a58c6f by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Refactor HTML test suite boilerplate to external package.
- - - - -
af41e6b0 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Create utilities for storing directory configuration.
- - - - -
d8f0698f by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Move IO-dependent config of HTML test suite to test package.
- - - - -
17369fa0 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Enable all compiler warnings in Haddock test package configuration.
- - - - -
9d03b47a by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Move Haddock runner of HTML test suite to Haddock test package.
- - - - -
4b3483c5 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Make Haddock test package more generic.
- - - - -
03754194 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Create convenience wrappers to simplify in test entry points.
- - - - -
27476ab7 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Adjust module visibility and items they export.
- - - - -
c40002ba by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Remove no longer useful test option.
- - - - -
55ab2541 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Change extension of test files used for diffing.
- - - - -
136bf4e4 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Refactor and simplify XHTML helper module of test package.
- - - - -
69f7e3df by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Fix typo in link stripper of HTML test suite runner.
- - - - -
0c3c1c6b by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Create convenience script for running specific HTML tests.
- - - - -
489e1b05 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Implement utility functions for conditional link stripping.
- - - - -
0f985dc3 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Adapt `hypsrc-test` module to work with new testing framework.
- - - - -
927406f9 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Implement output accepting mechanism in test package.
- - - - -
8545715e by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Create utility function for recursive obtaining directory contents.
- - - - -
cb70381f by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Make Haddock test package more generic.
- - - - -
019599b5 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Fix path handling in test runner.
- - - - -
399b985b by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Make it possible to specify ignored files for test output.
- - - - -
41b3d93d by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Adapt HTML test runner to use new ignoring functionality.
- - - - -
e2091c8b by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Fix bug with not all test output files being checked.
- - - - -
b22134f9 by Łukasz Hanuszczak at 2015-08-22T23:40:27+02:00
Specify ignored files for hyperlinker source test runner.
- - - - -
3301dfa1 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Copy test runner script for hyperlinked source case.
- - - - -
d39a6dfa by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Fix bug with test runner invoking Haddock in incorrect mode.
- - - - -
f32c8ff3 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Fix path handling in test module loader.
- - - - -
10f94ee9 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Make test runner ignore test packages with no modules.
- - - - -
5dc4239c by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Create test runner entry points for LaTeX test suite.
- - - - -
58d1f7cf by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Fix bug with unnecessary checking old test output.
- - - - -
c7ce76e1 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Re-implement test acceptance functionality.
- - - - -
13bbabe8 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Fix warning about no longer needed definition.
- - - - -
958a99b8 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Adapt Cabal configuration to execute LaTeX suite with new runner.
- - - - -
550ff663 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Setup test suite for Hoogle backend.
- - - - -
3aa969c4 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Make Hoogle backend create output directory if needed.
- - - - -
eb085b02 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Add appropriate .gitignore entry and configure Hoogle test suite.
- - - - -
a50bf915 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Fix bug with test runner failing when run on multiple test packages.
- - - - -
bf5368b8 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Create simple test cases for Hoogle backend.
- - - - -
6121ba4b by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Create helper function for conversion between XML and XHTML.
- - - - -
cb516061 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Refactor existing code to use XHTML printer instead of XML one.
- - - - -
e2de8c82 by Łukasz Hanuszczak at 2015-08-22T23:40:28+02:00
Improve portability of test runner scripts.
- - - - -
9563e774 by Łukasz Hanuszczak at 2015-08-22T23:43:16+02:00
Remove redundant import statement.
- - - - -
55353df1 by Łukasz Hanuszczak at 2015-08-24T23:09:20+02:00
Fix bug with accepting to non-existing directory.
- - - - -
00a334ca by Łukasz Hanuszczak at 2015-08-24T23:09:47+02:00
Accept output for Hoogle and LaTeX backends.
- - - - -
29191d8b by Łukasz Hanuszczak at 2015-08-24T23:14:18+02:00
Get rid of obsolete testing utilities.
- - - - -
bbb25db3 by Łukasz Hanuszczak at 2015-08-24T23:18:50+02:00
Update sandbox setup guide to work with Haddock test package.
- - - - -
cfd45248 by Łukasz Hanuszczak at 2015-08-24T23:51:30+02:00
Make Travis aware of Haddock test package.
- - - - -
74185b7a by Łukasz Hanuszczak at 2015-08-25T17:41:59+02:00
Fix test suite failure when used with Stack.
- - - - -
18769697 by Łukasz Hanuszczak at 2015-08-25T18:02:09+02:00
Add sample Stack setup to the hacking guide.

- - - - -
22715eeb by Łukasz Hanuszczak at 2015-08-25T18:04:47+02:00
Fix Markdown formatting of README file.
- - - - -
b49ec386 by Łukasz Hanuszczak at 2015-08-25T18:13:36+02:00
Setup Haddock executable path in Travis configuration.
- - - - -
5d29eb03 by Eric Seidel at 2015-08-30T09:55:58-07:00
account for changes to ipClass

- - - - -
f111740a by Ben Gamari at 2015-09-02T13:20:37+02:00
Merge pull request haskell/haddock#443 from bgamari/ghc-head

account for changes to ipClass
- - - - -
a2654bf6 by Jan Stolarek at 2015-09-03T01:32:57+02:00
Follow changes from haskell/haddock#6018

- - - - -
2678bafe by Richard Eisenberg at 2015-09-21T12:00:47-04:00
React to refactoring CoAxiom branch lists.

- - - - -
ebc56e24 by Edward Z. Yang at 2015-09-21T11:53:46-07:00
Track msHsFilePath change.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
4a8c4198 by Tamar Christina at 2015-09-27T13:59:08+02:00
Create Process: removed PhaseFailed

- - - - -
7e99b790 by Oleg Grenrus at 2015-09-27T20:52:10+03:00
Generate docs for orphan instances

- - - - -
32e932e2 by Oleg Grenrus at 2015-09-28T07:21:11+03:00
Have source links for orphan instances

- - - - -
c2eb9f4f by Oleg Grenrus at 2015-09-28T07:24:58+03:00
Print orphan instances header only if required

- - - - -
ff96f978 by Oleg Grenrus at 2015-09-28T07:40:54+03:00
Add orphan instances link to contents box

- - - - -
d72490a6 by Oleg Grenrus at 2015-09-28T16:37:44+03:00
Fix orphan instance collapsing

- - - - -
25d3dfe5 by Ben Gamari at 2015-10-03T12:38:09+02:00
Merge pull request haskell/haddock#448 from Mistuke/fix-silent-death-of-runInteractive

Remove PhaseFailed
- - - - -
1e45e43b by Edward Z. Yang at 2015-10-11T13:10:10-07:00
s/PackageKey/UnitId/g and s/packageKey/unitId/g

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
b1370ac1 by Adam Gundry at 2015-10-16T16:26:42+01:00
Roughly fix up haddock for DuplicateRecordFields changes

This compiles, but will probably need more work to produce good
documentation when the DuplicateRecordFields extension is used.

- - - - -
60bef421 by Simon Peyton Jones at 2015-10-26T12:52:36+00:00
Track wip/spj-wildcard-refactor on main repo

- - - - -
4c1898ca by Simon Peyton Jones at 2015-10-27T14:24:56+00:00
Track change to PatSyn.patSynSig

- - - - -
25108e85 by Simon Peyton Jones at 2015-10-27T17:34:18+00:00
Follow changes to HsTYpe

Not yet complete (but on a wip/ branch)

- - - - -
693643ac by Ben Gamari at 2015-10-28T14:33:06+01:00
Account for Typeable changes

The treatment of type families changed.

- - - - -
cd7c2221 by Simon Peyton Jones at 2015-10-30T13:03:51+00:00
Work on updating Haddock to wip/spj-wildard-recactor

Still incomplete

- - - - -
712032cb by Herbert Valerio Riedel at 2015-10-31T11:01:45+01:00
Relax upper bound on `base` to allow base-4.9

- - - - -
0bfa0475 by Simon Peyton Jones at 2015-10-31T19:08:13+00:00
More adaption to wildcard-refactor

- - - - -
0a3c0cb7 by Simon Peyton Jones at 2015-10-31T22:14:43+00:00
Merge remote-tracking branch 'origin/ghc-head' into wip/spj-wildcard-refactor

Conflicts:
	haddock-api/src/Haddock/Convert.hs

- - - - -
c4fd4ec9 by Alan Zimmerman at 2015-11-01T11:16:34+01:00
Matching change GHC haskell/haddock#11017 BooleanFormula located

- - - - -
42cdd882 by Matthew Pickering at 2015-11-06T20:02:16+00:00
Change for IEThingWith

- - - - -
f368b7be by Ben Gamari at 2015-11-11T11:35:51+01:00
Eliminate support for deprecated GADT syntax

Follows from GHC D1460.

- - - - -
e32965b8 by Simon Peyton Jones at 2015-11-13T12:18:17+00:00
Merge with origin/head

- - - - -
ebcf795a by Edward Z. Yang at 2015-11-13T21:56:27-08:00
Undo msHsFilePath change.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
4e23989f by Simon Peyton Jones at 2015-11-18T11:32:54+00:00
Wibbles to Haddock

- - - - -
2289cd4a by Simon Peyton Jones at 2015-11-20T23:12:49+00:00
Merge remote-tracking branch 'origin/ghc-head' into wip/spj-wildcard-refactor

- - - - -
695975a6 by Alan Zimmerman at 2015-11-21T21:16:12+02:00
Update to match GHC wip/T11019

- - - - -
bbba21e7 by Simon Peyton Jones at 2015-11-23T13:54:31+00:00
merge with origin/ghc-head

- - - - -
3d664258 by Simon Peyton Jones at 2015-11-23T17:17:18+00:00
Wibble

- - - - -
e64cf586 by Herbert Valerio Riedel at 2015-12-05T00:29:55+01:00
Canonicalise Monad instances

- - - - -
a2de15a7 by Alan Zimmerman at 2015-12-05T17:33:52+02:00
Matching changes for haskell/haddock#11028

- - - - -
cc29a3e4 by Alan Zimmerman at 2015-12-05T19:45:33+02:00
Placeholder for record style GADT declaration

A GADT Declaration is now presented as

    CmmCondBranch :: {..} -> CmmNode O C
        cml_pred :: CmmExpr
        cml_true, cml_false :: !Label
        cml_likely :: Maybe Bool
for

    CmmCondBranch :: {              -- conditional branch
        cml_pred :: CmmExpr,
        cml_true, cml_false :: ULabel,
        cml_likely :: Maybe Bool    -- likely result of the conditional,
                                    -- if known
    } -> CmmNode O C

- - - - -
95dd15d1 by Richard Eisenberg at 2015-12-11T17:33:39-06:00
Update for type=kinds

- - - - -
cb5fd9ed by Herbert Valerio Riedel at 2015-12-14T15:07:30+00:00
Bump versions for ghc-7.11

- - - - -
4f286d96 by Simon Peyton Jones at 2015-12-14T15:10:56+00:00
Eliminate instanceHead' in favour of GHC's instanceSig

This is made possible by the elimination of "silent superclass
parameters" in GHC

- - - - -
13ea2733 by Simon Peyton Jones at 2015-12-14T15:10:58+00:00
Remove redundant constraints from haddock, discovered by -fwarn-redundant-constraints

- - - - -
098df8b8 by Simon Peyton Jones at 2015-12-14T15:10:58+00:00
Track changes in HsSyn for quasi-quotes

- - - - -
716a64de by Simon Peyton Jones at 2015-12-14T15:10:58+00:00
Track change in API of TyCon

- - - - -
77a66bca by Adam Gundry at 2015-12-14T15:10:58+00:00
Track API changes to support empty closed type familes

- - - - -
f2808305 by Simon Peyton Jones at 2015-12-14T15:10:58+00:00
Track the new location of setRdrNameSpace

- - - - -
ba8b08a4 by Alan Zimmerman at 2015-12-14T15:10:59+00:00
ApiAnnotations : strings in warnings do not return SourceText

The strings used in a WARNING pragma are captured via

strings :: { Located ([AddAnn],[Located FastString]) }
    : STRING { sL1 $1 ([],[L (gl $1) (getSTRING $1)]) }
..

The STRING token has a method getSTRINGs that returns the original
source text for a string.

A warning of the form

{-# WARNING Logic
          , mkSolver
          , mkSimpleSolver
          , mkSolverForLogic
          , solverSetParams
          , solverPush
          , solverPop
          , solverReset
          , solverGetNumScopes
          , solverAssertCnstr
          , solverAssertAndTrack
          , solverCheck
          , solverCheckAndGetModel
          , solverGetReasonUnknown
          "New Z3 API support is still incomplete and fragile: \
          \you may experience segmentation faults!"
  #-}

returns the concatenated warning string rather than the original source.

- - - - -
a4ded87e by Thomas Winant at 2015-12-14T15:14:05+00:00
Update after wild card renaming refactoring in D613

Summary:
* Move `Post*` type instances to `Haddock.Types` as other modules than
  `Haddock.Interface.Rename` will rely on these type instances.
* Update after wild card renaming refactoring in D613.

Reviewers: simonpj, austin

Reviewed By: austin

Differential Revision: https://phabricator.haskell.org/D954

GHC Trac Issues: haskell/haddock#10098

- - - - -
25c78107 by Adam Sandberg Eriksson at 2015-12-14T15:14:06+00:00
StrictData: print correct strictness marks

- - - - -
6cbc41c4 by Adam Sandberg Eriksson at 2015-12-14T15:14:06+00:00
StrictData: changes in HsBang type

- - - - -
ad46821a by Alan Zimmerman at 2015-12-14T15:14:06+00:00
Replace (SourceText,FastString) with WithSourceText data type

Phab:D907 introduced SourceText for a number of data types, by replacing
FastString with (SourceText,FastString). Since this has an Outputable
instance, no warnings are generated when ppr is called on it, but
unexpected output is generated. See Phab:D1096 for an example of this.

Replace the (SourceText,FastString) tuples with a new data type

data WithSourceText = WithSourceText SourceText FastString

Trac ticket: haskell/haddock#10692

- - - - -
abc0ae5b by Adam Sandberg Eriksson at 2015-12-14T15:14:06+00:00
HsBang is split into HsSrcBang and HsImplBang

With recent changes in GHC handling of strictness annotations in Haddock
is simplified.

- - - - -
3308d06c by Thomas Miedema at 2015-12-14T15:14:07+00:00
Follow changes in GHC build system

- - - - -
6c763deb by Eric Seidel at 2015-12-14T15:14:07+00:00
account for changes to ipClass

- - - - -
ae5b4eac by Jan Stolarek at 2015-12-14T15:17:00+00:00
Follow changes from haskell/haddock#6018

- - - - -
ffbc40e0 by Richard Eisenberg at 2015-12-14T15:17:02+00:00
React to refactoring CoAxiom branch lists.

- - - - -
d1f531e9 by Edward Z. Yang at 2015-12-14T15:17:02+00:00
Track msHsFilePath change.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
79f73754 by Tamar Christina at 2015-12-14T15:17:02+00:00
Create Process: removed PhaseFailed

- - - - -
3d37bebb by Edward Z. Yang at 2015-12-14T15:20:46+00:00
s/PackageKey/UnitId/g and s/packageKey/unitId/g

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
5f8a9e44 by Adam Gundry at 2015-12-14T15:20:48+00:00
Roughly fix up haddock for DuplicateRecordFields changes

This compiles, but will probably need more work to produce good
documentation when the DuplicateRecordFields extension is used.

- - - - -
79dda70f by Simon Peyton Jones at 2015-12-14T15:26:02+00:00
Track wip/spj-wildcard-refactor on main repo

- - - - -
959930fb by Simon Peyton Jones at 2015-12-14T15:37:50+00:00
Follow changes to HsTYpe

Not yet complete (but on a wip/ branch)

- - - - -
e18a8df5 by Simon Peyton Jones at 2015-12-14T15:37:52+00:00
Work on updating Haddock to wip/spj-wildard-recactor

Still incomplete

- - - - -
aa35ab52 by Simon Peyton Jones at 2015-12-14T15:40:18+00:00
More adaption to wildcard-refactor

- - - - -
8ceef94b by Simon Peyton Jones at 2015-12-14T15:46:04+00:00
Track change to PatSyn.patSynSig

- - - - -
cd81e83d by Ben Gamari at 2015-12-14T15:46:06+00:00
Account for Typeable changes

The treatment of type families changed.

- - - - -
63c9117c by Herbert Valerio Riedel at 2015-12-14T15:46:34+00:00
Relax upper bound on `base` to allow base-4.9

- - - - -
a484c613 by Alan Zimmerman at 2015-12-14T15:47:46+00:00
Matching change GHC haskell/haddock#11017 BooleanFormula located

- - - - -
2c26fa51 by Matthew Pickering at 2015-12-14T15:47:47+00:00
Change for IEThingWith

- - - - -
593baa0f by Ben Gamari at 2015-12-14T15:49:21+00:00
Eliminate support for deprecated GADT syntax

Follows from GHC D1460.

- - - - -
b6b5ca78 by Edward Z. Yang at 2015-12-14T15:49:54+00:00
Undo msHsFilePath change.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
b5b0e072 by Alan Zimmerman at 2015-12-14T15:54:20+00:00
Update to match GHC wip/T11019

- - - - -
14ddeb68 by Simon Peyton Jones at 2015-12-14T15:54:22+00:00
Wibble

- - - - -
10a90ad8 by Herbert Valerio Riedel at 2015-12-14T15:54:22+00:00
Canonicalise Monad instances

- - - - -
ed68ac50 by Alan Zimmerman at 2015-12-14T15:55:48+00:00
Matching changes for haskell/haddock#11028

- - - - -
3f7e5a2d by Alan Zimmerman at 2015-12-14T15:55:49+00:00
Placeholder for record style GADT declaration

A GADT Declaration is now presented as

    CmmCondBranch :: {..} -> CmmNode O C
        cml_pred :: CmmExpr
        cml_true, cml_false :: !Label
        cml_likely :: Maybe Bool
for

    CmmCondBranch :: {              -- conditional branch
        cml_pred :: CmmExpr,
        cml_true, cml_false :: ULabel,
        cml_likely :: Maybe Bool    -- likely result of the conditional,
                                    -- if known
    } -> CmmNode O C

- - - - -
6543a73f by Richard Eisenberg at 2015-12-14T15:59:55+00:00
Update for type=kinds

- - - - -
193a5c48 by Matthew Pickering at 2015-12-14T18:17:00+00:00
Changes to compile with 8.0

- - - - -
add669ec by Matthew Pickering at 2015-12-14T18:47:12+00:00
Warnings

- - - - -
223f3fb4 by Ben Gamari at 2015-12-15T23:45:05+01:00
Update for D1200

- - - - -
d058388f by Ben Gamari at 2015-12-16T05:40:17-05:00
Types: Add Outputable[Bndr] DocName instances

- - - - -
62ecd7fb by Ben Gamari at 2015-12-16T09:23:09-05:00
Fix fallout from wildcards refactoring

The wildcard refactoring was introduced a new type of signature,
`ClassOpSig`, which is carried by typeclasses. The original patch
adapting Haddock for this change missed a few places where this
constructor needed to be handled, resulting in no class methods
in documentation produced by Haddock.

Additionally, this moves and renames the `isVanillaLSig` helper from
GHC's HsBinds module into GhcUtils, since it is only used by Haddock.

- - - - -
ddbc187a by Ben Gamari at 2015-12-16T17:54:55+01:00
Update for D1200

- - - - -
cec83b52 by Ben Gamari at 2015-12-16T17:54:55+01:00
Types: Add Outputable[Bndr] DocName instances

- - - - -
d12ecc98 by Ben Gamari at 2015-12-16T17:54:55+01:00
Fix fallout from wildcards refactoring

The wildcard refactoring was introduced a new type of signature,
`ClassOpSig`, which is carried by typeclasses. The original patch
adapting Haddock for this change missed a few places where this
constructor needed to be handled, resulting in no class methods
in documentation produced by Haddock.

Additionally, this moves and renames the `isVanillaLSig` helper from
GHC's HsBinds module into GhcUtils, since it is only used by Haddock.

- - - - -
ada1616f by Ben Gamari at 2015-12-16T17:54:58+01:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
a4f0383d by Ben Gamari at 2015-12-16T23:32:38+01:00
Fix Hyperlinker

GHC.con_names is now GHC.getConNames

- - - - -
a10e6849 by Ben Gamari at 2015-12-20T00:54:11+01:00
Merge remote-tracking branch 'mrhania/testing-framework-improvements' into ghc-head

- - - - -
f078b4fd by Ben Gamari at 2015-12-20T00:59:51+01:00
test: Compatibility with Cabal 1.23

- - - - -
88a511a9 by Ben Gamari at 2015-12-20T01:14:35+01:00
Merge remote-tracking branch 'phadej/orphans' into ghc-head

- - - - -
4e250f36 by Ben Gamari at 2015-12-20T01:14:52+01:00
Add html-test for orphan instances output

- - - - -
87fffbad by Alan Zimmerman at 2015-12-20T09:50:42+02:00
Update for GHC trac#11258

Adding locations to RdrName in FieldOcc and AmbiguousFieldOcc

- - - - -
6b7e51c9 by idontgetoutmuch at 2015-12-20T21:01:47+00:00
Merge pull request haskell/haddock#1 from haskell/ghc-head

Ghc head
- - - - -
229c1fb5 by Dominic Steinitz at 2015-12-21T07:19:16+00:00
Handle inline math with mathjax.

- - - - -
57902d66 by Dominic Steinitz at 2015-12-21T08:07:11+00:00
Fix the documentation for haddock itself.

Change notation and add support for inline math.

Allow newlines in display math.

Add a command line option for the mathjax url (you might want to use a
locally installed version).

Rebase tests because of extra url and version change.

Respond to (some of the) comments.

Fix warnings in InterfaceFile.hs

- - - - -
0e69f236 by Herbert Valerio Riedel at 2015-12-21T18:30:43+01:00
Fix-up left-over assumptions of GHC 7.12 into GHC 8.0

- - - - -
c67f8444 by Simon Peyton Jones at 2015-12-22T16:26:56+00:00
Follow removal of NamedWildCard from HsType

- - - - -
da40327a by Ben Gamari at 2015-12-23T14:15:28+01:00
html-test/Operators: Clear up ambiguous types

For reasons that aren't entirely clear a class with ambiguous types was
accepted by GHC <8.0. I've added a functional dependency to clear up
this ambiguity.

- - - - -
541b7fa4 by Ben Gamari at 2015-12-23T14:18:51+01:00
Merge remote-tracking branch 'origin/ghc-head' into ghc-head

- - - - -
0febc947 by Ben Gamari at 2015-12-24T00:30:20+01:00
hoogle-test/AssocTypes: Allow AmbiguousTypes

GHC 8.0 complains otherwise

- - - - -
25810841 by Ben Gamari at 2015-12-24T00:33:18+01:00
OrphanInstances: Accept test output

- - - - -
841987f3 by Ben Gamari at 2015-12-25T11:03:11+01:00
Merge remote-tracking branch 'idontgetoutmuch/ghc-head' into ghc-head

- - - - -
358391f0 by Ben Gamari at 2015-12-26T10:44:50+01:00
Add missing import

- - - - -
a8896885 by Ben Gamari at 2015-12-26T10:45:27+01:00
travis: Use Travis containers

- - - - -
85e82134 by Herbert Valerio Riedel at 2015-12-30T17:25:39+01:00
tweak version bounds for GHC-8.1

- - - - -
672a5f75 by randen at 2016-01-01T23:45:25-08:00
The Haddock part for fully gcc-like response files

" driver/Main.hs
  * Moved the response file handling into ResponseFile.hs,
    updating import section as appropriate.
* driver/ResponseFile.hs
  * New file. In anticipation that maybe some day this could
    be provided by another library, and to make it possible
    to unit test, this functionality is pulled out of the
    Main.hs module, and expanded to support the style/format
    of response files which gcc uses.
  * The specification for the format of response files which
    gcc generates and consumes, seems to be best derived from
    the gcc code itself (libiberty/argv.c), so that is what
    has been done here.
  * This is intended to fix haskell/haddock#379
* driver-test/Main.hs
  * New file for testing code in the driver source tree
* driver-test/ResponseFileSpec.hs
  * Tests, adapted/adopted from the same gcc code where the
    escaping/unescaping is from, in the hspec style of unit
    tests
* haddock.cabal
  * Add the driver-test test-suite.  Introduces a new library
    dependency (upon hspec) for the haddock driver target in
    the haddock.cabal file, but practically, this should not
    be a problem as the haddock-api tests already depend on
    hspec.

- - - - -
498781df by Ben Gamari at 2016-01-06T13:41:04+01:00
Version bumps and changelog

- - - - -
8451e46a by Ben Gamari at 2016-01-06T13:47:17+01:00
Merge remote-tracking branch 'randen/bug468'

- - - - -
fb2d9181 by Ben Gamari at 2016-01-06T08:14:42-05:00
Add ResponseFile to OtherModules

- - - - -
2cb2d2e3 by Ben Gamari at 2016-01-06T14:35:00+01:00
Merge branch 'master' into ghc-head

- - - - -
913477d4 by Eric Seidel at 2016-01-11T14:57:57-08:00
deal with un-wiring of IP class

- - - - -
c557a4b3 by Alan Zimmerman at 2016-01-15T11:14:35+02:00
Update to match wip/T11430 in GHC

- - - - -
3e135093 by Alan Zimmerman at 2016-01-16T18:21:59+01:00
Update to match wip/T11430 in GHC

- - - - -
c48ef2f9 by Ben Gamari at 2016-01-18T09:50:06+01:00
Merge remote-tracking branch 'gridaphobe/ghc-head' into ghc-head

- - - - -
9138a1b0 by Eric Seidel at 2016-01-18T12:50:15+01:00
deal with un-wiring of IP class

(cherry picked from commit 17388b0f0029d969d79353be7737eb01c7b8dc5f)

- - - - -
b48c172e by Joachim Breitner at 2016-01-19T00:11:38+01:00
Make sure --mathjax affects all written HTML files

This fixes haskell/haddock#475.

- - - - -
af61fe63 by Ryan Scott at 2016-02-07T23:25:57+01:00
Render */# instead of TYPE 'Lifted/TYPE 'Unlifted (fixes haskell/haddock#473)

- - - - -
b6458693 by Ben Gamari at 2016-02-07T23:29:27+01:00
Merge pull request haskell/haddock#477 from haskell/issue-475

Make sure --mathjax affects all written HTML files
- - - - -
adcc0071 by Ben Gamari at 2016-02-07T23:34:52+01:00
Merge branch 'master' into ghc-head

- - - - -
d0404e61 by Ben Gamari at 2016-02-08T12:46:49+01:00
doc: Switch to Sphinx

- - - - -
acb153b3 by Ben Gamari at 2016-02-08T12:46:56+01:00
Document --use-unicode flag

- - - - -
c20bdf1d by Ben Gamari at 2016-02-08T13:41:24+01:00
Fix GHC and haddock-library dependency bounds

- - - - -
8d946801 by Ben Gamari at 2016-02-08T14:54:56+01:00
testsuite: Rework handling of output sanitization

Previously un-cleaned artifacts were kept as reference output, making
it difficult to tell what has changed and causing spurious changes in
the version control history. Here we rework this, cleaning the output
during acceptance. To accomplish this it was necessary to move to strict
I/O to ensure the reference handle was closed before accept attempts to
open the reference file.

- - - - -
c465705d by Ben Gamari at 2016-02-08T15:36:05+01:00
test: Compare on dump

For reasons I don't understand the Xml representations differ despite
their textual representations being identical.

- - - - -
1ec0227a by Ben Gamari at 2016-02-08T15:36:05+01:00
html-test: Accept test output

- - - - -
eefbd63a by Ben Gamari at 2016-02-08T15:36:08+01:00
hypsrc-test: Accept test output

And fix impredicative Polymorphism testcase.

- - - - -
d1df4372 by Ben Gamari at 2016-02-08T15:40:44+01:00
Merge branch 'fix-up-testsuite'

- - - - -
206a3859 by Phil Ruffwind at 2016-02-08T17:51:21+01:00
Move the permalinks to "#" on the right side

Since pull request haskell/haddock#407, the identifiers have been permalinked to
themselves, but this makes it difficult to copy the identifier by
double-clicking.  To work around this usability problem, the permalinks
are now placed on the far right adjacent to "Source", indicated by "#".

Also, 'namedAnchor' now uses 'id' instead of 'name' (which is obsolete).

- - - - -
6c89fa03 by Phil Ruffwind at 2016-02-08T17:54:44+01:00
Update tests for previous commit

- - - - -
effaa832 by Ben Gamari at 2016-02-08T17:56:17+01:00
Merge branch 'anchors-redux'

- - - - -
9a2bec90 by Ben Gamari at 2016-02-08T17:58:40+01:00
Use -fprint-unicode-syntax when --use-unicode is enabled

This allows GHC to render `*` as its Unicode representation, among other
things.

- - - - -
28ecac5b by Ben Gamari at 2016-02-11T18:53:03+01:00
Merge pull request haskell/haddock#480 from bgamari/sphinx

Move documentation to ReStructuredText
- - - - -
222e5920 by Ryan Scott at 2016-02-11T15:42:42-05:00
Collapse type/data family instances by default

- - - - -
a80ac03b by Ryan Scott at 2016-02-11T20:17:09-05:00
Ensure expanded family instances render correctly

- - - - -
7f985231 by Ben Gamari at 2016-02-12T10:04:22+01:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
d4eda086 by Ben Gamari at 2016-02-18T00:05:56+01:00
Xhtml.Decl: Various cleanups

- - - - -
79bee48d by Ben Gamari at 2016-02-18T00:05:56+01:00
Xhtml.Decl: Show kind signatures for type family variables

Addresses GHC haskell/haddock#11588.

- - - - -
b2981d98 by Ben Gamari at 2016-02-18T00:05:56+01:00
Xhtml.Decl: Show 'where ...' after closed type family

Seems like we should ideally show the actual equations as well but that
seems like it would be a fair amount of work

- - - - -
cfc0e621 by Ben Gamari at 2016-02-18T22:48:12+01:00
Merge pull request haskell/haddock#483 from bgamari/T11588

Fix GHC haskell/haddock#11588

This fixes GHC haskell/haddock#11588:
  * Show where ... after closed type families
  * Show kind signatures on type family type variables


- - - - -
256e8a0d by Ben Gamari at 2016-02-18T23:15:39+01:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
32402036 by Richard Eisenberg at 2016-02-24T13:21:44-05:00
Follow-on changes to support RuntimeRep

- - - - -
2b1c572d by Matthew Pickering at 2016-03-04T21:04:02+00:00
Remove unused functions

- - - - -
eb906f50 by Richard Eisenberg at 2016-03-13T21:17:20+01:00
Follow-on changes to support RuntimeRep

(cherry picked from commit ab954263a793d8ced734459d6194a5d89214b66c)

- - - - -
8c34ef34 by Richard Eisenberg at 2016-03-14T23:47:23-04:00
Changes due to fix for GHC#11648.

- - - - -
0e022014 by Richard Eisenberg at 2016-03-15T14:06:45+01:00
Changes due to fix for GHC#11648.

(cherry picked from commit bb994de1ab0c76d1aaf1e39c54158db2526d31f1)

- - - - -
ed3f78ab by Rik Steenkamp at 2016-04-02T22:20:36+01:00
Fix printing of pattern synonym types

Removes the call to `patSynType :: PatSyn -> Type` in `Convert.hs` as this
function will be removed from GHC. Instead, we use the function `patSynSig`
and build the `HsDecl` manually. This also fixes the printing of the two
contexts and the quantified type variables in a pattern synonym type.

Reviewers: goldfire, bgamari, mpickering

Differential Revision: https://phabricator.haskell.org/D2048

- - - - -
d3210042 by Rik Steenkamp at 2016-04-04T15:43:32+02:00
Fix printing of pattern synonym types

Removes the call to `patSynType :: PatSyn -> Type` in `Convert.hs` as this
function will be removed from GHC. Instead, we use the function `patSynSig`
and build the `HsDecl` manually. This also fixes the printing of the two
contexts and the quantified type variables in a pattern synonym type.

Reviewers: goldfire, bgamari, mpickering

Differential Revision: https://phabricator.haskell.org/D2048

(cherry picked from commit 3ddcbd6b8e6884bd95028381176eb33bee6896fb)

- - - - -
236eec90 by Ben Gamari at 2016-04-10T23:40:15+02:00
doc: Fix option references

(cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)

- - - - -
692ee7e0 by Ben Gamari at 2016-04-10T23:40:15+02:00
doc: Only install if BUILD_SPHINX_HTML==YES

Fixes GHC haskell/haddock#11818.

- - - - -
79619f57 by Ben Gamari at 2016-04-10T23:46:22+02:00
doc: Only install if BUILD_SPHINX_HTML==YES

Fixes GHC haskell/haddock#11818.

(cherry picked from commit c6d6a18d85e5e2d9bb5904e6919e8a8d7e31c4c5)

- - - - -
3358ccb4 by Ben Gamari at 2016-04-10T23:47:27+02:00
doc: Fix option references

(cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)

- - - - -
264949b1 by Ben Gamari at 2016-04-16T17:50:23+02:00
Merge pull request haskell/haddock#482 from RyanGlScott/ghc-head

Collapse type/data family instances by default
- - - - -
478c483a by Ben Gamari at 2016-04-16T17:51:09+02:00
Merge pull request haskell/haddock#489 from mpickering/unused-functions

Remove some unused functions
- - - - -
c94e55f0 by Ryan Scott at 2016-04-16T17:57:54+02:00
Collapse type/data family instances by default

(cherry picked from commit 2da130a8db8f995c119b544fad807533236cf088)

- - - - -
31e633d3 by Ryan Scott at 2016-04-16T17:58:06+02:00
Ensure expanded family instances render correctly

(cherry picked from commit 1338b5d7c32939de6bbc31af0049477e4f847103)

- - - - -
03e4d197 by Matthew Pickering at 2016-04-16T17:58:21+02:00
Remove unused functions

(cherry picked from commit b89d1c2456bdb2d4208d94ded56155f7088a37d0)

- - - - -
ed4116f6 by Ben Gamari at 2016-04-20T10:46:57+02:00
ghc: Install files for needed --hyperlinked-source

- - - - -
0be999c4 by Ben Gamari at 2016-04-20T11:37:54+02:00
ghc: Install files for needed --hyperlinked-source

(cherry picked from commit 5c82c9fc2d21ddaae4a2470f1c375426968f19c6)

- - - - -
4d17544c by Simon Peyton Jones at 2016-04-20T12:42:28+01:00
Track change to HsGroup

This relates to a big GHC patch for Trac haskell/haddock#11348

- - - - -
1700a50d by Ben Gamari at 2016-05-01T13:19:27+02:00
doc: At long last fix ghc.mk

The variable reference was incorrectly escaped, meaning that Sphinx
documentation was never installed.

- - - - -
0b7c8125 by Ben Gamari at 2016-05-01T13:21:43+02:00
doc: At long last fix ghc.mk

The variable reference was incorrectly escaped, meaning that Sphinx
documentation was never installed.

(cherry picked from commit 609018dd09c4ffe27f9248b2d8b50f6196cd42b9)

- - - - -
af115ce0 by Ryan Scott at 2016-05-04T22:15:50-04:00
Render Haddocks for derived instances

Currently, one can document top-level instance declarations, but derived
instances (both those in `deriving` clauses and standalone `deriving`
instances) do not enjoy the same privilege. This makes the necessary
changes to the Haddock API to enable rendering Haddock comments for
derived instances.

This is part of a fix for Trac haskell/haddock#11768.

- - - - -
76fa1edc by Ben Gamari at 2016-05-10T18:13:25+02:00
haddock-test: A bit of refactoring for debuggability

- - - - -
7d4c4b20 by Ben Gamari at 2016-05-10T18:13:25+02:00
Create: Mark a comment as TODO

- - - - -
2a6d0c90 by Ben Gamari at 2016-05-10T18:13:25+02:00
html-test: Update reference output

- - - - -
bd60913d by Ben Gamari at 2016-05-10T18:13:25+02:00
hypsrc-test: Fix reference file path in cabal file

It appears the haddock insists on prefixing --hyperlinked-sourcer output
with directory which the source appeared in.

- - - - -
c1548057 by Ben Gamari at 2016-05-10T18:22:12+02:00
doc: Update extra-source-files in Cabal file

- - - - -
41d5bae3 by Ben Gamari at 2016-05-10T18:29:21+02:00
Bump versions

- - - - -
ca75b779 by Ben Gamari at 2016-05-11T16:03:44+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
4e3cfd62 by Ben Gamari at 2016-05-11T16:06:45+02:00
Merge remote-tracking branch 'RyanGlScott/ghc-head' into ghc-head

- - - - -
a2379970 by Ben Gamari at 2016-05-11T23:15:11+02:00
doc: Add clean targets

- - - - -
f275212e by Ben Gamari at 2016-05-11T23:15:14+02:00
doc: Add html as an all-target for ghc

Otherwise the html documentation won't be installed for binary-dist.

- - - - -
388fc0af by Ben Gamari at 2016-05-12T09:49:12+02:00
Update CHANGES

- - - - -
bad81ad5 by Ben Gamari at 2016-05-12T09:49:38+02:00
Version bump

- - - - -
c01688a7 by Ben Gamari at 2016-05-12T10:04:58+02:00
Revert "Version bump"

This bump was a bit premature.

This reverts commit 7b238d9c5be9b07aa2d10df323b5c7b8d1634dc8.

- - - - -
7ed05724 by Ben Gamari at 2016-05-12T10:05:33+02:00
doc: Fix GHC clean rule

Apparently GHC's build system doesn't permit wildcards in clean paths.

- - - - -
5d9611f4 by Ben Gamari at 2016-05-12T17:43:50+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
653566b2 by Ben Gamari at 2016-05-14T09:57:31+02:00
Version bump to 2.17.2

- - - - -
b355c439 by Ben Gamari at 2016-05-14T09:57:51+02:00
doc: Use `$(MAKE)` instead of `make`

This is necessary to ensure we use gmake.

- - - - -
8a18537d by Ben Gamari at 2016-05-14T10:15:45+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
b3290ef1 by Sebastian Meric de Bellefon at 2016-05-14T11:29:47-04:00
Fix haskell/haddock#303. Hide footer when printing

The "Produced by Haddock" footer was overlapping the page's body when printing.
This patch hides the footer with a css media rule.

- - - - -
b4a76f89 by Sebastian Meric de Bellefon at 2016-05-15T02:12:46-04:00
Fix haskell/haddock#280. Parsing of module header

The initial newlines were counted as indentation spaces, thus disturbing the parsing of next lines

- - - - -
ba797c9e by Ben Gamari at 2016-05-16T14:53:46+02:00
doc: Vendorize alabaster Sphinx theme

Alabaster is now the default sphinx theme and is a significant
improvement over the previous default that it's worthproviding it when
unavailable (e.g. Sphinx <1.3).

- - - - -
c9283e44 by Ben Gamari at 2016-05-16T14:55:17+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
1c9ea198 by Sebastian Méric de Bellefon at 2016-05-16T12:30:40-04:00
Merge pull request haskell/haddock#502 from Helkafen/master

Fix haskell/haddock#303. Hide footer when printing
- - - - -
33631016 by Ben Gamari at 2016-05-16T19:56:11+02:00
Revert "doc: Vendorize alabaster Sphinx theme"

This ended up causes far too many issues to be worthwhile. We'll just
have to live with inconsistent haddock documentation.

This reverts commit cec21957001143794e71bcd9420283df18e7de40.

- - - - -
93317d26 by Ben Gamari at 2016-05-16T19:56:11+02:00
cabal: Fix README path

- - - - -
c8695b22 by Ben Gamari at 2016-05-16T19:58:51+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
0b50eaaa by Ben Gamari at 2016-05-16T21:02:08+02:00
doc: Use whichever theme sphinx deems appropriate

- - - - -
857c1c9c by Ben Gamari at 2016-05-16T21:07:08+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
15fc5637 by Ben Gamari at 2016-05-22T12:43:59+02:00
Create: Remove redundant imports

- - - - -
132ddc6a by Ben Gamari at 2016-05-22T12:43:59+02:00
Create: Better debug output

For tracking down haskell/haddock#505

- - - - -
2252a149 by Ben Gamari at 2016-05-22T12:43:59+02:00
Don't consider default class ops when looking for decls

When we are looking for an operation within a class we don't care about
`default`-type declarations. This was the cause of haskell/haddock#505.

- - - - -
4886b2ec by Oleg Grenrus at 2016-05-24T16:19:48+03:00
UnfelpfulSpan line number omitted

Kind of resolves https://github.com/haskell/haddock/issues/508

- - - - -
a4befd36 by Oleg Grenrus at 2016-05-24T16:53:35+03:00
Change Hyperlinked lexer to know about DataKinds ticks

- - - - -
f45cb52e by David Feuer at 2016-05-24T18:48:53-04:00
Make parser state a newtype

Previously, it was `data` wrapping a `Maybe`, which seems a bit
silly. Obviously, this can be changed back if anyone wants to add
more fields some day.

- - - - -
05013dd7 by Sebastian Meric de Bellefon at 2016-05-24T22:03:55-04:00
remove framed view of the HTML documentation (see haskell/haddock#114 and haskell/haddock#274)

Frames are a bit broken, ignored by Hackage, and considered obsolete in general.
This patch disables frames generation. The mini_*.html files are still used in the synopsis.

- - - - -
b8163a88 by Ben Gamari at 2016-05-25T14:44:15+02:00
Merge pull request haskell/haddock#507 from bgamari/T505

Fix haskell/haddock#505
- - - - -
ea1b30c6 by Sebastian Meric de Bellefon at 2016-05-25T14:17:00-04:00
Update CHANGES

- - - - -
eddfc258 by Sebastian Méric de Bellefon at 2016-05-25T15:17:40-04:00
Merge pull request haskell/haddock#514 from Helkafen/frames

remove framed view of the HTML documentation (see haskell/haddock#114 and haskell/haddock#274)
- - - - -
0e506818 by Alex Biehl at 2016-05-26T12:43:09+02:00
Remove misplaced haddock comment

- - - - -
a07d28c0 by Ben Gamari at 2016-05-27T11:34:59+02:00
Merge pull request haskell/haddock#515 from alexbiehl/master

Remove misplaced haddock comment
- - - - -
9001d267 by Ben Gamari at 2016-05-27T11:35:46+02:00
Merge pull request haskell/haddock#513 from treeowl/newtype-since

Make parser state a newtype
- - - - -
74e1a018 by Sebastian Méric de Bellefon at 2016-05-28T17:28:15-04:00
Merge pull request haskell/haddock#504 from Helkafen/issue-280

Fix haskell/haddock#280. Parsing of module header
- - - - -
37557f4f by Alan Zimmerman at 2016-05-29T23:36:50+02:00
Matching changes for haskell/haddock#12105

- - - - -
7d09e5d6 by Sebastian Meric de Bellefon at 2016-06-03T18:07:48-04:00
Version bumps (2.17.3, 1.4.2)

- - - - -
85b4bc15 by Sebastian Méric de Bellefon at 2016-06-06T18:35:13-04:00
Merge pull request haskell/haddock#521 from Helkafen/master

Version bumps (2.17.3, 1.4.2)
- - - - -
e95f0dee by Sebastian Meric de Bellefon at 2016-06-06T19:11:35-04:00
publish haddock-test library

- - - - -
4de40586 by Sebastian Méric de Bellefon at 2016-06-06T20:26:30-04:00
Merge pull request haskell/haddock#512 from phadej/oleg-fixes

Fixes for haskell/haddock#508 and haskell/haddock#510
- - - - -
ddfd0789 by Dominic Steinitz at 2016-06-09T09:27:28+01:00
Documentation for LaTeX markup.

- - - - -
697a503a by Dominic Steinitz at 2016-06-09T09:33:59+01:00
Fix spelling mistake.

- - - - -
246f6fff by Dominic Steinitz at 2016-06-09T09:37:15+01:00
Camel case MathJax.

- - - - -
4684bd23 by Dominic Steinitz at 2016-06-09T09:44:53+01:00
Fix math typo and add link.

- - - - -
f20c037c by Simon Peyton Jones at 2016-06-13T18:26:03+01:00
Follow changes to LHsSigWcType

- - - - -
0c58996d by Simon Peyton Jones at 2016-06-15T12:56:01+01:00
Follow GHC re-adding FunTy

- - - - -
401b5ca7 by Sebastian Méric de Bellefon at 2016-06-15T12:16:47-04:00
Merge pull request haskell/haddock#525 from idontgetoutmuch/master

Documentation for LaTeX markup.
- - - - -
92d263b7 by Sebastian Méric de Bellefon at 2016-06-15T12:17:29-04:00
Merge pull request haskell/haddock#522 from Helkafen/master

publish haddock-test library
- - - - -
0953a2ca by Sebastian Meric de Bellefon at 2016-06-16T00:46:46-04:00
Copyright holders shown on several lines. Fix haskell/haddock#279

- - - - -
65453e14 by Ben Gamari at 2016-06-16T11:16:32+02:00
ocean: Ensure that synopsis fully covers other content

Previously MathJax content was being rendered on top of the synopsis due
to ambiguous z-ordering. Here we explicitly give the synopsis block a
higher z-index to ensure it is rendered on top. Fixes haskell/haddock#531.

- - - - -
68e411a1 by Sebastian Méric de Bellefon at 2016-06-16T23:34:39-04:00
Merge pull request haskell/haddock#534 from bgamari/T531

ocean: Ensure that synopsis fully covers other content
- - - - -
fad6491b by Sebastian Méric de Bellefon at 2016-06-18T23:57:20-04:00
Merge pull request haskell/haddock#533 from Helkafen/master

Copyright holders shown on several lines. Fix haskell/haddock#279
- - - - -
6108e21b by Sebastian Meric de Bellefon at 2016-06-22T23:08:28-04:00
do not create empty src directory

Fix haskell/haddock#536.

- - - - -
1ef23823 by Sebastian Méric de Bellefon at 2016-06-24T00:04:48-04:00
Merge pull request haskell/haddock#537 from Helkafen/master

do not create empty src directory
- - - - -
966baa96 by Omari Norman at 2016-06-29T21:59:34-04:00
Add $ as a special character

If this character is not escaped, documentation built with Haddock
2.17.2 will fail.  This was not an issue with 2.16 series, which
causes builds to fail and there is nothing in the docs or error
message giving a clue about why builds that used to succeed now
don't.

- - - - -
324adb60 by Ben Gamari at 2016-07-01T12:18:51+02:00
GhcUtils: Changes for multi-pattern signatures

- - - - -
d7571675 by Ömer Sinan Ağacan at 2016-07-21T13:30:47+02:00
Add support for unboxed sums

- - - - -
29d0907b by Simon Marlow at 2016-07-22T13:55:48+01:00
Disable NFData instances for GHC types when GHC >= 8.2

- - - - -
702d95f3 by Simon Marlow at 2016-08-02T15:57:30+02:00
Disable NFData instances for GHC types when GHC >= 8.0.2

(cherry picked from commit a3309e797c42dae9bccdeb17ce52fcababbaff8a)

- - - - -
f4fa79c3 by Ben Gamari at 2016-08-07T13:51:18+02:00
ghc.mk: Don't attempt to install html/frames.html

The frames business has been removed.

- - - - -
9cd63daf by Ben Gamari at 2016-08-07T13:51:40+02:00
Haddock.Types: More precise version guard

This allows haddock to be built with GHC 8.0.2 pre-releases.

- - - - -
f3d7e03f by Mateusz Kowalczyk at 2016-08-29T20:47:45+01:00
Merge pull request haskell/haddock#538 from massysett/master

Add $ as a special character
- - - - -
16dbf7fd by Bartosz Nitka at 2016-09-20T19:44:04+01:00
Fix rendering of class methods for Eq and Ord

See haskell/haddock#549 and GHC issue haskell/haddock#12519

- - - - -
7c31c1ff by Bartosz Nitka at 2016-09-27T17:32:22-04:00
Fix rendering of class methods for Eq and Ord

See haskell/haddock#549 and GHC issue haskell/haddock#12519

(cherry picked from commit 073d899a8f94ddec698f617a38d3420160a7fd0b)

- - - - -
33a90dce by Ryan Scott at 2016-09-30T20:53:41-04:00
Haddock changes for T10598

See https://ghc.haskell.org/trac/ghc/ticket/10598

- - - - -
1f32f7cb by Ben Gamari at 2016-10-13T20:01:26-04:00
Update for refactoring of NameCache

- - - - -
1678ff2e by Ben Gamari at 2016-11-15T17:42:48-05:00
Bump upper bound on base

- - - - -
9262a7c5 by Alan Zimmerman at 2016-12-07T21:14:28+02:00
Match changes in GHC wip/T3384 branch

- - - - -
ac0eaf1a by Ben Gamari at 2016-12-09T09:48:41-05:00
haddock-api: Don't use stdcall calling convention on 64-bit Windows

See GHC haskell/haddock#12890.

- - - - -
04afe4f7 by Alan Zimmerman at 2016-12-12T20:07:21+02:00
Matching changes for GHC wip/T12942

- - - - -
e1d1701d by Ben Gamari at 2016-12-13T16:50:41-05:00
Bump base upper bound

- - - - -
3d3eacd1 by Alan Zimmerman at 2017-01-10T16:59:38+02:00
HsIParamTy now has a Located name

- - - - -
7dbceefd by Kyrill Briantsev at 2017-01-12T13:23:50+03:00
Prevent GHC API from doing optimization passes.

- - - - -
d48d1e33 by Richard Eisenberg at 2017-01-19T08:41:41-05:00
Upstream changes re levity polymorphism

- - - - -
40c25ed6 by Alan Zimmerman at 2017-01-26T15:16:18+02:00
Changes to match haskell/haddock#13163 in GHC

- - - - -
504f586d by Ben Gamari at 2017-02-02T17:19:37-05:00
Kill remaining static flags

- - - - -
49147ea0 by Justus Adam at 2017-03-02T15:33:34+01:00
Adding MDoc to exports of Documentation.Haddock

- - - - -
1cfba9b4 by Justus Adam at 2017-03-09T11:41:44+01:00
Also exposing toInstalledIface

- - - - -
53f0c0dd by Ben Gamari at 2017-03-09T13:10:08-05:00
Bump for GHC 8.3

- - - - -
c7902d2e by Ben Gamari at 2017-03-09T23:46:02-05:00
Bump for GHC 8.2

- - - - -
4f3a74f8 by Ben Gamari at 2017-03-10T10:21:55-05:00
Merge branch 'ghc-head'

- - - - -
e273b72f by Richard Eisenberg at 2017-03-14T13:34:04-04:00
Update Haddock w.r.t. new HsImplicitBndrs

- - - - -
6ec3d436 by Richard Eisenberg at 2017-03-14T15:15:52-04:00
Update Haddock w.r.t. new HsImplicitBndrs

- - - - -
eee3cda1 by Ben Gamari at 2017-03-15T15:19:59-04:00
Adapt to EnumSet

- - - - -
017cf58e by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Correctly handle Backpack identity/semantic modules.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
736d6773 by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Add a field marking if interface is a signature or not.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
475f84a0 by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Render signature module tree separately from modules.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
13240b53 by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Documentation.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
cd16d529 by Edward Z. Yang at 2017-03-15T22:50:46-07:00
More docs.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
3bea97ae by Edward Z. Yang at 2017-03-15T22:50:46-07:00
TODO on moduleExports.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
b2b051ce by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Better Backpack support with signature merging.

When we merge signatures, we gain exports that don't
necessarily have a source-level declaration corresponding
to them.  This meant Haddock dropped them.

There are two big limitations:

* If there's no export list, we won't report inherited
  signatures.

* If the type has a subordinate, the current hiDecl
  implementation doesn't reconstitute them.

These are probably worth fixing eventually, but this gets
us to minimum viable functionality.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
0f082795 by Edward Z. Yang at 2017-03-15T22:50:46-07:00
Fix haddock-test to work with latest version of Cabal.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
20ef63c9 by Edward Z. Yang at 2017-03-22T13:48:12-07:00
Annotate signature docs with (signature)

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
45692dcb by Edward Z. Yang at 2017-03-22T14:11:25-07:00
Render help documentation link next to (signature) in title.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
4eae8caf by Ben Gamari at 2017-03-23T09:25:33-04:00
Merge commit '240bc38b94ed2d0af27333b23392d03eeb615e82' into HEAD

- - - - -
0bbe03f5 by Ben Gamari at 2017-03-23T09:27:28-04:00
haddock-api: Bump bound on GHC

- - - - -
65f3ac9d by Alex Biehl at 2017-03-23T17:36:11+01:00
Merge pull request haskell/haddock#581 from JustusAdam/master

Adding more exports to Documentation.Haddock
- - - - -
37d49a47 by Alex Biehl at 2017-03-23T17:39:14+01:00
Merge pull request haskell/haddock#568 from awson/ghc-head

Prevent GHC API from doing optimization passes.
- - - - -
1ed047e4 by Brian Huffman at 2017-03-23T17:45:58+01:00
Print any user-supplied kind signatures on type parameters.

This applies to type parameters on data, newtype, type, and class
declarations, and also to forall-bound type vars in type signatures.

- - - - -
1b78ca5c by Brian Huffman at 2017-03-23T17:45:58+01:00
Update test suite to expect kind annotations on type parameters.

- - - - -
a856b162 by Alex Biehl at 2017-03-23T17:49:32+01:00
Include travis build indication badge
- - - - -
8e2e2c56 by Ben Gamari at 2017-03-23T17:20:08-04:00
haddock-api: Bump bound on GHC

- - - - -
4d2d9995 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Correctly handle Backpack identity/semantic modules.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 26d6c150b31bc4580ab17cfd07b6e7f9afe10737)

- - - - -
a650e20f by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Add a field marking if interface is a signature or not.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 930cfbe58e2e87f5a4d431d89a3c204934e6e858)

- - - - -
caa282c2 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Render signature module tree separately from modules.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 2067a2d0afa9cef381d26fb7140b67c62f433fc0)

- - - - -
49684884 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Documentation.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 0671abfe7e8ceae2269467a30b77ed9d9656e2cc)

- - - - -
4dcfeb1a by Edward Z. Yang at 2017-03-23T17:20:08-04:00
More docs.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 3d77b373dd5807d5d956719dd7c849a11534fa6a)

- - - - -
74dd19d2 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
TODO on moduleExports.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 94610e9b446324f4231fa6ad4c6ac51e4eba8c0e)

- - - - -
a9b19a23 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Better Backpack support with signature merging.

When we merge signatures, we gain exports that don't
necessarily have a source-level declaration corresponding
to them.  This meant Haddock dropped them.

There are two big limitations:

* If there's no export list, we won't report inherited
  signatures.

* If the type has a subordinate, the current hiDecl
  implementation doesn't reconstitute them.

These are probably worth fixing eventually, but this gets
us to minimum viable functionality.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 6cc832dfb1de6088a4abcaae62b25a7e944d55c3)

- - - - -
d3631064 by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Fix haddock-test to work with latest version of Cabal.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit bf3c4d72a0fda38561376eac7eda216158783267)

- - - - -
ef2148fc by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Annotate signature docs with (signature)

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 07b88c5d4e79b87a319fbb08f8ea01dbb41063c1)

- - - - -
2f29518b by Edward Z. Yang at 2017-03-23T17:20:08-04:00
Render help documentation link next to (signature) in title.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit 4eb765ca4205c79539d60b7afa9b7e261a4a49fe)

- - - - -
37de047d by Phil Ruffwind at 2017-04-03T11:57:14+02:00
Update MathJax URL

MathJax is shutting down their CDN:
https://www.mathjax.org/cdn-shutting-down/

They recommend migrating to cdnjs.

- - - - -
e9d24ba8 by David C. Turner at 2017-04-03T14:58:01+02:00
Add highlight for :target to ocean.css

- - - - -
4819a202 by Alex Biehl at 2017-04-11T19:36:48+02:00
Allow base-4.10 for haddock-test

- - - - -
44cec69c by Alex Biehl at 2017-04-11T19:39:22+02:00
cabal.project for haddock-api, haddock-library and haddock-test

- - - - -
935d0f6a by Alex Biehl at 2017-04-11T19:46:29+02:00
Move dist scripts to scripts/

- - - - -
128e150c by Alex Biehl at 2017-04-11T20:34:46+02:00
Add haddock to cabal.project

- - - - -
cc8e08ea by Alex Biehl at 2017-04-11T20:35:08+02:00
Read files for hyperlinker eagerly

This also exposes Documentation.Haddock.Utf8

- - - - -
152dda78 by Alex Biehl at 2017-04-11T20:37:06+02:00
Explicit import list ofr Control.DeepSeq in Haddock.Interface.Create

- - - - -
501b33c4 by Kyrill Briantsev at 2017-04-11T21:01:42+02:00
Prevent GHC API from doing optimization passes.

- - - - -
c9f3f5ff by Alexander Biehl at 2017-04-12T16:36:53+02:00
Add @alexbiehl as maintaner

- - - - -
76f214cc by Alex Biehl at 2017-04-13T07:27:18+02:00
Disable doctest with ghc-8.3

Currently doctest doesn't support ghc-head
- - - - -
46b4f5fc by Edward Z. Yang at 2017-04-22T20:38:26-07:00
Render (signature) only if it actually is a signature!

I forgot a conditional, oops!

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
f0555235 by Alex Biehl at 2017-04-25T10:08:48+02:00
Travis: Use ghc-8.2.1 on master

- - - - -
966ea348 by Alex Biehl at 2017-04-25T10:32:01+02:00
Travis: Verbose cabal output

cf. https://travis-ci.org/haskell/haddock/jobs/225512194#L377
- - - - -
36972bcd by Alex Biehl at 2017-04-25T10:40:43+02:00
Use travis_retry for cabal invocations
- - - - -
b3a09d2c by Alex Biehl at 2017-04-25T17:02:20+02:00
Use new MathJax URL in html-test

18ed871afb82560d5433b2f53e31b4db9353a74e switched to a new MathJax URL
but didn't update the tests.

- - - - -
ae331e5f by Alexander Biehl at 2017-04-25T17:02:20+02:00
Expand signatures for class declarations

- - - - -
e573c65a by Alexander Biehl at 2017-04-25T17:02:20+02:00
Hoogle: Correctly print classes with associated data types

- - - - -
3fc6be9b by Edward Z. Yang at 2017-04-25T17:02:20+02:00
Render (signature) only if it actually is a signature!

I forgot a conditional, oops!

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>
(cherry picked from commit a0c4790e15a2d3fab8d830eee8fcd639fe6d39c9)

- - - - -
6725c060 by Herbert Valerio Riedel at 2017-04-25T17:02:20+02:00
`html-test --accept` deltas to reference samples

- - - - -
7d444d61 by Alex Biehl at 2017-04-26T07:13:50+02:00
Remove anything related to obsolete frames mode

- - - - -
b888972c by Alex Biehl at 2017-04-26T07:49:10+02:00
Cherry-picked remaining commits from haddock-2.17.4-release (#603)

* Release haddock/haddock-api 2.17.4 and haddock-library 1.4.3

* Set version bounds for haddock-library

NB: This allows GHC 8.2.1's base

* Set version bounds for haddock & haddock-api

The version bounds support GHC 8.2

* Merge (temporary) v2.17.3 branch into v2.17

This allows us to delete the v2.17.3 branch

* Fixup changelog

* Pin down haddock-api to a single version

as otherwise `haddock`'s package version has no proper meaning

* fix source-repo spec for haddock-api

- - - - -
4161099b by Alex Biehl at 2017-04-26T11:11:20+02:00
Update changelog to reflect news in HEAD

- - - - -
eed72cb8 by Alex Biehl at 2017-04-26T11:11:20+02:00
Markdownify changelog

- - - - -
5815cea1 by Alex Biehl at 2017-04-26T11:32:33+02:00
Bump to 2.18.0 (#605)


- - - - -
a551d558 by Alex Biehl at 2017-04-29T22:00:25+02:00
Update attoparsec-0.12.1.1 to attoparsec-0.13.1.0

- - - - -
ea164a8d by Sergey Vinokurov at 2017-04-29T22:42:36+02:00
Improve error message

- - - - -
2e10122f by Alex Biehl at 2017-04-30T10:07:46+02:00
Correctly remember collapsed sections (#608)

Now the "collapsed" cookie stores which sections have changed state instead of which are collapsed.
- - - - -
f9b24d99 by Alex Biehl at 2017-05-01T17:40:36+02:00
Lazily decode docMap and argMap (#610)

These are only used in case of a doc reexport so most of the time
decoding these is wasted work.
- - - - -
2372af62 by Alex Biehl at 2017-05-01T21:59:23+02:00
Fix Binary instance for InstalledInterface (#611)

(#610) introduced lazy decoding for docs from InstalledInterface but
forgot to remove the original calls to get and put_
- - - - -
6c633c13 by Nathan Collins at 2017-05-11T11:47:55+02:00
Improve documenation of Haddock markup (#614)

* Improve documentation of Haddock markup.

- document that Haddock supports inferring types top-level functions
  with without type signatures, but also explain why using this
  feature is discouraged. Looks like this feature has been around
  since version 2.0.0.0 in 2008!

- rework the "Module description" section:

  - move the general discussion of field formatting to the section
    intro and add examples illustrating the prose for multiline
    fields.

  - mention that newlines are preserved in some multiline fields, but
    not in others (I also noticed that commas in the `Copyright` field
    are not preserved; I'll look into this bug later).

  - add a subsection for the module description fields documentation,
    and put the field keywords in code formatting (double back ticks)
    instead of double quotes, to be consistent with the typesetting of
    keywords in other parts of the documentation.

  - mention that "Named chunks" are not supported in the long-form
    "Module description" documentation.

- fix formatting of keywords in the "Module attributes"
  section. Perhaps these errors were left over from an automatic
  translation to ReST from some other format as part of the transition
  to using Sphinx for Haddock documentation? Also, add a missing
  reference here; it just said "See ?"!

- update footnote about special treatment for re-exporting partially
  imported modules not being implemented. In my tests it's not
  implemented at all -- I tried re-exporting both `import B
  hiding (f)` and `import B (a, b)` style partial imports, and in both
  cases got the same result as with full imports `import B`: I only
  get a module reference.

* Rework the `Controlling the documentation structure` section.

My main goal was to better explain how to use Haddock without an
export list, since that's my most common use case, but I hope I
improved the section overall:

- remove the incomplete `Omitting the export list` section and fold it
  into the other sections. In particular, summarize the differences
  between using and not using an export list -- i.e. control over what
  and in what order is documented -- in the section lead.

- add "realistic" examples that use the structure markup, both with
  and without an export list. I wanted a realistic example here to
  capture how it can be useful to explain the relationship between a
  group of functions in a section, in addition to documenting their
  individual APIs.

- make it clear that you can associate documentation chunks with
  documentation sections when you aren't using an export list, and
  that doing it in the most obvious way -- i.e. with `-- |`, as you
  can in the export list -- doesn't work without an export list. It
  took me a while to figure this out the first time, since the docs
  didn't explain it at all before.

- add a "no export list" example to the section header section.

- add more cross references.

* Add examples of gotchas for markup in `@...@`.

I'm not sure this will help anyone, since I think most people first
learn about `@...@` by reading other people's Haddocks, but I've
documented the mistakes which I've made and then gotten confused by.

* Use consistent Capitalization of Titles.

Some titles were in usual title caps, and others only had the first
word capitalized. I chose making them all use title caps because that
seems to make the cross references look better.

- - - - -
d4734f45 by Ben Gamari at 2017-05-12T20:36:08+02:00
Haddock: Fix broken lazy IO in prologue reading (#615)

We previously used withFile in conjunction with hGetContents. The list returned
by the latter wasn't completely forced by the time we left the withFile block,
meaning that we would try to read from a closed handle.
- - - - -
93883f37 by Alex Biehl at 2017-05-12T21:02:33+02:00
Haddock: Fix broken lazy IO in prologue reading (#615)

We previously used withFile in conjunction with hGetContents. The list returned
by the latter wasn't completely forced by the time we left the withFile block,
meaning that we would try to read from a closed handle.
- - - - -
5b8f179c by Alex Biehl at 2017-05-13T12:48:10+02:00
Consequently use inClass and notInClass in haddock-library (#617)

These allow attoparsec to do some clever lookup optimization
- - - - -
77984b82 by Doug Wilson at 2017-05-27T17:37:38+02:00
Don't enable compilation for template haskell (#624)

This is no longer necessary after
ghc commit 53c78be0aab76a3107c4dacbb1d177afacdd37fa
- - - - -
5a3de2b4 by Doug Wilson at 2017-05-27T19:54:53+02:00
Improve Syb code (#621)

Specialize.hs and Ast.hs are modified to have their Syb code not recurse into
Name or Id in HsSyn types.

Specialize.hs is refactored to have fewer calls to Syb functions.

Syb.hs has some foldl calls replaced with foldl' calls.

There is still a lot of performance on the floor of Ast.hs. The RenamedSource
is traversed many times, and lookupBySpan is very inefficient. everywhereBut and
lookupBySpan dominate the runtime whenever --hyperlinked-source is passed.
- - - - -
3d35a949 by Alex Biehl at 2017-05-30T19:01:37+02:00
Clear fixme comment (#625)


- - - - -
2a44bd0c by Alex Biehl at 2017-05-30T19:02:12+02:00
Make haddock-library and haddock-api warning free (#626)


- - - - -
bd1a0e42 by Alex Biehl at 2017-06-01T10:40:33+02:00
Include `driver-test/*.hs` sdist (#630)

This lead to haskell/haddock#629.
- - - - -
184a3ab6 by Doug Wilson at 2017-06-03T12:02:08+02:00
Disable pattern match warnings (#628)

This disables the pattern match checker which can be very expensive in some
cases.

The disabled warnings include:
* Opt_WarnIncompletePatterns
* Opt_WarnIncompleteUniPatterns
* Opt_WarnIncompletePatternsRecUpd
* Opt_WarnOverlappingPatterns
- - - - -
0cf68004 by Alex Biehl at 2017-06-03T20:37:28+02:00
Allow user defined signatures for pattern synonyms (#631)


- - - - -
7f51a58a by Alex Biehl at 2017-06-04T11:56:38+02:00
Use NameSet for isExported check (#632)


- - - - -
d8f044a9 by Alan Zimmerman at 2017-06-05T22:26:55+02:00
Match new AST as per GHC wip/new-tree-one-param

See https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow

- - - - -
da1254e3 by Alan Zimmerman at 2017-06-05T22:26:55+02:00
Rename extension index tags

- - - - -
538c7514 by Christiaan Baaij at 2017-06-09T08:26:43+02:00
Haddock support for bundled pattern synonyms (#627)

* Haddock support for bundled pattern synonyms

* Add fixities to bundled pattern synonyms

* Add bundled pattern synonyms to the synopsis

* Store bundled pattern fixities in expItemFixities

* Add test for bundled pattern synonyms

* Stop threading fixities

* Include bundled pattern synonyms for re-exported data types

Sadly, fixity information isn't found for re-exported data types

* Support for pattern synonyms

* Modify tests after haskell/haddock#631

* Test some reexport variations

* Also lookup bundled pattern synonyms from `InstalledInterface`s

* Check isExported for bundled pattern synonyms

* Pattern synonym is exported check

* Always look for pattern synonyms in the current module

Another overlooked cornercase

* Account for types named twice in export lists

Also introduce a fast function for nubbing on a `Name` and use it
throughout the code base.

* correct fixities for reexported pattern synonyms

* Fuse concatMap and map

* Remove obsolete import

* Add pattern synonyms to visible exports

* Fix test

* Remove corner case

- - - - -
a050bffd by Doug Wilson at 2017-06-21T09:27:33+02:00
Use new function getNameToInstancesIndex instead of tcRnGetInfo (#636)

There is some performance improvement.

GHC compiler:
| version | bytes allocated | cpu_seconds
---------------------------------
| before  | 56057108648     | 41.0
| after   | 51592019560     | 35.1

base:
| version | bytes allocated | cpu_seconds
---------------------------------
| before  | 25174011784     | 14.6
| after   | 23712637272     | 13.1

Cabal:

| version | bytes allocated | cpu_seconds
---------------------------------
| before  | 18754966920     | 12.6
| after   | 18198208864     | 11.6
- - - - -
5d06b871 by Doug Wilson at 2017-06-22T20:23:29+02:00
Use new function getNameToInstancesIndex instead of tcRnGetInfo (#639)

* Use new function getNameToInstancesIndex instead of tcRnGetInfo

There is some significant performance improvement in the ghc testsuite.

haddock.base: -23.3%
haddock.Cabal: -16.7%
haddock.compiler: -19.8%

* Remove unused imports

- - - - -
b11bb73a by Alex Biehl at 2017-06-23T14:44:41+02:00
Lookup fixities for reexports without subordinates (#642)

So we agree that reexported declarations which do not have subordinates (for example top-level functions) shouldn't have gotten fixities reexported according to the current logic. I wondered why for example Prelude.($) which is obviously reexported from GHC.Base has fixities attached (c.f. http://hackage.haskell.org/package/base-4.9.1.0/docs/Prelude.html#v:-36-).

The reason is this: In mkMaps we lookup all the subordinates of top-level declarations, of course top-level functions don't have subordinates so for them the resulting list is empty. In haskell/haddock#644 I established the invariant that there won't be any empty lists in the subordinate map. Without the patch from haskell/haddock#642 top-level functions now started to fail reexporting their fixities.
- - - - -
d2a6dad6 by Alex Biehl at 2017-06-23T18:30:45+02:00
Don't include names with empty subordinates in maps (#644)

These are unecessary anyway and just blow up interface size
- - - - -
69c2aac4 by Alex Biehl at 2017-06-29T19:54:49+02:00
Make per-argument docs for class methods work again (#648)

* Make per-argument docs for class methods work again

* Test case

- - - - -
c9448d54 by Bartosz Nitka at 2017-07-02T12:12:01+02:00
Fix haddock: internal error: links: UnhelpfulSpan (#561)

* Fix haddock: internal error: links: UnhelpfulSpan

This fixes haskell/haddock#554 for me. I believe this is another fall out
of `wildcard-refactor`, like haskell/haddock#549.

* Comment to clarify why we take the methods name location

- - - - -
d4f29eb7 by Alex Biehl at 2017-07-03T19:43:04+02:00
Document record fields when DuplicateRecordFields is enabled (#649)


- - - - -
9d6e3423 by Yuji Yamamoto at 2017-07-03T22:37:58+02:00
Fix test failures on Windows (#564)

* Ignore .stack-work

* Fix for windows: use nul instead of /dev/null

* Fix for windows: canonicalize line separator

* Also normalize osx line endings

- - - - -
7d81e8b3 by Yuji Yamamoto at 2017-07-04T16:13:12+02:00
Avoid errors on non UTF-8 Windows (#566)

* Avoid errors on non UTF-8 Windows

Problem
====

haddock exits with errors like below:

`(1)`

```
haddock: internal error: <stderr>: hPutChar: invalid argument (invalid character)
```

`(2)`

```
haddock: internal error: Language\Haskell\HsColour\Anchors.hs: hGetContents: invalid argument (invalid byte sequence)
```

`(1)` is caused by printing [the "bullet" character](http://www.fileformat.info/info/unicode/char/2022/index.htm) onto stderr.
For example, this warning contains it:

```
Language\Haskell\HsColour\ANSI.hs:62:10: warning: [-Wmissing-methods]
    • No explicit implementation for
        ‘toEnum’
    • In the instance declaration for ‘Enum Highlight’
```

`(2)` is caused when the input file of `readFile` contains some Unicode characters.
In the case above, '⇒' is the cause.

Environment
----

OS: Windows 10
haddock: 2.17.3
GHC: 8.0.1

Solution
====

Add `hSetEncoding handle utf8` to avoid the errors.

Note
====

- I found the detailed causes by these changes for debugging:
    - https://github.com/haskell/haddock/commit/8f29edb6b02691c1cf4c479f6c6f3f922b35a55b
    - https://github.com/haskell/haddock/commit/1dd23bf2065a1e1f2c14d0f4abd847c906b4ecb4
- These errors happen even after executing `chcp 65001` on the console.
  According to the debug code, `hGetEncoding stderr` returns `CP932` regardless of the console encoding.

* Avoid 'internal error: <stderr>: hPutChar: invalid argument (invalid character)' non UTF-8 Windows

Better solution for 59411754a6db41d17820733c076e6a72bcdbd82b's (1)

- - - - -
eded67d2 by Alex Biehl at 2017-07-07T19:17:15+02:00
Remove redudant import warning (#651)


- - - - -
05114757 by Alex Biehl at 2017-07-08T00:33:12+02:00
Avoid missing home module warning (#652)

* Avoid missing home module warning

* Update haddock-library.cabal

- - - - -
e9cfc902 by Bryn Edwards at 2017-07-17T07:51:20+02:00
Fix haskell/haddock#249 (#655)


- - - - -
eb02792b by Herbert Valerio Riedel at 2017-07-20T09:09:15+02:00
Fix compilation of lib:haddock-library w/ GHC < 8

- - - - -
9200bfbc by Alex Biehl at 2017-07-20T09:20:38+02:00
Prepare 2.18.1 release (#657)


- - - - -
46ddd22c by Herbert Valerio Riedel at 2017-07-20T10:05:14+02:00
Tweak haddock-api.cabal for pending release

- - - - -
85e33d29 by Herbert Valerio Riedel at 2017-07-20T10:05:14+02:00
Avoid trivial use of LambdaCase

otherwise we can't test w/ e.g. GHC 7.4.2

- - - - -
3afb4bfe by Herbert Valerio Riedel at 2017-07-20T10:05:14+02:00
Refactor .cabal to use sub-lib for vendored lib

A practical benefit is that we can control the build-depends and also
avoid some recompilation between library and test-suite.

- - - - -
e56a552e by Herbert Valerio Riedel at 2017-07-20T10:17:48+02:00
haddock-api: add changelog pointing to haddock's changelog

This addresses
https://github.com/haskell/haddock/issues/638#issuecomment-309283297

- - - - -
2222ff0d by Herbert Valerio Riedel at 2017-07-20T10:19:56+02:00
Drop obsolete/misleading `stability: experimental`

This .cabal property has long been considered obsolete

- - - - -
9b882905 by Alex Biehl at 2017-07-20T11:25:54+02:00
Beef up haddock description (#658)

* Beef up haddock description

* Handle empty lines

- - - - -
bb60e95c by Herbert Valerio Riedel at 2017-07-20T12:08:53+02:00
Import @aisamanra's Haddock cheatsheet

from https://github.com/aisamanra/haddock-cheatsheet

- - - - -
0761e456 by Herbert Valerio Riedel at 2017-07-20T12:12:55+02:00
Add cheatsheet to haddock.cabal

- - - - -
2ece0f0f by Herbert Valerio Riedel at 2017-07-20T12:18:38+02:00
Mention new-build in README

- - - - -
947b7865 by Herbert Valerio Riedel at 2017-07-20T12:32:16+02:00
Update README

Also improves markup and removes/fixes redundant/obsolete parts

[skip ci]

- - - - -
785e09ad by Alex Biehl at 2017-07-27T07:28:57+02:00
Bump haddock to 2.18.2, haddock-library to 1.4.5

- - - - -
e3ff1ca3 by Alex Biehl at 2017-07-31T20:15:32+02:00
Move `DocMarkup` from haddock-api to haddock-library (#659)

* Move `DocMarkup` from haddock-api to haddock-library

* Move more markup related functions

* Markup module

* CHANGELOG

- - - - -
cda7c20c by Alex Biehl at 2017-07-31T20:35:49+02:00
Fixup haddock
- - - - -
583b6812 by Alex Biehl at 2017-07-31T21:20:45+02:00
Changelog for haddock-library

- - - - -
bac6a0eb by Alex Biehl at 2017-07-31T21:50:24+02:00
Prepare haddock-library-1.4.5 release

- - - - -
58ce6877 by Moritz Drexl at 2017-08-05T16:44:40+02:00
Fix renaming after instance signature specializing (#660)

* rework rename

* Add regression test for Bug 613

* update tests

* update changelog

- - - - -
b8137ec8 by Tim Baumann at 2017-08-06T11:33:38+02:00
Fix: Generate pattern signatures for constructors exported as patterns (#663)

* Fix pretty-printing of pattern signatures

Pattern synonyms can have up to two contexts, both having a
different semantic meaning: The first holds the constraints
required to perform the matching, the second contains the
constraints provided by a successful pattern match. When the
first context is empty but the second is not it is necessary
to render the first, empty context.

* Generate pattern synonym signatures for ctors exported as patterns

This fixes haskell/haddock#653.

* Simplify extractPatternSyn

It is not necessary to generate the simplest type signature since
it will be simplified when pretty-printed.

* Add changelog entries for PR haskell/haddock#663

* Fix extractPatternSyn error message

- - - - -
d037086b by Alex Biehl at 2017-08-06T12:43:25+02:00
Bump haddock-library
- - - - -
99d7e792 by Alex Biehl at 2017-08-06T12:44:07+02:00
Bump haddock-library in haddock-api
- - - - -
94802a5b by Alex Biehl at 2017-08-06T13:18:02+02:00
Provide --show-interface option to dump interfaces (#645)

* WIP: Provide --show-interface option to dump interfaces

Like ghcs own --show-iface this flag dumps a binary interface file to
stdout in a human (and machine) readable fashion. Currently it uses
json as output format.

* Fill all the jsonNull stubs

* Rework Bifunctor instance of DocH, update changelog and documentation

* replace changelog, bring DocMarkupH doc back

* Update CHANGES.md

* Update CHANGES.md

* Move Control.Arrow up

It would result in unused import if the Bifunctor instance is not generated.

- - - - -
c662e476 by Ryan Scott at 2017-08-14T21:00:21-04:00
Adapt to haskell/haddock#14060

- - - - -
b891eb73 by Alex Biehl at 2017-08-16T08:24:48+02:00
Bifoldable and Bitraversable for DocH and MetaDoc

- - - - -
021bb56c by Alex Biehl at 2017-08-16T09:06:40+02:00
Refactoring: Make doc renaming monadic

This allows us to later throw warnings if can't find an identifier

- - - - -
39fbf022 by Alex Biehl at 2017-08-19T20:35:27+02:00
Hyperlinker: Avoid linear lookup in enrichToken (#669)

* Make Span strict in Position

* Hyperlinker: Use a proper map to enrich tokens

- - - - -
e13baedd by Alex Biehl at 2017-08-21T20:05:42+02:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
27dd6e87 by Alex Biehl at 2017-08-21T22:06:35+02:00
Drop Avails from export list

- - - - -
86b247e2 by Alex Biehl at 2017-08-22T08:44:22+02:00
Bump ghc version for haddock-api tests

- - - - -
d4607ca0 by Alex Biehl at 2017-08-22T08:45:17+02:00
Revert "Drop Avails from export list"

This reverts commit a850ba86d88a4fb9c0bd175453a2580e544e3def.

- - - - -
c9c54c30 by Alex Biehl at 2017-08-22T09:26:01+02:00
IntefaceFile version

- - - - -
a85b7c02 by Ben Gamari at 2017-08-22T09:29:52-04:00
haddock: Add Documentation.Haddock.Markup to other-modules

- - - - -
34e976f5 by Ben Gamari at 2017-08-22T17:40:06+02:00
haddock: Add Documentation.Haddock.Markup to other-modules

- - - - -
577abf06 by Ryan Scott at 2017-08-23T14:47:29-04:00
Update for haskell/haddock#14131

- - - - -
da68fc55 by Florian Eggenhofer at 2017-08-27T18:21:56+02:00
Generate an index for package content search (#662)

Generate an index for package content search
- - - - -
39e62302 by Alex Biehl at 2017-08-27T18:50:16+02:00
Content search for haddock html doc

- - - - -
91fd6fb2 by Alex Biehl at 2017-08-28T18:39:58+02:00
Fix tests for content search

- - - - -
b4a3798a by Alex Biehl at 2017-08-28T18:44:08+02:00
Add search button to #page-menu

- - - - -
25a7ca65 by Alex Biehl at 2017-08-28T18:47:43+02:00
Load javascript below the fold

- - - - -
8d323c1a by Alex Biehl at 2017-08-28T18:49:22+02:00
Accept tests

- - - - -
c5dac557 by Alex Biehl at 2017-08-28T19:14:55+02:00
Content search css

- - - - -
89a5af57 by Paolo Veronelli at 2017-08-29T07:42:13+02:00
Removed `nowrap` for interface method sigs (#674)

with nowrap the interfaces method sigs would expand at libitum
- - - - -
a505f6f7 by Alex Biehl at 2017-08-29T08:05:33+02:00
Include subordinates in content index

- - - - -
4bb698c4 by Alexander Biehl at 2017-08-29T11:40:19+02:00
QuickNav: Make docbase configurable

- - - - -
c783bf44 by Alexander Biehl at 2017-08-29T11:48:36+02:00
QuickNav: Also use baseUrl for doc-index.json request

- - - - -
47017510 by Alex Biehl at 2017-08-29T17:56:47+02:00
Fix test fallout (again)

- - - - -
924fc318 by Alex Biehl at 2017-08-30T09:24:56+02:00
Write meta.json when generating html output (#676)


- - - - -
717dea52 by Alex Biehl at 2017-09-01T09:20:34+02:00
Use relative URL when no docBaseUrl given
- - - - -
e5d85f3b by Alex Biehl at 2017-09-01T09:35:19+02:00
Add missing js files to data-files (#677)


- - - - -
95b9231a by Alex Biehl at 2017-09-01T11:01:36+02:00
Rename "Search" tab to "Quick Jump"
- - - - -
da0ead0b by Alex Biehl at 2017-09-01T13:03:49+02:00
Make trigger link configurable (#678)

QuickNav: Configurable show/hide trigger
- - - - -
de7da594 by Ben Gamari at 2017-09-05T06:49:55-04:00
Account for "Remember the AvailInfo for each IE"

As of GHC commit f609374a55bdcf3b79f3a299104767aae2ffbf21 GHC retains the
AvailInfo associated with each IE. @alexbiehl has a patch making proper use of
this change, but this is just to keep things building.

- - - - -
b05cd3b3 by Ben Gamari at 2017-09-14T07:55:07-04:00
Bump upper bound on base

- - - - -
79db899e by Herbert Valerio Riedel at 2017-09-21T23:27:52+02:00
Make compatible with Prelude.<> export in GHC 8.4/base-4.11

- - - - -
3405dd52 by Tim Baumann at 2017-09-23T22:02:01+02:00
Add compile step that bundles and compresses JS files (#684)

* Add compile step that bundles and compresses JS files

Also, manage dependencies on third-party JS libraries using NPM.

* Compile JS from TypeScript

* Enable 'noImplicitAny' in TypeScript

* QuickJump: use JSX syntax

* Generate source maps from TypeScript for easier debugging

* TypeScript: more accurate type

* Separate quick jump css file from ocean theme

- - - - -
df0b5742 by Alex Biehl at 2017-09-29T21:15:40+02:00
Bump base for haddock-library and haddock-test

- - - - -
62b12ea0 by Merijn Verstraaten at 2017-10-04T16:03:13+02:00
Inhibit output of coverage information for hidden modules. (#687)

* Inhibit output of coverage information for hidden modules.

* Add changelog entry.

- - - - -
8daf8bc1 by Alexander Biehl at 2017-10-05T11:27:05+02:00
Don't use subMap in attachInstances

- - - - -
ad75114e by Alexander Biehl at 2017-10-05T11:27:58+02:00
Revert "Don't use subMap in attachInstances"

This reverts commit 3adf5bcb1a6c5326ab33dc77b4aa229a91d91ce9.

- - - - -
7d4aa02f by Alex Biehl at 2017-10-08T15:32:28+02:00
Precise Haddock: Use Avails for export resolution (#688)

* Use Avails for export resolution

* Support reexported modules

* Factor out availExportItem

* Use avails for fullModuleExports

* Don't use subMap in attachInstances

* lookupDocs without subMap

* Completely remove subMap

* Only calculate unqualified modules when explicit export list is given

* Refactor

* Refine comment

* return

* Fix

* Refactoring

* Split avail if declaration is not exported itself

* Move avail splitting

- - - - -
b9b4faa8 by Alex Biehl at 2017-10-08T19:38:21+02:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
43325295 by Alex Biehl at 2017-10-08T20:18:46+02:00
Fix merge fallout

- - - - -
c6423cc0 by Alex Biehl at 2017-10-08T20:36:12+02:00
Copy QuickJump files over

- - - - -
1db587c3 by Tim Baumann at 2017-10-09T18:33:09+02:00
Use <details> element for collapsibles (#690)

* Remove unnecessary call to 'collapseSection'

The call is unnecessary since there is no corresponding toggle for hiding the
section of orphan instances.

* Use <details> for collapsibles

This makes them work even when JS is disabled. Closes haskell/haddock#560.

- - - - -
1b54c64b by Tim Baumann at 2017-10-10T09:50:59+02:00
Quick Jump: Show error when loading 'doc-index.json' failed (#691)


- - - - -
910f716d by Veronika Romashkina at 2017-10-24T07:36:20+02:00
Fix tiny typo in docs (#693)


- - - - -
b21de7e5 by Ryan Scott at 2017-10-24T13:07:15+02:00
Overhaul Haddock's rendering of kind signatures (#681)

* Overhaul Haddock's rendering of kind signatures

* Strip off kind signatures when specializing

As an added bonus, this lets us remove an ugly hack specifically for `(->)`.
Yay!

* Update due to 0390e4a0f61e37bd1dcc24a36d499e92f2561b67

* @alexbiehl's suggestions

* Import injectiveVarsOfBinder from GHC

- - - - -
6704405c by Ryan Scott at 2017-10-28T07:10:27+02:00
Fix Haddock rendering of kind-indexed data family instances (#694)


- - - - -
470f6b9c by Alex Biehl at 2017-10-30T08:45:51+01:00
Add QuickJump version to meta.json (#696)


- - - - -
b89eccdf by Alex Biehl at 2017-10-30T10:15:49+01:00
Put Quickjump behind --quickjump flag (#697)


- - - - -
3095fb58 by Alex Biehl at 2017-10-30T19:09:06+01:00
Add build command to package.json

- - - - -
f223fda9 by Alex Biehl at 2017-10-30T19:10:39+01:00
Decrease threshold for fuzzy matching

- - - - -
80245dda by Edward Z. Yang at 2017-10-31T20:35:05+01:00
Supported reexported-modules via --reexport flag.

Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>

- - - - -
7e389742 by Alex Biehl at 2017-10-31T20:37:56+01:00
Correct missing title in changelog

- - - - -
1a2a1c03 by Alex Biehl at 2017-10-31T20:59:07+01:00
Copy quickjump.css for nicer error messages

- - - - -
db234bb9 by Alex Biehl at 2017-10-31T21:31:18+01:00
Reexported modules: Report warnings if argument cannot be parsed or

... module cannot be found

- - - - -
eea8a205 by Carlo Hamalainen at 2017-10-31T21:43:14+01:00
More general type for nameCacheFromGhc. (#539)


- - - - -
580eb42a by Alex Biehl at 2017-10-31T21:46:52+01:00
Remote tab

- - - - -
0e599498 by Alex Biehl at 2017-10-31T21:48:55+01:00
Merge remote-tracking branch 'origin/master' into ghc-head

- - - - -
7b8539bb by Alex Biehl at 2017-10-31T22:28:34+01:00
fullModuleContents traverses exports in declaration order

- - - - -
0c91fbf2 by Alex Biehl at 2017-10-31T22:32:31+01:00
Remove excessive use of list comprehensions

- - - - -
f7356e02 by Alex Biehl at 2017-11-01T19:11:03+01:00
Make better use of AvailInfo

- - - - -
f3e512d5 by Alex Biehl at 2017-11-02T12:16:22+01:00
Always return documentation for exported subordinates

... event if they have no documentation (e.g. noDocForDecl)

By using the information in the AvailInfo we don't need additional
export checks.

- - - - -
7cf58898 by Alan Zimmerman at 2017-11-07T08:28:03+02:00
Match changes for Trees that Grow in GHC

- - - - -
e5105a41 by Alan Zimmerman at 2017-11-08T17:21:58+02:00
Match Trees That Grow

- - - - -
55178266 by Alan Zimmerman at 2017-11-11T22:20:31+02:00
Match Trees that Grow in GHC for HsExpr

- - - - -
2082ab02 by Ryan Scott at 2017-11-14T15:27:03+01:00
Actually render infix type operators as infix (#703)

* Actually render infix type operators as infix

* Account for things like `(f :*: g) p`, too

- - - - -
c52ab7d0 by Alan Zimmerman at 2017-11-14T23:14:26+02:00
Clean up use of PlaceHolder, to match TTG

- - - - -
81cc9851 by Moritz Angermann at 2017-11-20T07:52:49+01:00
Declare use of `Paths_haddock` module in other-modules (#705)

This was detected by `-Wmissing-home-modules`
- - - - -
f9d27598 by Moritz Angermann at 2017-11-20T12:47:34+01:00
Drop Paths_haddock from ghc.mk (#707)

With haskell/haddock#705 and haskell/haddock#706, the custom addition should not be necessary any more.
# Conflicts:
#	ghc.mk
- - - - -
f34818dc by Moritz Angermann at 2017-11-20T12:47:59+01:00
Add autogen-modules (#706)

> Packages using 'cabal-version: >= 1.25' and the autogenerated module Paths_* must include it also on the 'autogen-modules' field besides 'exposed-modules' and 'other-modules'. This specifies that the module does not come with the package and is generated on setup. Modules built with a custom Setup.hs script also go here to ensure that commands like sdist don't fail.
# Conflicts:
#	haddock.cabal
- - - - -
bb43a0aa by Ben Gamari at 2017-11-21T15:50:12-05:00
Revert "Clean up use of PlaceHolder, to match TTG"

This reverts commit 134a7bb054ea730b13c8629a76232d73e3ace049.

- - - - -
af9ebb2b by Ben Gamari at 2017-11-21T15:50:14-05:00
Revert "Match Trees that Grow in GHC for HsExpr"

This reverts commit 9f054dc365379c66668de6719840918190ae6e44.

- - - - -
5d35c3af by Ben Gamari at 2017-11-21T15:50:15-05:00
Revert "Match Trees That Grow"

This reverts commit 73a26af844ac50b8bec39de11d64452a6286b00c.

- - - - -
99a8e43b by Ben Gamari at 2017-11-21T16:36:06-05:00
Revert "Match changes for Trees that Grow in GHC"

This reverts commit 01eeeb048acd2dd05ff6471ae148a97cf0720547.

- - - - -
c4d650c2 by Ben Gamari at 2017-12-04T15:06:07-05:00
Bump GHC version

- - - - -
027b2274 by Ben Gamari at 2017-12-04T17:06:31-05:00
Bump GHC bound to 8.4.*

- - - - -
58eaf755 by Alex Biehl at 2017-12-06T15:44:24+01:00
Update changelog
- - - - -
d68f5584 by Simon Peyton Jones at 2017-12-07T14:39:56+00:00
Track changes to follow Trac haskell/haddock#14529

This tracks the refactoring of HsDecl.ConDecl.

- - - - -
dc519d6b by Alec Theriault at 2018-01-06T08:20:43-08:00
Pass to GHC visible modules for instance filtering

The GHC-side `getNameToInstancesIndex` filters out incorrectly some
instances because it is not aware of what modules are visible. On the
Haddock side, we need to pass in the modules we are processing.

On the GHC side, we need to check against _those_ modules when checking
if an instance is visible.

- - - - -
8285118c by Alec Theriault at 2018-01-13T12:12:37+01:00
Constructor and pattern synonym argument docs (#709)

* Support Haddocks on constructor arguments

This is in conjunction with https://phabricator.haskell.org/D4094.
Adds support for rendering Haddock's on (non-record) constructor
arguments, both for regular and GADT constructors.

* Support haddocks on pattern synonym arguments

It appears that GHC already parsed these - we just weren't using them.
In the process of doing this, I tried to deduplicate some code around
handling patterns.

* Update the markup guide

Add some information about the new support for commenting constructor
arguments, and mention pattern synonyms and GADT-style constructors.

* Overhaul LaTeX support for data/pattern decls

This includes at least

  * fixing several bugs that resulted in invalid LaTeX
  * fixing GADT data declaration headers
  * overhaul handling of record fields
  * overhaul handling of GADT constructors
  * overhaul handling of bundled patterns
  * add support for constructor argument docs

* Support GADT record constructors

This means changes what existing HTML docs look like.

As for LaTeX, looks like GADT records were never even supported. Now they are.

* Clean up code/comments

Made code/comments consistent between the LaTeX and XHTML backend
when possible.

* Update changelog

* Patch post-rebase regressions

* Another post-rebase change

We want return values to be documentable on record GADT constructors.

- - - - -
ca4fabb4 by Alec Theriault at 2018-01-15T17:12:18-08:00
Update the GblRdrEnv when processing modules

Without a complete environment, we will miss some instances that were
encountered during typechecking.

- - - - -
4c472fea by Ryan Scott at 2018-01-19T10:44:02+01:00
Fix haskell/haddock#732 (#733)


- - - - -
bff14dbd by Alex Biehl at 2018-01-19T15:33:30+01:00
extractDecl: Extract associated types correctly (#736)


- - - - -
a2a94a73 by Alex Biehl at 2018-01-19T15:34:40+01:00
extractDecl: Extract associated types correctly (#736)


- - - - -
26df93dc by Alex Biehl at 2018-01-20T10:18:22+01:00
haddock-api: bump ghc to ^>= 8.4

- - - - -
f65aeb1d by Alex Biehl at 2018-01-20T19:18:20+01:00
Fix duplicate declarations and TypeFamilies specifics

- - - - -
0e721b97 by Alex Biehl at 2018-01-20T19:20:19+01:00
Fix duplicate declarations and TypeFamilies specifics

- - - - -
cb6234f6 by Ben Gamari at 2018-01-26T13:40:55-05:00
Merge remote-tracking branch 'harpocrates/fix/missing-orphan-instances' into ghc-head

- - - - -
0fc28554 by Alec Theriault at 2018-02-01T14:58:18+01:00
Pass to GHC visible modules for instance filtering

The GHC-side `getNameToInstancesIndex` filters out incorrectly some
instances because it is not aware of what modules are visible. On the
Haddock side, we need to pass in the modules we are processing.

On the GHC side, we need to check against _those_ modules when checking
if an instance is visible.

- - - - -
b9123772 by Alec Theriault at 2018-02-01T14:58:18+01:00
Update the GblRdrEnv when processing modules

Without a complete environment, we will miss some instances that were
encountered during typechecking.

- - - - -
0c12e274 by Ryan Scott at 2018-02-01T14:58:18+01:00
Fix haskell/haddock#548 by rendering datatype kinds more carefully (#702)

- - - - -
8876d20b by Alec Theriault at 2018-02-01T14:58:18+01:00
Use the GHC lexer for the Hyperlinker backend (#714)

* Start changing to use GHC lexer

* better cpp

* Change SrcSpan to RealSrcSpan

* Remove error

* Try to stop too many open files

* wip

* wip

* Revert "wip"

This reverts commit b605510a195f26315e3d8ca90e6d95a6737553e1.

Conflicts:
	haddock-api/haddock-api.cabal
	haddock-api/src/Haddock/Interface.hs

* Remove pointless 'caching'

* Use dlist rather than lists when finding vars

* Use a map rather than list

* Delete bogus comment

* Rebase followup

Things now run using the GHC lexer. There are still

  - stray debug statements
  - unnecessary changes w.r.t. master

* Cleaned up differences w.r.t. current Haddock HEAD

Things are looking good. quasiquotes in particular look beautiful: the
TH ones (with Haskell source inside) colour/link their contents too!

Haven't yet begun to check for possible performance problems.

* Support CPP and top-level pragmas

The support for these is hackier - but no more hacky than the existing
support.

* Tests pass, CPP is better recognized

The tests were in some cases altered: I consider the new output to be more
correct than the old one....

* Fix shrinking of source without tabs in test

* Replace 'Position'/'Span' with GHC counterparts

Replaces 'Position' -> 'GHC.RealSrcLoc' and 'Span' -> 'GHC.RealSrcSpan'.

* Nits

* Forgot entry in .cabal

* Update changelog

- - - - -
95c6a771 by Alec Theriault at 2018-02-01T14:58:18+01:00
Clickable anchors for headings (#716)

See haskell/haddock#579. This just adds an <a> tag around the heading, pointing to the
heading itself.
- - - - -
21463d28 by Alex Biehl at 2018-02-01T14:58:18+01:00
Quickjump: Matches on function names weight more than matches in ...

module names.

- - - - -
8023af39 by Alex Biehl at 2018-02-01T14:58:18+01:00
Treat escaped \] better in definition lists (#717)

This fixes haskell/haddock#546.
- - - - -
e4866dc1 by Alex Biehl at 2018-02-01T14:58:18+01:00
Remove scanner, takeWhile1_ already takes care of escaping

- - - - -
9bcaa49d by Alex Biehl at 2018-02-01T14:58:18+01:00
Take until line feed

- - - - -
01d2af93 by Oleg Grenrus at 2018-02-01T14:58:18+01:00
Add simple framework for running parser fixtures (#668)

* Add simple framework for running parser fixtures

* Compatible with tree-diff-0.0.0.1

* Use parseParas to parse fixtures

This allows to test all syntactic constructs available in haddock
markup.

- - - - -
31128417 by Alec Theriault at 2018-02-01T14:58:18+01:00
Patch flaky parser test (#720)

* Patch flaky parser test

This test was a great idea, but it doesn't port over too well to using
the GHC lexer. GHC rewrites its input a bit - nothing surprising, but
we need to guard against those cases for the test.

* Change instance head

* Change use site

- - - - -
9704f214 by Herbert Valerio Riedel at 2018-02-01T14:58:18+01:00
Include secondary LICENSE file in source dist

- - - - -
51f25074 by Oleg Grenrus at 2018-02-01T14:58:18+01:00
Grid Tables (#718)

* Add table examples

* Add table types and adopt simple parser

Simple parser is done by Giovanni Cappellotto (@potomak)
in https://github.com/haskell/haddock/pull/577
It seems to support single fine full tables, so far from full
RST-grid tables, but it's good start.

Table type support row- and colspans, but obviously parser is lacking.

Still TODO:
- Latex backend. Should we use multirow package
  https://ctan.org/pkg/multirow?lang=en?
- Hoogle backend: ?

* Implement grid-tables

* Refactor table parser

* Add two ill-examples

* Update CHANGES.md

* Basic documentation for tables

* Fix documentation example

- - - - -
670d6200 by Alex Biehl at 2018-02-01T14:58:18+01:00
Add grid table example to cheatsheet

(pdf and svg need to be regenerated thought)
- - - - -
4262dec9 by Alec Theriault at 2018-02-01T14:58:18+01:00
Fix infinite loop when specializing instance heads (#723)

* Fix infinite loop when specializing instance heads

The bug can only be triggered from TH, hence why it went un-noticed for
so long.

* Add test for haskell/haddock#679 and haskell/haddock#710

- - - - -
67ecd803 by Alec Theriault at 2018-02-01T14:58:18+01:00
Filter RTS arguments from 'ghc-options' arguments (#725)

This fixes haskell/haddock#666.
- - - - -
7db26992 by Alex Biehl at 2018-02-01T14:58:18+01:00
Quickjump Scrollable overlay
- - - - -
da9ff634 by Alexander Biehl at 2018-02-01T14:58:18+01:00
Hyperlinker: Adjust parser to new PFailed constructor

- - - - -
7b7cf8cb by Alexander Biehl at 2018-02-01T14:58:18+01:00
Specialize: Add missing IdP annotations

- - - - -
78cd7231 by Alexander Biehl at 2018-02-01T14:58:18+01:00
Convert: Correct pass type

- - - - -
a2d0f590 by Alexander Biehl at 2018-02-01T14:58:18+01:00
Warning free compilation

- - - - -
cd861cf3 by Alexander Biehl at 2018-02-01T14:58:18+01:00
hadock-2.19.0 / haddock-api-2.19.0 / haddock-library-1.5.0

- - - - -
c6651b72 by Alexander Biehl at 2018-02-01T14:58:18+01:00
Adjust changelogs

- - - - -
1e93da0b by Alexander Biehl at 2018-02-01T14:58:18+01:00
haddock-library: Info about breaking changes

- - - - -
f9b11db8 by Alec Theriault at 2018-02-02T12:36:02+01:00
Properly color pragma contents in hyperlinker

The hyperlinker backend now classifies the content of pragmas as
'TkPragma'. That means that in something like '{-# INLINE foo #-}',
'foo' still gets classified as a pragma token.

- - - - -
c40b0043 by Alec Theriault at 2018-02-02T12:36:02+01:00
Support the new 'ITcolumn_prag' token

- - - - -
4a2a4d39 by Alex Biehl at 2018-02-03T12:11:55+01:00
QuickJump: Mitigate encoding problems on Windows

- - - - -
bb34503a by Alex Biehl at 2018-02-04T18:39:31+01:00
Use withBinaryFile

- - - - -
637605bf by Herbert Valerio Riedel at 2018-02-05T09:48:32+01:00
Try GHC 8.4.1 for Travis CI job

- - - - -
7abb67e4 by Herbert Valerio Riedel at 2018-02-05T10:05:42+01:00
try harder to build w/ GHC 8.4.1

- - - - -
8255cc98 by Herbert Valerio Riedel at 2018-02-05T10:05:42+01:00
Add `SPDX-License-Identifier` as alised for "license" module header tokens

C.f. SPDX 2.1 - Appendix V
 https://spdx.org/spdx-specification-21-web-version#h.twlc0ztnng3b

    The tag should appear on its own line in the source file, generally as part of a comment.

    SPDX-License-Identifier: <SPDX License Expression>

Cherry-picked from haskell/haddock#743

- - - - -
267cd23d by Herbert Valerio Riedel at 2018-02-05T10:24:34+01:00
Make test-suite SMP compatible

- - - - -
95d4bf40 by Alec Theriault at 2018-02-05T22:01:04+01:00
Hyperlink pattern synonyms and 'module' imports (#744)

Links to pattern synonyms are now generated, as well as links from
modules in import lists.

Fixes haskell/haddock#731.
- - - - -
67838dcd by Alec Theriault at 2018-02-06T08:23:36+01:00
Don't warn about missing '~' (#746)

This manually filters out '~' from the list of things to warn about. It truly
makes no sense to warn on this since '~' has nothing it could link to - it is
magical.

This fixes haskell/haddock#532.
- - - - -
ab6c3f9f by Alec Theriault at 2018-02-06T08:24:47+01:00
Don't barf on 'HsSpliceTy' (#745)

This handles 'HsSpliceTy's by replacing them with what they expand to.
IIUC everything that is happening, 'renameHsSpliceTy' should not be
able to fail for the inputs we feed it from GHC.

This fixes haskell/haddock#574.

- - - - -
92bf95ad by Alex Biehl at 2018-02-06T08:28:23+01:00
Rename: renameHsSpliceTy ttg

- - - - -
3130b1e1 by Alex Biehl at 2018-02-06T09:02:14+01:00
Expand SigDs

- - - - -
c72adae5 by Alex Biehl at 2018-02-06T09:20:51+01:00
fullModuleContents: support named docs

- - - - -
de2e4dbf by Alex Biehl at 2018-02-06T13:56:17+01:00
Hyperlinker: Also link pattern synonym arguments

- - - - -
b7c98237 by Alex Biehl at 2018-02-09T18:44:23+01:00
Expand SigD in a better place

In https://github.com/haskell/haddock/issues/287 we found that
haddock-2.19.0 would miss documentation on class methods with
multiples names.

This patch uses expandSigDecls in a more sensible place.

- - - - -
8f598b27 by Alec Theriault at 2018-02-11T12:29:56+01:00
Add module tooltips to linked identifiers (#753)

No more clicking to figure out whether your bytestring is strict or lazy!
- - - - -
d812e65d by Alec Theriault at 2018-02-11T12:31:44+01:00
Add 'show' option to complement 'hide' (#752)

* Add 'show' option to complement 'hide'

The behaviour is for flags passed in the command line to override
flags in file headers. In the command line, later flags override
earlier ones.

Fixes haskell/haddock#751 and haskell/haddock#266.

* Add a '--show-all' option

- - - - -
6676cecb by Alex Biehl at 2018-02-18T11:07:15-05:00
QuickJump: Mitigate encoding problems on Windows

(cherry picked from commit 86292c54bfee2343aee84559ec01f1fc68f52231)

- - - - -
e753dd88 by Alex Biehl at 2018-02-18T17:59:54+01:00
Use withBinaryFile

- - - - -
724dc881 by Tamar Christina at 2018-02-19T05:34:49+01:00
Haddock: support splitted include paths. (#689)


- - - - -
9b6d6f50 by Alex Biehl at 2018-02-19T05:57:02+01:00
Teach the HTML backend how to render methods with multiple names

- - - - -
a74aa754 by Alexander Biehl at 2018-02-19T10:04:34+01:00
Hoogle/Latex: Remove use of partial function

- - - - -
66d8bb0e by Alec Theriault at 2018-02-25T16:04:01+01:00
Fix file handle leak (#763) (#764)

Brought back some mistakenly deleted code for handling encoding and eager
reading of files from e0ada1743cb722d2f82498a95b201f3ffb303137.
- - - - -
bb92d03d by Alex Biehl at 2018-03-02T14:21:23+01:00
Enable running test suite with stock haddock and ghc using

```
$ cabal new-run -- html-test --haddock-path=$(which haddock) --ghc-path=$(which ghc)
```

- - - - -
dddb3cb2 by Alex Biehl at 2018-03-02T15:43:21+01:00
Make testsuite work with haddock-1.19.0 release (#766)


- - - - -
f38636ed by Alec Theriault at 2018-03-02T15:48:36+01:00
Support unicode operators, proper modules

Unicode operators are a pretty big thing in Haskell, so supporting linking them
seems like it outweighs the cost of the extra machinery to force Attoparsec to
look for unicode.

Fixes haskell/haddock#458.

- - - - -
09d89f7c by Alec Theriault at 2018-03-02T15:48:43+01:00
Remove bang pattern

- - - - -
d150a687 by Alex Biehl at 2018-03-02T15:48:48+01:00
fix test

- - - - -
d6fd71a5 by Alex Biehl at 2018-03-02T16:22:38+01:00
haddock-test: Be more explicit which packages to pass

We now pass `-hide-all-packages` to haddock when invoking the
testsuite. This ensures we don't accidentally pick up any dependencies
up through ghc.env files.

- - - - -
0932c78c by Alex Biehl at 2018-03-02T17:50:38+01:00
Revert "fix test"

This reverts commit 1ac2f9569242f6cb074ba6e577285a4c33ae1197.

- - - - -
52516029 by Alex Biehl at 2018-03-02T18:16:50+01:00
Fix Bug548 for real

- - - - -
89df9eb5 by Alex Biehl at 2018-03-05T18:28:19+01:00
Hyperlinker: Links for TyOps, class methods and associated types

- - - - -
d019a4cb by Ryan Scott at 2018-03-06T13:43:56-05:00
Updates for haskell/haddock#13324

- - - - -
6d5a42ce by Alex Biehl at 2018-03-10T18:25:57+01:00
Bump haddock-2.19.0.1, haddock-api-2.19.0.1, haddock-library-1.5.0.1

- - - - -
c0e6f380 by Alex Biehl at 2018-03-10T18:25:57+01:00
Update changelogs for haddock-2.19.0.1 and haddock-library-1.5.0.1

- - - - -
500da489 by Herbert Valerio Riedel at 2018-03-10T18:25:57+01:00
Update to QC 2.11

- - - - -
ce8362e9 by Herbert Valerio Riedel at 2018-03-10T18:25:57+01:00
Restore backward-compat with base-4.5 through base-4.8

- - - - -
baae4435 by Alex Biehl at 2018-03-10T18:25:57+01:00
Bump lower bound for haddock-library

- - - - -
10b7a73e by Alex Biehl at 2018-03-10T18:25:57+01:00
Haddock: Straighten out base bound

- - - - -
a6096f7b by Alex Biehl at 2018-03-13T08:45:06+01:00
extractDecl: Extract constructor patterns from data family instances (#776)

* extractDecl: Allow extraction of data family instance constructors

* extractDecl: extract data family instance constructors

- - - - -
ba4a0744 by Simon Jakobi at 2018-03-14T08:26:42+01:00
Readme: Update GHC version (#778)


- - - - -
8de157d4 by Simon Jakobi at 2018-03-14T20:39:29+01:00
Add fixture test for definition lists

- - - - -
425b46f9 by Simon Jakobi at 2018-03-14T20:39:29+01:00
Add fixture test for links

- - - - -
d53945d8 by Simon Jakobi at 2018-03-14T20:39:29+01:00
Add fixture test for inline links

- - - - -
f1dc7c99 by Simon Jakobi at 2018-03-14T20:39:29+01:00
fixtures: Slightly unmangle output

- - - - -
0879d31c by Simon Jakobi at 2018-03-14T20:39:29+01:00
fixtures: Prevent stdout buffering

- - - - -
1f9e5f1b by Simon Jakobi at 2018-03-14T20:39:29+01:00
haddock-library.cabal: Clean up GHC options

- - - - -
066b891a by Simon Jakobi at 2018-03-14T20:39:29+01:00
Make a proper definition for the <link> parser

- - - - -
573d6ba7 by Alec Theriault at 2018-03-21T09:16:57+01:00
Show where instances are defined (#748)

* Indicate source module of instances

Above instance, we now also display a link to the module where the
instance was defined. This is sometimes helpful in figuring out
what to import.

* Source module for type/data families too

* Remove parens

* Accept tests

- - - - -
99b5d28b by Alex Biehl at 2018-03-21T09:20:36+01:00
Prepare changelog for next release

- - - - -
482d3a93 by Alex Biehl at 2018-03-23T15:57:36+01:00
Useful cost centres, timers and allocation counters (#785)

* Add some useful cost-centres for profiling

* Add withTiming for each haddock phase

Invoking haddock with `--optghc=-ddump-timings` now shows the amount
of time spent and the number of allocated bytes for each phase.

- - - - -
773b41bb by Alec Theriault at 2018-03-27T08:35:59+02:00
@since includes package name (#749)

* Metadoc stores a package name

This means that '@since' annotations can be package aware.

* Get the package name the right way

This should extract the package name for `@since` annotations the
right way. I had to move `modulePackageInfo` around to do this and,
in the process, I took the liberty to update it.

Since it appears that finding the package name is something that can
fail, I added a warning for this case.

* Silence warnings

* Hide package for local 'since' annotations

As discussed, this is still the usual case (and we should avoid being
noisy for it).

Although this commit is large, it is basically only about threading a
'Maybe Package' from 'Haddock.render' all the way to
'Haddock.Backends.Xhtml.DocMarkup.renderMeta'.

* Bump binary interface version

* Add a '--since-qual' option

This controls when to qualify since annotations with the package they
come from. The default is always, but I've left an 'external' variant
where only those annotations coming from outside of the current
package are qualified.

* Make ParserSpec work

* Make Fixtures work

* Use package name even if package version is not available

The @since stuff needs only the package name passed in, so it
makes sense to not be forced to pass in a version too.

- - - - -
e42c57bc by Alex Biehl at 2018-03-27T08:42:50+02:00
haddock-2.19.1, haddock-api-2.19.1, haddock-library-1.6.0

- - - - -
8373a529 by Alex Biehl at 2018-03-28T10:17:11+02:00
Bump haddock and haddock-api to 2.20.0

- - - - -
5038eddd by Jack Henahan at 2018-04-03T13:28:12+02:00
Clear search string on hide for haskell/haddock#781 (#789)


- - - - -
920ca1eb by Alex Biehl at 2018-04-03T16:35:50+02:00
Travis: Build with ghc-8.4.2 (#793)


- - - - -
a232f0eb by Alan Zimmerman at 2018-04-07T14:14:32+02:00
Match changes in GHC for D4199

Removing HasSourceText and SourceTextX classes.

- - - - -
ab85060b by Alan Zimmerman at 2018-04-09T21:20:24+02:00
Match GHC changes for TTG

- - - - -
739302b6 by Alan Zimmerman at 2018-04-13T13:31:44+02:00
Match GHC for TTG implemented on HsBinds, D4581

- - - - -
2f56d3cb by Ryan Scott at 2018-04-19T11:42:58-04:00
Bump upper bound on base to < 4.13

See https://ghc.haskell.org/trac/ghc/ticket/15018.

- - - - -
a49df92a by Alex Biehl at 2018-04-20T07:31:44+02:00
Don't treat fixity signatures like declarations

- - - - -
d02c103b by Ryan Scott at 2018-04-24T11:20:11-04:00
Add regression test for haskell/haddock#413

Fixes haskell/haddock#413.

- - - - -
c7577f52 by Ryan Scott at 2018-04-24T13:51:06-07:00
Improve the Hoogle backend's treatment of type families (#808)

Fixes parts 1 and 2 of haskell/haddock#806.
- - - - -
d88f85b1 by Alec Theriault at 2018-04-25T11:24:07-07:00
Replace 'attoparsec' with 'parsec' (#799)

* Remove attoparsec with parsec and start fixing failed parses

* Make tests pass

* Fix encoding issues

The Haddock parser no longer needs to worry about bytestrings. All
the internal parsing work in haddock-library happens over 'Text'.

* Remove attoparsec vendor

* Fix stuff broken in 'attoparsec' -> 'parsec'

* hyperlinks
* codeblocks
* examples

Pretty much all issues are due to attoparsec's backtracking failure
behaviour vs. parsec's non-backtracking failure behaviour.

* Fix small TODOs

* Missing quote + Haddocks

* Better handle spaces before/after paragraphs

* Address review comments

- - - - -
fc25e2fe by Alan Zimmerman at 2018-04-27T15:36:53+02:00
Match changes in GHC for TTG

- - - - -
06175f91 by Herbert Valerio Riedel at 2018-05-01T18:11:09+02:00
Merge branch 'ghc-head' with 'ghc-8.4'

- - - - -
879caaa8 by Alec Theriault at 2018-05-07T18:53:15-07:00
Filter out CRLFs in hyperlinker backend (#813)

This prevents spurious lines from appearing in the final output.
- - - - -
3e0120cb by Simon Jakobi at 2018-05-07T19:00:18-07:00
Add docs for some DocH constructors (#814)


- - - - -
0a32c6db by Alec Theriault at 2018-05-08T02:15:45-07:00
Remove 'TokenGroup' from Hyperlinker (#818)

Since the hyperlinker backend now relies on the GHC tokenizer, something
like 'Bar.Baz.foo' already gets bunched together into one token (as
opposed to being spread across 'Bar', '.', 'Baz', '.', and 'foo').
- - - - -
8816e783 by Simon Jakobi at 2018-05-08T10:48:11-07:00
Renamer: Warn about out of scope identifiers. (#819)


- - - - -
ad60366f by Ryan Scott at 2018-05-10T11:19:47-04:00
Remove Hoogle backend hack that butchers infix datatype names

- - - - -
03b7cc3b by Ryan Scott at 2018-05-10T11:24:38-04:00
Wibbles

- - - - -
b03dd563 by Chaitanya Koparkar at 2018-05-10T11:44:58-04:00
Use the response file utilities defined in `base` (#821)

Summary: The response file related modules were recently copied from
`haddock` into `base`. This patch removes them from `haddock`.

GHC Trac Issues: haskell/haddock#13896
- - - - -
9f298a40 by Ben Gamari at 2018-05-13T17:36:04-04:00
Account for refactoring of LitString

- - - - -
ea3dabe7 by Ryan Scott at 2018-05-16T09:21:43-04:00
Merge pull request haskell/haddock#826 from haskell/T825

Remove Hoogle backend hack that butchers infix datatype names
- - - - -
0d234f7c by Alec Theriault at 2018-05-23T11:29:05+02:00
Use `ClassOpSig` instead of `TypeSig` for class methods (#835)

* Fix minimal pragma handling

Class declarations contain 'ClassOpSig' not 'Typesig'. This should fix haskell/haddock#834.

* Accept html-test output

- - - - -
15fc9712 by Simon Jakobi at 2018-05-31T04:17:47+02:00
Adjust to new HsDocString internals

- - - - -
6f1e19a8 by Ben Gamari at 2018-06-02T16:18:58-04:00
Remove ParallelArrays and Data Parallel Haskell

- - - - -
0d0355d9 by Ryan Scott at 2018-06-04T21:26:59-04:00
DerivingVia changes

- - - - -
0d93475a by Simon Jakobi at 2018-06-05T19:47:05+02:00
Bump a few dependency bounds (#845)


- - - - -
5cbef804 by Alec Theriault at 2018-06-05T19:47:16+02:00
Improve hyperlinker's 'spanToNewline' (#846)

'spanToNewline' is used to help break apart the source into lines which
can then be partioned into CPP and non-CPP chunks. It is important that
'spanToNewline' not break apart tokens, so it needs to properly handle
things like

  * block comments, possibly nested
  * string literals, possibly multi-line
  * CPP macros, possibly multi-line

String literals in particular were not being properly handled. The fix
is to to fall back in 'Text.Read.lex' to help lex things that are not
comments.

Fixes haskell/haddock#837.
- - - - -
9094c56f by Alec Theriault at 2018-06-05T22:53:25+02:00
Extract docs from strict/unpacked constructor args (#839)

This fixes haskell/haddock#836.
- - - - -
70188719 by Simon Jakobi at 2018-06-08T22:20:30+02:00
Renamer: Warn about ambiguous identifiers (#831)

* Renamer: Warn about ambiguous identifiers

Example:

    Warning: 'elem' is ambiguous. It is defined
        * in ‘Data.Foldable’
        * at /home/simon/tmp/hdk/src/Lib.hs:7:1
        You may be able to disambiguate the identifier by qualifying it or
        by hiding some imports.
        Defaulting to 'elem' defined at /home/simon/tmp/hdk/src/Lib.hs:7:1

Fixes haskell/haddock#830.

* Deduplicate warnings

Fixes haskell/haddock#832.

- - - - -
495cd1fc by Chaitanya Koparkar at 2018-06-13T23:01:34+02:00
Use the response file utilities defined in `base` (#821)

Summary: The response file related modules were recently copied from
`haddock` into `base`. This patch removes them from `haddock`.

GHC Trac Issues: haskell/haddock#13896
- - - - -
81088732 by Ben Gamari at 2018-06-13T23:01:34+02:00
Account for refactoring of LitString

- - - - -
7baf6587 by Simon Jakobi at 2018-06-13T23:05:08+02:00
Adjust to new HsDocString internals

- - - - -
bb61464d by Ben Gamari at 2018-06-13T23:05:22+02:00
Remove ParallelArrays and Data Parallel Haskell

- - - - -
5d8cb87f by Ryan Scott at 2018-06-13T23:39:30+02:00
DerivingVia changes

- - - - -
73d373a3 by Alec Theriault at 2018-06-13T23:39:30+02:00
Extract docs from strict/unpacked constructor args (#839)

This fixes haskell/haddock#836.
- - - - -
4865e254 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Remove `ITtildehsh` token

- - - - -
b867db54 by Alec Theriault at 2018-06-13T23:39:30+02:00
Filter out CRLFs in hyperlinker backend (#813)

This prevents spurious lines from appearing in the final output.
- - - - -
9598e392 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Add docs for some DocH constructors (#814)


- - - - -
8a59035b by Alec Theriault at 2018-06-13T23:39:30+02:00
Remove 'TokenGroup' from Hyperlinker (#818)

Since the hyperlinker backend now relies on the GHC tokenizer, something
like 'Bar.Baz.foo' already gets bunched together into one token (as
opposed to being spread across 'Bar', '.', 'Baz', '.', and 'foo').
- - - - -
29350fc8 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Renamer: Warn about out of scope identifiers. (#819)


- - - - -
2590bbd9 by Ryan Scott at 2018-06-13T23:39:30+02:00
Remove Hoogle backend hack that butchers infix datatype names

- - - - -
a9939fdc by Ryan Scott at 2018-06-13T23:39:30+02:00
Wibbles

- - - - -
a22f7df4 by Alec Theriault at 2018-06-13T23:39:30+02:00
Use `ClassOpSig` instead of `TypeSig` for class methods (#835)

* Fix minimal pragma handling

Class declarations contain 'ClassOpSig' not 'Typesig'. This should fix haskell/haddock#834.

* Accept html-test output

- - - - -
8741015d by Simon Jakobi at 2018-06-13T23:39:30+02:00
Bump a few dependency bounds (#845)


- - - - -
4791e1cc by Alec Theriault at 2018-06-13T23:39:30+02:00
Improve hyperlinker's 'spanToNewline' (#846)

'spanToNewline' is used to help break apart the source into lines which
can then be partioned into CPP and non-CPP chunks. It is important that
'spanToNewline' not break apart tokens, so it needs to properly handle
things like

  * block comments, possibly nested
  * string literals, possibly multi-line
  * CPP macros, possibly multi-line

String literals in particular were not being properly handled. The fix
is to to fall back in 'Text.Read.lex' to help lex things that are not
comments.

Fixes haskell/haddock#837.
- - - - -
311d3216 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Renamer: Warn about ambiguous identifiers (#831)

* Renamer: Warn about ambiguous identifiers

Example:

    Warning: 'elem' is ambiguous. It is defined
        * in ‘Data.Foldable’
        * at /home/simon/tmp/hdk/src/Lib.hs:7:1
        You may be able to disambiguate the identifier by qualifying it or
        by hiding some imports.
        Defaulting to 'elem' defined at /home/simon/tmp/hdk/src/Lib.hs:7:1

Fixes haskell/haddock#830.

* Deduplicate warnings

Fixes haskell/haddock#832.

- - - - -
d0577817 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Complete FixitySig and FamilyDecl pattern matches

- - - - -
055b3aa7 by Simon Jakobi at 2018-06-13T23:39:30+02:00
Fix redundant import warnings

- - - - -
f9ce19b1 by Simon Jakobi at 2018-06-13T23:49:52+02:00
html-test: Accept output

- - - - -
04604ea7 by Simon Jakobi at 2018-06-13T23:54:37+02:00
Bump bounds on Cabal

- - - - -
0713b692 by Simon Jakobi at 2018-06-14T00:00:12+02:00
Merge branch 'ghc-head' into ghc-head-update-3

- - - - -
c6a56bfd by Simon Jakobi at 2018-06-14T02:33:27+02:00
Bump ghc bound for haddock-api spec test-suite

- - - - -
119d04b2 by Simon Jakobi at 2018-06-14T12:37:48+02:00
Travis: `--allow-newer` for all packages

- - - - -
0e876e2c by Alex Biehl at 2018-06-14T15:28:52+02:00
Merge pull request haskell/haddock#857 from sjakobi/ghc-head-update-3

Update ghc-head
- - - - -
5be46454 by Alec Theriault at 2018-06-14T21:42:45+02:00
Improved handling of interfaces in 'haddock-test' (#851)

This should now work with an inplace GHC where (for instance)
HTML directories may not be properly recorded in the package DB.
- - - - -
96ab1387 by Vladislav Zavialov at 2018-06-14T17:06:21-04:00
Handle -XStarIsType

- - - - -
e518f8c4 by Ben Gamari at 2018-06-14T17:48:00-04:00
Revert unintentional reversion of fix of haskell/haddock#548

- - - - -
01b9f96d by Alan Zimmerman at 2018-06-19T11:52:22+02:00
Match changes in GHC for haskell/haddock#14259

- - - - -
7f8c8298 by Ben Gamari at 2018-06-19T18:14:27-04:00
Bump GHC version to 8.6

- - - - -
11c6b5d2 by Ryan Scott at 2018-06-19T23:17:31-04:00
Remove HsEqTy and XEqTy

- - - - -
b33347c2 by Herbert Valerio Riedel at 2018-06-20T23:14:52+02:00
Revert "Bump GHC version to 8.6"

This was applied to the wrong branch; there's now a `ghc-8.6` branch;
ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version.
The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7

This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1.

- - - - -
f0d2460e by Herbert Valerio Riedel at 2018-06-20T23:28:46+02:00
Update Travis CI job

- - - - -
ef239223 by Herbert Valerio Riedel at 2018-06-20T23:32:41+02:00
Drop GHC HEAD from CI and update GHC to 8.4.3

It's a waste of resource to even try to build this branch w/ ghc-head;
so let's not do that...

- - - - -
41c4a9fa by Ben Gamari at 2018-06-20T18:26:20-04:00
Bump GHC version to 8.7

- - - - -
8be593dc by Herbert Valerio Riedel at 2018-06-21T22:32:15+02:00
Update CI job to use GHC 8.7.*

- - - - -
b91d334a by Simon Jakobi at 2018-06-30T13:41:38+02:00
README updates (#856)

* README: Remove mentions of master branch

* README: Add instructions for using html-test

* README: Change command to run _all_ the testsuites

* README: Add project overview section

- - - - -
f707d848 by Alec Theriault at 2018-07-05T10:43:35-04:00
Export more fixities for Hoogle (#871)

This exports fixities for more things, including class methods and
type-level operators.
- - - - -
a6d2b8dc by Alec Theriault at 2018-07-06T10:06:32-04:00
Avoid line breaks due to line length in Hoogle (#868)

* Avoid line breaks due to line length in Hoogle

Hoogle operates in a line-oriented fashion, so we should avoid ever
breaking due to long lines.

One way of doing this non-intrusively is to modify the 'DynFlags' that
are threaded through the 'Hoogle' module (note this is anyways only
passed through for use in the various 'showSDoc' functions).

* Amend test case

- - - - -
13819f71 by Alan Zimmerman at 2018-07-15T19:33:51+02:00
Match XFieldOcc rename in GHC

Trac haskell/haddock#15386

- - - - -
c346aa78 by Simon Jakobi at 2018-07-19T12:29:32+02:00
haddock-library: Bump bounds for containers

- - - - -
722e733c by Simon Jakobi at 2018-07-19T13:36:45+02:00
tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)

* tyThingToLHsDecls: Preserve type synonyms that contain a forall

Fixes haskell/haddock#879.

* Add Note [Invariant: Never expand type synonyms]

* Clarify Note [Invariant: Never expand type synonyms]

- - - - -
f0bd83fd by Alec Theriault at 2018-07-19T14:39:57+02:00
Fix HEAD html-test (#860)

* Update tests for 'StarIsType'

* Accept tests

* Revert "Update tests for 'StarIsType'"

This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a.

- - - - -
394053a8 by Simon Jakobi at 2018-07-19T14:58:07+02:00
haddock-library: Bump bounds for containers

- - - - -
1bda11a2 by Alec Theriault at 2018-07-20T09:04:03+02:00
Add HEAD.hackage overlay (#887)

* Add HEAD.hackage overlay

* Add HCPKG variable

- - - - -
c7b4ab45 by Alec Theriault at 2018-07-20T12:01:16+02:00
Refactor handling of parens in types (#874)

* Fix type parenthesization in Hoogle backend

Ported the logic in the HTML and LaTeX backends for adding in parens
into something top-level in 'GhcUtil'. Calling that from the Hoogle
backend fixes haskell/haddock#873.

* Remove parenthesizing logic from LaTeX and XHTML backends

Now, the only times that parenthesis in types are added in any backend
is through the explicit 'HsParTy' constructor. Precedence is also
represented as its own datatype.

* List out cases explicitly vs. catch-all

* Fix printing of parens for QuantifiedConstraints

The priority of printing 'forall' types was just one too high.

Fixes haskell/haddock#877.

* Accept HTML output for quantified contexts test

- - - - -
c05d32ad by Alec Theriault at 2018-07-20T12:01:49+02:00
Preserve docs on type family instances (#867)

* Preserve docs on type family instances

The only problem was that the instance location was slightly off
for type family instances.

* Accept output

- - - - -
24b39ee4 by Alec Theriault at 2018-07-20T12:02:16+02:00
Fix broken instance source links (#869)

The problem manifests itself in instances that are defined in
modules other than the module where the class is defined. The fix
is just to thread through the 'Module' of the instance further
along.

Since orphan instances appear to already have been working, I didn't
do anything there.
- - - - -
cb9d2099 by Simon Jakobi at 2018-07-20T13:39:29+02:00
README updates (#856)

* README: Remove mentions of master branch

* README: Add instructions for using html-test

* README: Change command to run _all_ the testsuites

* README: Add project overview section

(cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c)

- - - - -
133f24f5 by Alec Theriault at 2018-07-20T13:39:29+02:00
Export more fixities for Hoogle (#871)

This exports fixities for more things, including class methods and
type-level operators.

(cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce)

- - - - -
11024149 by Alec Theriault at 2018-07-20T13:39:29+02:00
Avoid line breaks due to line length in Hoogle (#868)

* Avoid line breaks due to line length in Hoogle

Hoogle operates in a line-oriented fashion, so we should avoid ever
breaking due to long lines.

One way of doing this non-intrusively is to modify the 'DynFlags' that
are threaded through the 'Hoogle' module (note this is anyways only
passed through for use in the various 'showSDoc' functions).

* Amend test case

(cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0)

- - - - -
de0c139e by Simon Jakobi at 2018-07-20T13:39:29+02:00
tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)

* tyThingToLHsDecls: Preserve type synonyms that contain a forall

Fixes haskell/haddock#879.

* Add Note [Invariant: Never expand type synonyms]

* Clarify Note [Invariant: Never expand type synonyms]

(cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9)

- - - - -
6435e952 by Alec Theriault at 2018-07-20T13:39:29+02:00
Preserve docs on type family instances (#867)

* Preserve docs on type family instances

The only problem was that the instance location was slightly off
for type family instances.

* Accept output

(cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4)

- - - - -
1461af39 by Alec Theriault at 2018-07-20T13:39:29+02:00
Fix broken instance source links (#869)

The problem manifests itself in instances that are defined in
modules other than the module where the class is defined. The fix
is just to thread through the 'Module' of the instance further
along.

Since orphan instances appear to already have been working, I didn't
do anything there.

(cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05)

- - - - -
69d3bde1 by Alec Theriault at 2018-07-20T13:49:47+02:00
Add some more unicode related tests (#872)

This has been fixed for sure ever since we switched from attoparsec to
parsec. Parts of it may have been working before that, but there was a
point where this would have failed (see haskell/haddock#191).

A regression test never hurt anyone. :)
- - - - -
6a5c73c7 by Alec Theriault at 2018-07-20T13:50:00+02:00
Misc tests (#858)

* More tests

* spliced types
* constructor/pattern argument docs
* strictness marks on fields with argument docs

* latex test cases need seperate directory

* Accept tests

- - - - -
92ca94c6 by Alec Theriault at 2018-07-20T13:55:36+02:00
Add some more unicode related tests (#872)

This has been fixed for sure ever since we switched from attoparsec to
parsec. Parts of it may have been working before that, but there was a
point where this would have failed (see haskell/haddock#191).

A regression test never hurt anyone. :)

(cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370)

- - - - -
981bc7fa by Simon Jakobi at 2018-07-20T15:06:06+02:00
Additional tests for the identifier parser (#816)

* Add tests for the identifier parser

* docs: Clarify how to delimit identifiers

- - - - -
27e7c0c5 by Simon Jakobi at 2018-07-20T15:09:05+02:00
Additional tests for the identifier parser (#816)

* Add tests for the identifier parser

* docs: Clarify how to delimit identifiers

(cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)

- - - - -
49e1a415 by Simon Jakobi at 2018-07-20T16:02:02+02:00
Update the ghc-8.6 branch (#889)

* Revert "Bump GHC version to 8.6"

This was applied to the wrong branch; there's now a `ghc-8.6` branch;
ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version.
The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7

This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1.

* README updates (#856)

* README: Remove mentions of master branch

* README: Add instructions for using html-test

* README: Change command to run _all_ the testsuites

* README: Add project overview section

(cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c)

* Export more fixities for Hoogle (#871)

This exports fixities for more things, including class methods and
type-level operators.

(cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce)

* Avoid line breaks due to line length in Hoogle (#868)

* Avoid line breaks due to line length in Hoogle

Hoogle operates in a line-oriented fashion, so we should avoid ever
breaking due to long lines.

One way of doing this non-intrusively is to modify the 'DynFlags' that
are threaded through the 'Hoogle' module (note this is anyways only
passed through for use in the various 'showSDoc' functions).

* Amend test case

(cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0)

* tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)

* tyThingToLHsDecls: Preserve type synonyms that contain a forall

Fixes haskell/haddock#879.

* Add Note [Invariant: Never expand type synonyms]

* Clarify Note [Invariant: Never expand type synonyms]

(cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9)

* Fix HEAD html-test (#860)

* Update tests for 'StarIsType'

* Accept tests

* Revert "Update tests for 'StarIsType'"

This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a.

* Refactor handling of parens in types (#874)

* Fix type parenthesization in Hoogle backend

Ported the logic in the HTML and LaTeX backends for adding in parens
into something top-level in 'GhcUtil'. Calling that from the Hoogle
backend fixes haskell/haddock#873.

* Remove parenthesizing logic from LaTeX and XHTML backends

Now, the only times that parenthesis in types are added in any backend
is through the explicit 'HsParTy' constructor. Precedence is also
represented as its own datatype.

* List out cases explicitly vs. catch-all

* Fix printing of parens for QuantifiedConstraints

The priority of printing 'forall' types was just one too high.

Fixes haskell/haddock#877.

* Accept HTML output for quantified contexts test

* Preserve docs on type family instances (#867)

* Preserve docs on type family instances

The only problem was that the instance location was slightly off
for type family instances.

* Accept output

(cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4)

* Fix broken instance source links (#869)

The problem manifests itself in instances that are defined in
modules other than the module where the class is defined. The fix
is just to thread through the 'Module' of the instance further
along.

Since orphan instances appear to already have been working, I didn't
do anything there.

(cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05)

* Add some more unicode related tests (#872)

This has been fixed for sure ever since we switched from attoparsec to
parsec. Parts of it may have been working before that, but there was a
point where this would have failed (see haskell/haddock#191).

A regression test never hurt anyone. :)

(cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370)

* Misc tests (#858)

* More tests

* spliced types
* constructor/pattern argument docs
* strictness marks on fields with argument docs

* latex test cases need seperate directory

* Accept tests

* Additional tests for the identifier parser (#816)

* Add tests for the identifier parser

* docs: Clarify how to delimit identifiers

(cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)

- - - - -
5ca14bed by Simon Jakobi at 2018-07-20T16:05:47+02:00
Revert "Revert "Bump GHC version to 8.6""

That commit didn't belong onto the ghc-8.6 branch.

This reverts commit acbaef3b9daf1d2dea10017964bf886e77a8e967.

- - - - -
2dd600dd by Simon Jakobi at 2018-07-20T16:18:21+02:00
Don't warn about ambiguous identifiers when the candidate names belong to the same type

This also changes the defaulting heuristic for ambiguous identifiers.
We now prefer local names primarily, and type constructors or class
names secondarily.

Partially fixes haskell/haddock#854.

- - - - -
fceb2422 by Simon Jakobi at 2018-07-20T16:18:21+02:00
outOfScope: Recommend qualifying the identifier

- - - - -
acea5d23 by Simon Jakobi at 2018-07-20T16:19:35+02:00
outOfScope: Recommend qualifying the identifier

(cherry picked from commit 73707ed58d879cc04cb644c5dab88c39ca1465b7)

- - - - -
1a83ca55 by Simon Jakobi at 2018-07-20T16:19:35+02:00
Don't warn about ambiguous identifiers when the candidate names belong to the same type

This also changes the defaulting heuristic for ambiguous identifiers.
We now prefer local names primarily, and type constructors or class
names secondarily.

Partially fixes haskell/haddock#854.

(cherry picked from commit d504a2864a4e1982e142cf88c023e7caeea3b76f)

- - - - -
48374451 by Masahiro Sakai at 2018-07-20T17:06:42+02:00
Add # as a special character (#884)

'#' has special meaning used for anchors and can be escaped using backslash.
Therefore it would be nice to be listed as special characters.
- - - - -
5e1a5275 by Alec Theriault at 2018-07-20T23:37:24+02:00
Let `haddock-test` bypass interface version check (#890)

This means `haddock-test` might

  * crash during deserialization
  * deserialize incorrectly

Still - it means things _might_ work where they were previously sure
not to.
- - - - -
27286754 by Yuji Yamamoto at 2018-07-23T08:16:01+02:00
Avoid "invalid argument (invalid character)" on non-unicode Windows (#892)

Steps to reproduce and the error message
====

```
> stack haddock basement
... snip ...
    Warning: 'A' is out of scope.
    Warning: 'haddock: internal error: <stdout>: commitBuffer: invalid argument (invalid character)
```

Environment
====

OS: Windows 10 ver. 1709
haddock: [HEAD of ghc-8.4 when I reproduce the error](https://github.com/haskell/haddock/commit/532b209d127e4cecdbf7e9e3dcf4f653a5605b5a). (I had to use this version to avoid another probrem already fixed in HEAD)
GHC: 8.4.3
stack: Version 1.7.1, Git revision 681c800873816c022739ca7ed14755e85a579565 (5807 commits) x86_64 hpack-0.28.2

Related pull request
====

https://github.com/haskell/haddock/pull/566
- - - - -
6729d361 by Alec Theriault at 2018-07-23T13:52:56-07:00
Accumulate explicitly which modules to load for 'attachInstances'

The old approach to fixing haskell/haddock#469, while correct, consumes a lot of
memory. We ended up with a HUGE 'GblRdrEnv' in 'ic_rn_gbl_env'. However,
'getNameToInstancesIndex' takes that environment and compresses it down
to a much smaller 'ModuleSet'.

Now, we compute that 'ModuleSet' explicitly as we process modules. That
way we can just tell 'getNameToInstancesIndex' what modules to load
(instead of it trying to compute that information from the interactive
context).

- - - - -
8cf4e6b5 by Ryan Scott at 2018-07-27T11:28:03-04:00
eqTyCon_RDR now lives in TysWiredIn

After GHC commit
http://git.haskell.org/ghc.git/commit/f265008fb6f70830e7e92ce563f6d83833cef071

- - - - -
1ad251a6 by Alan Zimmerman at 2018-07-30T13:28:09-04:00
Match XFieldOcc rename in GHC

Trac haskell/haddock#15386

(cherry picked from commit e3926b50ab8a7269fd6904b06e881745f08bc5d6)

- - - - -
8aea2492 by Richard Eisenberg at 2018-08-02T10:54:17-04:00
Update against new HsImplicitBndrs

- - - - -
e42cada9 by Alec Theriault at 2018-08-04T17:51:30+02:00
Latex type families (#734)

* Support for type families in LaTeX

The code is ported over from the XHTML backend.

* Refactor XHTML and LaTeX family handling

This is mostly a consolidation effort: stripping extra exports,
inlining some short definitions, and trying to make the backends
match.

The LaTeX backend now has preliminary support for data families,
although the only the data instance head is printed (not the actual constructors).

Both backends also now use "newtype" for newtype data family
instances.

* Add some tests

- - - - -
0e852512 by Alex Biehl at 2018-08-06T13:04:02+02:00
Make --package-version optional for --hoogle generation (#899)

* Make --package-version optional for --hoogle generation

* Import mkVersion

* It's makeVersion not mkVersion

- - - - -
d2abd684 by Noel Bourke at 2018-08-21T09:34:18+02:00
Remove unnecessary backslashes from docs (#908)

On
https://haskell-haddock.readthedocs.io/en/latest/markup.html#special-characters
the backslash and backtick special characters showed up with an extra
backslash before them – I think the escaping is not (or no longer)
needed for those characters in rst.
- - - - -
7a578a9e by Matthew Pickering at 2018-08-21T09:34:50+02:00
Load plugins when starting a GHC session (#905)

Fixes haskell/haddock#900
- - - - -
aa3d4db3 by Matthew Pickering at 2018-08-21T09:37:34+02:00
Load plugins when starting a GHC session (#905)

Fixes haskell/haddock#900
- - - - -
ede91744 by Alec Theriault at 2018-08-21T09:42:52+02:00
Better test output when Haddock crashes on a test (#902)

In particular: we report the tests that crashed seperately from the tests
that produced incorrect output. In order for tests to pass (and exit 0),
they must not crash and must produce the right output.
- - - - -
4a872b84 by Guillaume Bouchard at 2018-08-21T09:45:57+02:00
Fix a typo (#878)


- - - - -
4dbf7595 by Ben Sklaroff at 2018-08-21T12:04:09-04:00
Add ITcomment_line_prag token to Hyperlinker Parser

This token is necessary for parsing #line pragmas inside nested comments.

Reviewers: bgamari

Reviewed By: bgamari

Differential Revision: https://phabricator.haskell.org/D4935

- - - - -
9170b2a9 by Ben Gamari at 2018-08-21T17:55:15-04:00
Merge pull request haskell/haddock#893 from harpocrates/get-name-to-instances

Accumulate explicitly which modules to load for 'attachInstances'
- - - - -
d57b57cc by Ben Gamari at 2018-08-21T17:59:13-04:00
Merge branch 'ghc-head' of github.com:haskell/haddock into ghc-head

- - - - -
14601ca2 by Alec Theriault at 2018-08-21T19:09:37-04:00
Accumulate explicitly which modules to load for 'attachInstances'

The old approach to fixing haskell/haddock#469, while correct, consumes a lot of
memory. We ended up with a HUGE 'GblRdrEnv' in 'ic_rn_gbl_env'. However,
'getNameToInstancesIndex' takes that environment and compresses it down
to a much smaller 'ModuleSet'.

Now, we compute that 'ModuleSet' explicitly as we process modules. That
way we can just tell 'getNameToInstancesIndex' what modules to load
(instead of it trying to compute that information from the interactive
context).

(cherry picked from commit 5c7c596c51d69b92164e9ba920157b36ce2b2ec1)

- - - - -
438c645e by Matthew Pickering at 2018-08-21T19:12:39-04:00
Load plugins when starting a GHC session (#905)

Fixes haskell/haddock#900

(cherry picked from commit e6aa8fb47b9477cc5ef5e46097524fe83e080f6d)

- - - - -
a80c5161 by Alec Theriault at 2018-08-21T22:06:40-07:00
Better rendering of unboxed sums/tuples

* adds space after/before the '#' marks
* properly reify 'HsSumTy' in 'synifyType'

- - - - -
88456cc1 by Alec Theriault at 2018-08-21T22:06:40-07:00
Handle promoted tuples in 'synifyType'

When we have a fully applied promoted tuple, we can expand it out properly.

- - - - -
fd1c1094 by Alec Theriault at 2018-08-21T22:19:34-07:00
Accept test cases

- - - - -
6e80d9e0 by Alec Theriault at 2018-08-21T22:24:03-07:00
Merge pull request haskell/haddock#914 from harpocrates/feature/unboxed-stuff

Better rendering of unboxed sums, unboxed tuples, promoted tuples.
- - - - -
181a23f1 by Ben Gamari at 2018-08-23T15:53:48-04:00
Merge remote-tracking branch 'origin/ghc-8.6' into ghc-8.6

- - - - -
3a18c1d8 by Alec Theriault at 2018-08-27T14:15:25-07:00
Properly synify promoted list types

We reconstruct promoted list literals whenever possible. That means
that 'synifyType' produces

   '[Int, Bool, ()]

instead of

   (Int ': (() ': (Bool ': ([] :: [Type]))))

- - - - -
b4794946 by Alec Theriault at 2018-09-03T07:19:55-07:00
Only look at visible types when synifying a 'HsListTy'

The other types are still looked at when considering whether to make
a kind signature or not.

- - - - -
a231fce2 by Alec Theriault at 2018-09-03T07:38:10-07:00
Merge pull request haskell/haddock#922 from harpocrates/promoted-lists

Properly synify promoted list types
- - - - -
0fdf044e by Ningning Xie at 2018-09-15T10:25:58-04:00
Update according to GHC Core changes

- - - - -
7379b115 by Ningning Xie at 2018-09-15T15:40:18-04:00
update dataFullSig to work with Co Quantification

This should have been in the previous patch, but wasn't.

- - - - -
cf84a046 by Alec Theriault at 2018-09-17T20:12:18-07:00
Fix/add to various docs

* Add documentation for a bunch of previously undocumented
  options (fixes haskell/haddock#870)
* Extend the documentation of `--hoogle` considerably (see haskell/haddock#807)
* Describe how to add docs to `deriving` clauses (fixes haskell/haddock#912)
* Fix inaccurate docs about hyperlinking infix identifiers (fixes haskell/haddock#780)

- - - - -
ae017935 by Alec Theriault at 2018-09-22T08:32:16-07:00
Update Travis

- - - - -
d95ae753 by Alec Theriault at 2018-09-22T09:34:10-07:00
Accept failing tests

Also silence orphan warnings.

- - - - -
f3e67024 by Alec Theriault at 2018-09-22T09:41:23-07:00
Bump haddock-api-2.21.0, haddock-library-1.7.0

* Update CHANGELOGS
* Update new versions in Cabal files
* Purge references to ghc-8.4/master branches in README

- - - - -
3f136d4a by Alec Theriault at 2018-09-22T10:53:31-07:00
Turn haddock-library into a minor release

Fix some version bounds in haddock-library too.

- - - - -
b9def006 by Alec Theriault at 2018-09-22T13:07:35-07:00
keep cabal.project file

- - - - -
4909aca7 by Alec Theriault at 2018-10-16T09:36:30-07:00
Build on 7.4 and 7.8

- - - - -
99d20a28 by Herbert Valerio Riedel at 2018-10-16T18:45:52+02:00
Minor tweak to package description

- - - - -
a8059618 by Herbert Valerio Riedel at 2018-10-16T18:47:24+02:00
Merge pull request haskell/haddock#945

haddock-api 2.21.0 and haddock-library 1.6.1 release
- - - - -
2d9bdfc1 by Alec Theriault at 2018-10-16T10:54:21-07:00
Bump haddock-library to 1.7.0

The 1.6.1 release should've been a major bump, since types in
the `Documentation.Haddock.Parser.Monad` module changed. This version
makes that module internal (as it morally should be).

- - - - -
ed340cef by Alec Theriault at 2018-10-16T14:59:13-07:00
Merge branch 'ghc-8.4' into ghc-8.6

- - - - -
2821a8df by Alec Theriault at 2018-10-16T15:14:48-07:00
Merge branch 'ghc-8.6' into ghc-head

- - - - -
a722dc84 by Alec Theriault at 2018-10-16T16:28:55-07:00
Latex type families (#734)

* Support for type families in LaTeX

The code is ported over from the XHTML backend.

* Refactor XHTML and LaTeX family handling

This is mostly a consolidation effort: stripping extra exports,
inlining some short definitions, and trying to make the backends
match.

The LaTeX backend now has preliminary support for data families,
although the only the data instance head is printed (not the actual constructors).

Both backends also now use "newtype" for newtype data family
instances.

* Add some tests

- - - - -
63377496 by Alec Theriault at 2018-10-16T16:39:07-07:00
Update changelog

- - - - -
099a0110 by Alec Theriault at 2018-10-16T16:49:28-07:00
Merge pull request haskell/haddock#942 from harpocrates/update-docs

Fix & add to documentation
- - - - -
0927416f by Alec Theriault at 2018-10-16T16:50:14-07:00
Set UTF-8 encoding before writing files (#934)

This should fix haskell/haddock#929, as well as guard against future problems of this
sort in other places. Basically replaces 'writeFile' (which selects the
users default locale) with 'writeUtf8File' (which always uses utf8).
- - - - -
83b7b017 by Alec Theriault at 2018-10-16T17:42:05-07:00
Output pattern synonyms in Hoogle backend (#947)

* Output pattern synonyms in Hoogle backend

We were previously weren't outputting _any_ pattern synonyms, bundled or
not. Now, we output both.

Fixes haskell/haddock#946.

* Update changelog

- - - - -
81e5033d by Alec Theriault at 2018-10-16T18:04:40-07:00
Release `haddock{,-api}-2.22.0`

This version will accompany ghc-8.6.2

- - - - -
9661744e by Alex Biehl at 2018-10-18T08:14:32-07:00
Add NewOcean theme

And make it the default theme.

- - - - -
7ae6d722 by NunoAlexandre at 2018-10-18T08:14:32-07:00
Improve appearance and readability

These changes include:

- use latest Haskell's logo colors
- decrease #content width to improve readability
- use nicer font
- improve sizes and distances

- - - - -
37f8703d by NunoAlexandre at 2018-10-18T08:14:32-07:00
Include custom font in the html head

- - - - -
1d5e1d79 by NunoAlexandre at 2018-10-18T08:14:32-07:00
Update html test reference files

- - - - -
53b7651f by NunoAlexandre at 2018-10-18T08:14:32-07:00
Make it responsive

- It makes small screens taking more space than larger ones
- fixes a few issues present in small screens currently
- make it look good across different screen sizes.

- - - - -
6aa1aeb1 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Make the style consistent with hackage

Several things are addressed here:

- better responsive behaviour on the header
- better space usage
- consistent colors overall
- other nit PR comments

- - - - -
3a250c5c by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Place the package name before the menu links

This supports the expected responsive menu design, where the
package name appears above the menu links.

- - - - -
cae699b3 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Update html-test reference files

The package name element in the package-header is now a div instead of a
paragraph, and it is now above the menu ul.links instead of below.

- - - - -
2ec7fd2d by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Improve synopsis style and code

- Use CSS3 instead of loading pictures to show "+" and "-" symbols
- Drop redundant code

- - - - -
0c874c01 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Decrease space between code blocks

There was too much space between code blocks as pointed out by
reviewers.

- - - - -
85568ce2 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Add an initial-scale property to all haddock pages

This solves an issue reported about the content looking
incredibly small on mobile devices.

- - - - -
c1538926 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Address several PR comments

- Darken text color like done for hackage
- Move synopsis to left side
- Make table of contents stick to the left on wide screens
- Wrap links to avoid page overflow
- Improve expand/collapse buttons
- Fix issue with content size on mobile devices
- Fix issue with font-size on landscape mode
- Increase width of the content
- Change colors of table of contents and synopsis
- Etc

- - - - -
e6639e5f by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Make synopsis scrollable on wide screens

When the synopsis is longer than the screen, you can’t see its end
and you can't scroll down either, making the content unreachable.

- - - - -
1f0591ff by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Improve information density

- Reduce font size
- Improve space between and within code blocks
- Improve alignments
- Improve spacing within sub-blocks

- - - - -
bf083097 by NunoAlexandre at 2018-10-18T08:14:32-07:00
Minor adjustments

Bring in some adjustments made to hackage:
- link colors
- page header show everything when package title is too long

- - - - -
10375fc7 by NunoAlexandre at 2018-10-18T08:14:32-07:00
Fix responsive triggers overlap issue

The min and max width triggers have the same values,
which caused the style resolution to take an intersection of
both style declarations when the screen resolution had the size
of the limts (say 1280px), causing an odd behaviour and look.

- - - - -
95ff2f95 by NunoAlexandre at 2018-10-18T08:14:32-07:00
Fix issue with menu alignment on firefox

Reported and described here:
https://github.com/haskell/haddock/pull/721#issuecomment-374668869

- - - - -
dc86587e by Alex Biehl at 2018-10-18T08:14:32-07:00
Changelog entry for NewOcean

- - - - -
27195e47 by Herbert Valerio Riedel at 2018-10-18T08:14:32-07:00
html-test --accept

- - - - -
83f4f9c0 by Alex Biehl at 2018-10-18T08:14:32-07:00
Avoid name shadowing

- - - - -
231487f1 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Update font to PT Sans

Also migrate some general text related changes from hackage.

- - - - -
313db81a by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Use 'flex' to fix header alignment

- - - - -
5087367b by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Misc of tweaks

- Update link colors to hackage scheme
- Tune spacing between content elements
- Update footer style
- Fix and improve code blocks identation

- - - - -
b08020df by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Update font in Xhtml.hs to PT Sans

- - - - -
78ce06e3 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Improve code blocks styling

- Fix and improve spacing
- Improve colors and borders

- - - - -
81262d20 by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Make package-header caption backward-compatible

The current html generator of this branch wraps the package-header
caption as a div, which does not work (without style adjustments) with
the old themes. Changing it from div to span does the trick, without
needing to adjust the old stylesheets.

- - - - -
dc4475cb by Nuno Alexandre at 2018-10-18T08:14:32-07:00
Update test-suite reference html pages

- - - - -
393d35d8 by Alec Theriault at 2018-10-18T08:25:36-07:00
Accept tests

- - - - -
a94484ba by Alec Theriault at 2018-10-21T10:29:29-07:00
Fix CHANGELOG

- - - - -
8797eca3 by Alec Theriault at 2018-10-21T10:36:19-07:00
Update 'data-files' to include NewOcean stuff

- - - - -
1ae51e4a by Simon Jakobi at 2018-10-23T11:29:14+02:00
Fix typo in a warning

- - - - -
009ad8e8 by Alec Theriault at 2018-10-24T12:47:47-07:00
Update JS dependencies

This was done via `npm audit fix`. I think this fixes haskell/haddock#903 along with
some more serious vulnerabilities that nobody seems to have noticed.

- - - - -
051994db by Alec Theriault at 2018-10-24T17:31:09-07:00
Resurrect the style-switcher

This fixes haskell/haddock#810. Looks like things were broken during the quickjump
refactor of the JS.

For the (git) record: I do not think the style switcher is a good idea.
I'm fixing it for the same reason @mzero added it; as an answer to

  "rumblings from some that they didn't want their pixels changed on bit"

- - - - -
2a1d620f by Alec Theriault at 2018-10-24T17:38:07-07:00
Fix copy-pasta error in data-files

- - - - -
ed5bfb7f by Alec Theriault at 2018-10-24T20:42:14-07:00
Fix the synopsis button

Here's these changes are supposed to do:

  * put the synopsis back on the right side
  * properly have it on the edge of the screen on wide screens
  * adjust the background of the synopsis to match the button
    (otherwise the grey blends in with what is underneath)
  * get rid of the dotted purple line
  * the synopsis contents are now scrollable even when in wide
    screens (this has been a long-standing bug)

- - - - -
883fd74b by Alec Theriault at 2018-10-25T20:16:46-07:00
Avoid more conflicts in generated ids  (#954)

This fixes haskell/haddock#953 by passing more names into the generated ids.


- - - - -
ea54e331 by Alec Theriault at 2018-10-25T21:07:12-07:00
Don't hide bullets in method docs

I think thst CSS was meant only to deal with fields and the
effect on bullets was accidental.

Fixes haskell/haddock#926.

- - - - -
9a14ef4a by Alec Theriault at 2018-10-25T22:02:07-07:00
Indent more things + slightly smaller font

- - - - -
b9f17e29 by Alec Theriault at 2018-10-25T22:10:01-07:00
Merge branch 'ghc-8.6' into wip/new-ocean

- - - - -
096a3cfa by Alec Theriault at 2018-10-25T22:24:38-07:00
Accept HTML output

- - - - -
2669517d by Alec Theriault at 2018-10-26T09:02:35-07:00
User manual + stuff for building GHC docs

- - - - -
46b27687 by Alec Theriault at 2018-10-26T09:10:59-07:00
Make 'Contents' in NewOcean scrollable

This only happens if the contents block on the left is so big that it
doesn't fit (vertically) on the page. If that happens, we want it to
be scrollable.

- - - - -
3443dd94 by Alec Theriault at 2018-10-26T09:36:46-07:00
Revert "Make 'Contents' in NewOcean scrollable"

This reverts commit f909ffd8353d6463fd5dd184998a32aa98d5c922.

I missed the fact this also forces the 'Contents' to always go down
to the bottom of the page.

- - - - -
ed081424 by Alec Theriault at 2018-10-26T14:22:23-07:00
Avoid some partiality

AFAICT this wasn't causing any crashes, but that's mostly because
we happen not to be forcing `pkgStr` when it would diverge. We come
dangerously close to doing that in `ppHtmlIndex`.

Fixes haskell/haddock#569.

- - - - -
6a5bec41 by Alec Theriault at 2018-10-27T10:05:04-07:00
Fix documentation in `haddock-api` (#957)

* Fix misplaced Haddocks in Haddock itself

Haddock should be able to generate documentation for 'haddock-api'
again.

* Make CI check that documentation can be built.

* Add back a doc that is OK

- - - - -
5100450a by Matthew Yacavone at 2018-10-27T14:51:38-04:00
More explicit foralls (GHC Proposal 0007)

- - - - -
8771a6b0 by Alec Theriault at 2018-11-05T13:58:11-08:00
Only run MathJax on entities with "mathjax" class (#960)

Correspondingly, we wrap all inline/diplay math in

    <span class="mathjax"> ... the math .... </span>

This fixes haskell/haddock#959.
- - - - -
bd7ff5c5 by Alec Theriault at 2018-11-05T15:54:22-08:00
Deduplicate some work in 'AttachInstances'

Perf only change:

  * avoid needlessly union-ing maps
  * avoid synify-ing instances twice

Took this opportunity to add some docs too

- - - - -
cf99fd8f by Alec Theriault at 2018-11-05T15:54:22-08:00
Specialize some SYB functions

Perf only change:

  * Add a 'SPECIALIZE' pragma to help GHC optimize a 'Data a =>' constraint
  * Manually specialize the needlessly general type of 'specializeTyVarBndrs'

- - - - -
4f91c473 by Alec Theriault at 2018-11-05T15:54:22-08:00
Improve perf of renaming

Perf only change:

  * don't look up type variable names (they're never in the environment)
  * use a difference list for accumulating missing names
  * more efficient 'Functor'/'Applicative' instances for 'RnM'

- - - - -
4bbab0d4 by Alec Theriault at 2018-11-05T15:54:22-08:00
Faster 'Text' driven parser combinators

Perf only change:

  * use 'getParserState'/'setParserState' to make 'Text'-optimized
    parser combinators
  * minimize uses of 'Data.Text.{pack,unpack,cons,snoc}'

- - - - -
fa430c02 by Alec Theriault at 2018-11-06T12:03:24-08:00
Support hyperlink labels with inline markup

The parser for pictures hasn't been properly adjusted yet.

- - - - -
c1431035 by Alec Theriault at 2018-11-06T12:03:24-08:00
Support (and flatten) inline markup in image links

Inline markup is supported in image links but, as per the [commonmark
recommendation][0], it is stripped back to a plain text representation.

  [0]: https://spec.commonmark.org/0.28/#example-547

- - - - -
d4ee1ba5 by Alec Theriault at 2018-11-06T12:03:24-08:00
Accept test case

- - - - -
8088aeb1 by Alec Theriault at 2018-11-06T12:03:24-08:00
Fix/add to haddock-library test suite

- - - - -
e78f644d by Alec Theriault at 2018-11-06T13:26:31-08:00
Bump version bounds

- - - - -
644335eb by Alec Theriault at 2018-11-06T13:53:30-08:00
Merge pull request haskell/haddock#875 from harpocrates/feature/markup-in-hyperlinks

Inline markup in markdown-style links and images
- - - - -
e173ed0d by Alec Theriault at 2018-11-07T12:37:18-08:00
Fix issues around plus/minus

  * swap the minimize unicode to something more intuitive
  * use new unicode expander/collapser for instance lists
  * address some alignment issues in the "index" page

- - - - -
b2d92df7 by Alec Theriault at 2018-11-07T13:41:57-08:00
Allow "Contents" summary to scroll in a fixed div

In the unfortunate event that the "Contents" summary doesn't fit
vertically (like in the "Prelude"), it will be scrollable.

- - - - -
ca704c23 by Alec Theriault at 2018-11-07T13:45:15-08:00
Accept HTML output changes

- - - - -
82c0ec6d by Alec Theriault at 2018-11-07T18:12:54-08:00
overflow-y 'scroll' -> 'auto'

- - - - -
571d7657 by Alec Theriault at 2018-11-08T19:44:12-08:00
Clicking on "Contents" navigates to top of page

- - - - -
8065a012 by Alec Theriault at 2018-11-08T19:44:17-08:00
Space out functions more

Also, functions and data decls now have the same space before and after
them.

- - - - -
cc650ede by Alec Theriault at 2018-11-09T08:13:35-08:00
Merge branch 'ghc-8.6' into wip/new-ocean

- - - - -
65f8c17f by Alec Theriault at 2018-11-10T14:04:06-08:00
Update changelog

- - - - -
20473847 by Alec Theriault at 2018-11-10T14:21:40-08:00
Replace oplus/ominus expander/collapser icons with triangles

- - - - -
16592957 by Alec Theriault at 2018-11-10T14:35:10-08:00
Merge pull request haskell/haddock#949 from haskell/wip/new-ocean

Introduce NewOcean theme.
- - - - -
357cefe1 by Alec Theriault at 2018-11-10T16:02:13-08:00
Merge branch 'ghc-8.6' into ghc-head

- - - - -
de612267 by Alec Theriault at 2018-11-11T20:01:21-08:00
Rename 'NewOcean' theme to 'Linuwial'

- - - - -
954b5baa by Alec Theriault at 2018-11-12T08:33:18-08:00
Add blockquote styling

Matches b71da1feabf33efbbc517ac376bb690b5a604c2f from hackage-server.

Fixes haskell/haddock#967.

- - - - -
d32c0b0b by Fangyi Zhou at 2018-11-12T10:24:13-08:00
Fix some broken links (#15733)

Summary:
For links in subpackages as well.
https://phabricator.haskell.org/D5257

Test Plan: Manually verify links

Reviewers: mpickering, bgamari, osa1

Reviewed By: osa1

GHC Trac Issues: haskell/haddock#15733

Differential Revision: https://phabricator.haskell.org/D5262

- - - - -
41098b1f by Alp Mestanogullari at 2018-11-15T22:40:09+01:00
Follow GHC HEAD's HsTypes.Promoted -> BasicTypes.PromotionFlag change

It got introduced in ghc/ghc at ae2c9b40f5b6bf272251d1f4107c60003f541b62.

- - - - -
c5c1c7e0 by Alec Theriault at 2018-11-15T13:48:13-08:00
Merge pull request haskell/haddock#970 from alpmestan/alp/fix-promotionflag

Follow GHC HEAD's HsTypes.Promoted -> BasicTypes.PromotionFlag change
- - - - -
6473d3a4 by Shayan-Najd at 2018-11-23T01:38:49+01:00
[TTG: Handling Source Locations] Foundation and Pat
Trac Issues haskell/haddock#15495

This patch removes the ping-pong style from HsPat (only, for now), using the plan laid out at https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow/HandlingSourceLocations (solution A).
- the class `HasSrcSpan`, and its functions (e.g., `cL` and `dL`), are introduced
- some instances of `HasSrcSpan` are introduced
- some constructors `L` are replaced with `cL`
- some patterns `L` are replaced with `dL->L` view pattern
- some type annotation are necessarily updated (e.g., `Pat p` --> `Pat (GhcPass p)`)

- - - - -
7a088dfe by Alec Theriault at 2018-11-26T11:11:28-08:00
More uniform handling of `forall`'s in HTML/LaTeX

 * don't forget to print explicit `forall`'s when there are arg docs
 * when printing an explicit `forall`, print all tyvars

Fixes haskell/haddock#973

- - - - -
d735e570 by Alec Theriault at 2018-12-12T08:42:09-08:00
Fix warnings, accept output

* remove redundant imports (only brought to light due to recent work for
  improving redundant import detection)
* fix a bug that was casuing exports to appear in reverse order
* fix something in haddock-library that prevented compilation on old GHC's

- - - - -
a3852f8a by Zejun Wu at 2018-12-14T09:37:47-05:00
Output better debug infromation on internal error in extractDecl

This will make investigation of haskell/haddock#979 easier

- - - - -
2eccb5b9 by Alec Theriault at 2018-12-17T09:25:10-05:00
Refactor names + unused functions (#982)

This commit should not introduce any change in functionality!

  * consistently use `getOccString` to convert `Name`s to strings
  * compare names directly when possible (instead of comparing strings)
  * get rid of unused utility functions
- - - - -
e82e4df8 by Alec Theriault at 2018-12-20T16:16:30-05:00
Load plugins when compiling each module (#983)

* WIP: Load (typechecker) plugins from language pragmas

* Revert "Load plugins when starting a GHC session (#905)"

This reverts commit 72d82e52f2a6225686d9668790ac33c1d1743193.

* Simplify plugin initialization code

- - - - -
96e86f38 by Alec Theriault at 2018-12-23T10:23:20-05:00
Properly synify and render promoted type variables  (#985)

* Synify and render properly promoted type variables

Fixes haskell/haddock#923.

* Accept output

- - - - -
23343345 by Alec Theriault at 2018-12-27T16:39:38-05:00
Remove `haddock-test`'s dep. on `syb` (#987)

The functionality is easily inlined into one short function: `gmapEverywhere`.
This doesn't warrant pulling in another package.
- - - - -
d0734f21 by Alec Theriault at 2018-12-27T16:39:52-05:00
Address deprecation warnings in `haddock-test` (#988)

Fixes haskell/haddock#885.
- - - - -
4d9f144e by mynguyen at 2018-12-30T23:42:26-05:00
Visible kind application haddock update

- - - - -
ffe0e9ed by Alec Theriault at 2019-01-07T13:55:22-08:00
Print kinded tyvars in constructors for Hoogle (#993)

Fixes haskell/haddock#992
- - - - -
2e18b55d by Alec Theriault at 2019-01-10T16:42:45-08:00
Accept new output `GHC.Maybe` -> `Data.Maybe` (#996)

Since 53874834b779ad0dfbcde6650069c37926da1b79 in GHC, "GHC.Maybe"
is marked as `not-home`. That changes around some test output.
- - - - -
055da666 by Gabor Greif at 2019-01-22T14:41:51+01:00
Lone typofix
- - - - -
01bb71c9 by Alec Theriault at 2019-01-23T11:46:46-08:00
Keep forall on H98 existential data constructors (#1003)

The information about whether or not there is a source-level `forall`
is already available on a `ConDecl` (as `con_forall`), so we should use
it instead of always assuming `False`!

Fixes haskell/haddock#1002.
- - - - -
f9b9bc0e by Ryan Scott at 2019-01-27T09:28:12-08:00
Fix haskell/haddock#1004 with a pinch of dropForAlls

- - - - -
5cfcdd0a by Alec Theriault at 2019-01-28T16:49:57-08:00
Loosen 'QuickCheck' and 'hspec' bounds

It looks like the new versions don't cause any breakage
and loosening the bounds helps deps fit in one stack resolver.

- - - - -
3545d3dd by Alec Theriault at 2019-01-31T01:37:25-08:00
Use `.hie` files for the Hyperlinker backend (#977)

# Summary

This is a large architectural change to the Hyperlinker.

  * extract link (and now also type) information from `.hie` instead
    of doing ad-hoc SYB traversals of the `RenamedSource`. Also
    adds a superb type-on-hover feature (#715).

 * re-engineer the lexer to avoid needless string conversions. By going
    directly through GHC's `P` monad and taking bytestring slices, we
    avoid a ton of allocation and have better handling of position
    pragmas and CPP.

In terms of performance, the Haddock side of things has gotten _much_
more efficient. Unfortunately, much of this is cancelled out by the
increased GHC workload for generating `.hie` files. For the full set of
boot libs (including `ghc`-the-library)

  * the sum of total time went down by 9-10% overall
  * the sum of total allocations went down by 6-7%

# Motivation

Haddock is moving towards working entirely over `.hi` and `.hie` files.
This change means we no longer need the `RenamedSource` from
`TypecheckedModule` (something which is _not_ in `.hi` files).

# Details

Along the way a bunch of things were fixed:

 * Cross package (and other) links are now more reliable (#496)
 * The lexer tries to recover from errors on every line (instead of at CPP
    boundaries)
 * `LINE`/`COLUMN` pragmas are taken into account
 * filter out zero length tokens before rendering
 * avoid recomputing the `ModuleName`-based `SrcMap`
 * remove the last use of `Documentation.Haddock.Utf8` (see  haskell/haddock#998)
 * restructure temporary folder logic for `.hi`/`.hie` model
- - - - -
2ded3359 by Herbert Valerio Riedel at 2019-02-02T12:06:12+01:00
Update/modernise haddock-library.cabal file

- - - - -
62b93451 by Herbert Valerio Riedel at 2019-02-02T12:19:31+01:00
Tentatively declare support for unreleased base-4.13/ghc-8.8

- - - - -
6041e767 by Herbert Valerio Riedel at 2019-02-02T16:04:32+01:00
Normalise LICENSE text w/ cabal's BSD2 template

Also, correct the `.cabal` files to advertise `BSD2` instead
of the incorrect `BSD3` license.

- - - - -
0b459d7f by Alec Theriault at 2019-02-02T18:06:12-08:00
CI: fetch GHC from validate artifact

Should help make CI be less broken

- - - - -
6b5c07cf by Alec Theriault at 2019-02-02T18:06:12-08:00
Fix some Hyperlinker test suite fallout

* Amend `ParserSpec` to match new Hyperlinker API
    - pass in compiler info
    - strip out null tokens

* Make `hypsrc-test` pass reliably
    - strip out `local-*` ids
    - strip out `line-*` ids from the `ClangCppBug` test
    - re-accept output

- - - - -
ded34791 by Nathan Collins at 2019-02-02T18:31:23-08:00
Update README instructions for Stack

No need to `stack install` Haddock to test it. Indeed, `stack install` changes the `haddock` on user's `PATH` if `~/.local/bin` is on user's `PATH` which may not be desirable when hacking on Haddock.
- - - - -
723298c9 by Alec Theriault at 2019-02-03T09:11:05-08:00
Remove `Documentation.Haddock.Utf8`

The circumstances under which this module appeared are completely gone.
The Hyperlinker backend no longer needs this module (it uses the more
efficient `Encoding` module from `ghc`).

Why no deprecation? Because this module really shouldn't exist!

  - It isn't used in `haddock-library`/`haddock-api` anymore
  - It was copy pasted directly from `utf8-string`
  - Folks seeking a boot-lib only solution can use `ghc`'s `Encoding`

- - - - -
51050006 by Alec Theriault at 2019-02-03T22:58:58-08:00
Miscellaneous improvements to `Convert` (#1020)

Now that Haddock is moving towards working entirely over `.hi` and `.hie` files,
all declarations and types are going to be synthesized via the `Convert` module.
In preparation for this change, here are a bunch of fixes to this module:

  * Add kind annotations to type variables in `forall`'s whose kind is not `Type`,
    unless the kind can be inferred from some later use of the variable. See
    `implicitForAll` and `noKindTyVars` in particular if you wish to dive into this.

  * Properly detect `HsQualTy` in `synifyType`. This is done by following suit with
    what GHC's `toIfaceTypeX` does and checking the first argument of
    `FunTy{} :: Type` to see if it classified as a given/wanted in the typechecker
    (see `isPredTy`). 

  * Beef up the logic around figuring out when an explicit `forall` is needed. This
    includes: observing if any of the type variables will need kind signatures, if the
    inferred type variable order _without_ a forall will still match the one GHC
    claims, and some other small things.

  * Add some (not yet used) functionality for default levity polymorphic type
    signatures. This functionality similar to `fprint-explicit-runtime-reps`.

Couple other smaller fixes only worth mentioning:

  * Show the family result signature only when it isn't `Type`
  * Fix rendering of implicit parameters in the LaTeX and Hoogle backends
  * Better handling of the return kind of polykinded H98 data declarations
  * Class decls produced by `tyThingToLHsDecl` now contain associated type
    defaults and default method signatures when appropriate
  * Filter out more `forall`'s in pattern synonyms
- - - - -
841980c4 by Oleg Grenrus at 2019-02-04T08:44:25-08:00
Make a fixture of weird parsing of lists (#997)

The second example is interesting.
If there's a list directly after the header, and that list has
deeper structure, the parser is confused: It finds two lists:

 - One with the first nested element,
 - everything after it

I'm not trying to fix this, as I'm not even sure this is a bug,
and not a feature.

- - - - -
7315c0c8 by Ryan Scott at 2019-02-04T12:17:56-08:00
Fix haskell/haddock#1015 with dataConUserTyVars (#1022)

The central trick in this patch is to use `dataConUserTyVars` instead of
`univ_tvs ++ ex_tvs`, which displays the foralls in a GADT constructor in
a way that's more faithful to how the user originally wrote it.

Fixes haskell/haddock#1015.
- - - - -
ee0b49a3 by Ryan Scott at 2019-02-04T15:25:17-05:00
Changes from haskell/haddock#14579

We now have a top-level `tyConAppNeedsKindSig` function, which means
that we can delete lots of code in `Convert`.

- - - - -
1c850dc8 by Alan Zimmerman at 2019-02-05T21:54:18+02:00
Matching changes in GHC for haskell/haddock#16236

- - - - -
ab03c38e by Simon Marlow at 2019-02-06T08:07:33+00:00
Merge pull request haskell/haddock#1014 from hvr/pr/bsd2-normalise

Normalise LICENSE text w/ cabal's BSD2 template
- - - - -
5a92ccae by Alec Theriault at 2019-02-10T06:21:55-05:00
Merge remote-tracking branch 'gitlab/wip/T16236-2' into ghc-head

- - - - -
c0485a1d by Alec Theriault at 2019-02-10T03:32:52-08:00
Removes `haddock-test`s dependency on `xml`/`xhtml` (#1027)

This means that `html-test`, `latex-test`, `hoogle-test`, and
`hypsrc-test` now only depend on GHC boot libs. So we should
now be able to build and run these as part of GHC's testsuite. \o/

The reference output has changed very slightly, in three ways:

  * we don't convert quotes back into `&quot;` as the `xml` lib did
  * we don't add extra `&nbsp;` as the `xml` lib did
  * we now remove the entire footer `div` (instead of just emptying it)
- - - - -
65a448e3 by Alec Theriault at 2019-02-11T12:27:41-05:00
Remove workaround for now-fixed Clang CPP bug (#1028)

Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where
lines that started with an octothorpe but turned out not
to lex like pragmas would have an extra line added after them.

Since this bug has been fixed upstream and that it doesn't have dire
consequences anyways, the workaround is not really worth it
anymore - we can just tell people to update their clang version (or re-structure
their pragma code).
- - - - -
360ca937 by Alec Theriault at 2019-02-13T11:36:11-05:00
Clean up logic for guessing `-B` and `--lib` (#1026)

Haddock built with the `in-ghc-tree` flag tries harder to find the GHC
lib folder and its own resources. This should make it possible to use
`in-ghc-tree`-built Haddock without having to specify the `-B` and
`--lib` options (just how you can use in-tree GHC without always
specifying the `-B` option).

The logic to do this relies on `getExecutablePath`, so we only get
this auto-detection on platforms where this function works.
- - - - -
d583e364 by Alec Theriault at 2019-02-16T10:41:22-05:00
Fix tests broken by GHC

Changes in 19626218566ea709b5f6f287d3c296b0c4021de2 affected some
of the hyperlinker output. Accepted the new output (hovering over a
`..` now shows you what that wildcard binds).

Also fixed some stray deprecation warnings.

- - - - -
da0c42cc by Vladislav Zavialov at 2019-02-17T11:39:19+03:00
Parser changes to match !380

- - - - -
ab96bed7 by Ryan Scott at 2019-02-18T04:44:08-05:00
Bump ghc version to 8.9

- - - - -
44b7c714 by Alec Theriault at 2019-02-22T05:49:43-08:00
Match GHC changes for T16185

`FunTy` now has an `AnonArgFlag` that indicates whether the arrow is
a `t1 => t2` or `t1 -> t2`.

This commit shouldn't change any functionality in Haddock.

- - - - -
2ee653b1 by Alec Theriault at 2019-02-24T18:53:33-08:00
Update .travis.yml

Points to the new GHC CI artifact.
- - - - -
90939d71 by Alec Theriault at 2019-02-25T00:42:41-08:00
Support value/type namespaces on identifier links

Identifier links can be prefixed with a 'v' or 't' to indicate the value or
type namespace of the desired identifier. For example:

-- | Some link to a value: v'Data.Functor.Identity'
--
-- Some link to a type: t'Data.Functor.Identity'

The default is still the type (with a warning about the ambiguity)

- - - - -
d6ed496c by Alec Theriault at 2019-02-25T00:42:46-08:00
Better identifier parsing

  * '(<|>)' and '`elem`' now get parsed and rendered properly as links
  * 'DbModule'/'DbUnitId' now properly get split apart into two links
  * tuple names now get parsed properly
  * some more small niceties...

The identifier parsing code is more precise and more efficient (although to be
fair: it is also longer and in its own module). On the rendering side, we need
to pipe through information about backticks/parens/neither all the way through
from renaming to the backends.

In terms of impact: a total of 35 modules in the entirety of the bootlib + ghc
lib docs change. The only "regression" is things like '\0'. These should be
changed to @\\0@ (the path by which this previously worked seems accidental).

- - - - -
3c3b404c by Alec Theriault at 2019-02-25T22:12:11-08:00
Fix standalone deriving docs

Docs on standalone deriving decls for classes with associated types
should be associated with the class instance, not the associated type
instance.

Fixes haskell/haddock#1033

- - - - -
d51ef69e by Alec Theriault at 2019-02-26T19:14:59-08:00
Fix bogus identifier defaulting

This avoids a situation in which an identifier would get defaulted to
a completely different identifier. Prior to this commit, the 'Bug1035'
test case would hyperlink 'Foo' into 'Bar'!

Fixes haskell/haddock#1035.

- - - - -
88cbbdc7 by Ryan Scott at 2019-02-27T10:14:03-05:00
Visible dependent quantification (#16326) changes

- - - - -
0dcf6cee by Xia Li-yao at 2019-02-27T21:53:27-05:00
Menu item controlling which instances are expanded/collapsed (#1007)

Adds a menu item (like "Quick Jump") for options related to displaying
instances. This provides functionality for:

  * expanding/collapsing all instances on the currently opened page
  * controlling whether instances are expanded/collapsed by default
  * controlling whether the state of instances should be "remembered"

This new functionality is implemented in Typescript in `details-helper`.
The built-in-themes style switcher also got a revamp so that all three
of QuickJump, the style switcher, and instance preferences now have
the same style and implementation structure.

See also: https://mail.haskell.org/pipermail/haskell-cafe/2019-January/130495.html

Fixes haskell/haddock#698.

Co-authored-by: Lysxia <lysxia at gmail.com>
Co-authored-by: Nathan Collins <conathan at galois.com>


- - - - -
3828c0fb by Alec Theriault at 2019-02-28T12:42:49-05:00
`--show-interface` should output to stdout. (#1040)

Fixes haskell/haddock#864.
- - - - -
a50f4cda by gbaz at 2019-03-01T07:43:16-08:00
Increase contrast of Linuwal theme (#1037)

This is to address the concern that, on less nice and older screens,
some of the shades of grey blend in too easily with the white
background.

 * darken the font slightly
 * darken slightly the grey behind type signatures and such
 * add a border and round the corners on code blocks
 * knock the font down by one point
- - - - -
ab4d41de by Alec Theriault at 2019-03-03T09:23:26-08:00
Merge branch 'ghc-8.6' into ghc-8.8

- - - - -
12f509eb by Ben Gamari at 2019-03-04T22:13:20-05:00
Remove reference to Opt_SplitObjs flag

Split-objects has been removed.

- - - - -
5b3e4c9a by Ryan Scott at 2019-03-06T19:16:24-05:00
Update html-test output to reflect haskell/haddock#16391 changes

- - - - -
fc228af1 by Alec Theriault at 2019-03-09T08:29:23-08:00
Match changes for "Stop inferring over-polymorphic kinds"

The `hsq_ext` field of `HsQTvs` is now just the implicit variables
(instead of also including information about which of these variables
are dependent).

This commit shouldn't change any functionality in Haddock.

- - - - -
6ac109eb by Alec Theriault at 2019-03-09T11:22:55-08:00
Add .hi, .dyn_hi, etc files to .gitignore

Fixes haskell/haddock#1030.

- - - - -
b55f0c05 by Alec Theriault at 2019-03-09T11:22:55-08:00
Better support for default methods in classes

  * default methods now get rendered differently
  * default associated types get rendered
  * fix a forgotten `s/TypeSig/ClassOpSig/` refactor in LaTeX backend
  * LaTeX backend now renders default method signatures

NB: there is still no way to document default class members and the
NB: LaTeX backend still crashes on associated types

- - - - -
10aea0cf by Alec Theriault at 2019-03-09T11:22:55-08:00
Avoid multi-line `emph` in LaTeX backend

`markupWarning` often processes inputs which span across paragraphs.
Unfortunately, LaTeX's `emph` is not made to handle this (and will
crash).

Fixes haskell/haddock#936.

- - - - -
d22dc2c9 by Alec Theriault at 2019-03-09T11:22:55-08:00
Many LaTeX backend fixes

After this commit, we can run with `--latex` on all boot libraries
without crashing (although the generated LaTeX still fails to compile in
a handful of larger packages like `ghc` and `base`).

 * Add newlines after all block elements in LaTeX. This is important to
   prevent the final output from being more an more indented. See the
   `latext-test/src/Example` test case for a sample of this.

 * Support associated types in class declarations (but not yet defaults)

 * Several small issues for producing compiling LaTeX;
     - avoid empy `\haddockbeginargs` lists (ex: `type family Any`)
     - properly escape identifiers depending on context (ex: `Int#`)
     - add `vbox` around `itemize`/`enumerate` (so they can be in tables)

 * Several spacing fixes:
     - limit the width of `Pretty`-arranged monospaced code
     - cut out extra space characters in export lists
     - only escape spaces if there are _multiple_ spaces
     - allow type signatures to be multiline (even without docs)

 * Remove uninteresting and repetitive `main.tex`/`haddock.sty` files
   from `latex-test` test reference output.

Fixes haskell/haddock#935, haskell/haddock#929 (LaTeX docs for `text` build & compile)
Fixes haskell/haddock#727, haskell/haddock#930 (I think both are really about type families...)

- - - - -
0e6cee00 by Alec Theriault at 2019-03-29T12:11:56-07:00
Remove workaround for now-fixed Clang CPP bug (#1028)

Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where
lines that started with an octothorpe but turned out not
to lex like pragmas would have an extra line added after them.

Since this bug has been fixed upstream and that it doesn't have dire
consequences anyways, the workaround is not really worth it
anymore - we can just tell people to update their clang version (or re-structure
their pragma code).

- - - - -
ce05434d by Alan Zimmerman at 2019-03-29T12:12:11-07:00
Matching changes in GHC for haskell/haddock#16236

(cherry picked from commit 3ee6526d4ae7bf4deb7cd1caf24b3d7355573576)

- - - - -
d85766b2 by Ben Gamari at 2019-03-29T12:14:04-07:00
Bump GHC to 8.8

- - - - -
5a82cbaf by Oleg Grenrus at 2019-05-05T13:02:00-07:00
Redo ParseModuleHeader

- - - - -
b9033348 by Oleg Grenrus at 2019-05-05T13:02:00-07:00
Comment C, which clarifies why e.g. ReadP is not enough

- - - - -
bb55c8f4 by Alec Theriault at 2019-05-13T16:10:07-07:00
Remove outdated `.ghci` files and `scripts`

The `.ghci` files are actively annoying when trying to `cabal v2-repl`.
As for the `scripts`, the distribution workflow is completely different.

- - - - -
5ee244dc by Alec Theriault at 2019-05-13T16:10:07-07:00
Remove obsolete arcanist files + STYLE

Now that GHC is hosted on Gitlab, the arcanist files don't make sense
anymore. The STYLE file contains nothing more than a dead link too.

- - - - -
d07c1928 by Oleg Grenrus at 2019-05-13T16:41:43-07:00
Redo ParseModuleHeader

- - - - -
492762d2 by Oleg Grenrus at 2019-05-13T16:41:43-07:00
Comment C, which clarifies why e.g. ReadP is not enough

- - - - -
af2ac773 by Ryan Scott at 2019-05-14T17:22:13-04:00
Changes for haskell/haddock#16110/#16356

- - - - -
6820ed0d by Alec Theriault at 2019-05-17T08:51:27-07:00
Unbreak haskell/haddock#1004 test case

`fail` is no longer part of `Monad`.

- - - - -
6bf7be98 by Alec Theriault at 2019-05-17T08:51:27-07:00
Fix haskell/haddock#1063 with better parenthesization logic for contexts

The only other change in html/hoogle/hyperlinker output for the boot
libraries that this caused is a fix to some Hoogle output for implicit
params.

```
$ diff -r _build/docs/ old_docs
diff -r _build/docs/html/libraries/base/base.txt old_docs/html/libraries/base/base.txt
13296c13296
< assertError :: (?callStack :: CallStack) => Bool -> a -> a
---
> assertError :: ?callStack :: CallStack => Bool -> a -> a
```

- - - - -
b5716b61 by Ryan Scott at 2019-05-22T17:24:32-04:00
Match changes with haskell/haddock#14332

- - - - -
c115abf6 by Alec Theriault at 2019-05-26T16:01:58-04:00
Remove Haddock's dependency on `Cabal`

At this point, Haddock depended on Cabal-the-library solely for a
verbosity parser (which misleadingly accepts all sorts of verbosity
options that Haddock never uses). Now, the only dependency on Cabal
is for `haddock-test` (which uses Cabal to locate the Haddock interface
files of a couple boot libraries).

- - - - -
e5b2d4a3 by Alec Theriault at 2019-05-26T16:16:25-04:00
Regression test: promoted lists in associated types

When possible, associated types with promoted lists should use the
promoted list literal syntax (instead of repeated applications of
': and '[]). This was fixed in 2122de5473fd5b434af690ff9ccb1a2e58491f8c.

Closes haskell/haddock#466,

- - - - -
cc5ad5d3 by Alec Theriault at 2019-05-26T17:55:54-04:00
Merge branch 'ghc-8.6' into ghc-8.8

- - - - -
4b3301a6 by Alec Theriault at 2019-05-26T17:57:52-04:00
Release haddock-2.23, haddock-library-1.8.0

Tentatively adjust bounds and changelogs for the release to be bundled
with GHC 8.8.1.

- - - - -
69c7cfce by Matthew Pickering at 2019-05-30T10:54:27+01:00
Update hyperlinker tests for new types in .hie files

- - - - -
29b7e738 by Zubin Duggal at 2019-05-30T10:57:51+01:00
update for new way to store hiefile headers

- - - - -
aeca5d5f by Zubin Duggal at 2019-06-04T18:57:42-04:00
update for new way to store hiefile headers

- - - - -
ba2ca518 by Ben Gamari at 2019-06-07T23:11:14+00:00
Update test output for introduction of Safe-Inferred

- - - - -
3a975a6c by Ryan Scott at 2019-07-03T12:06:27-04:00
Changes for haskell/haddock#15247

- - - - -
0df46555 by Zubin Duggal at 2019-07-22T10:52:50+01:00
Fix haddockHypsrcTest

- - - - -
2688686b by Sylvain Henry at 2019-09-12T23:19:39+02:00
Fix for GHC module renaming

- - - - -
9ec0f3fc by Alec Theriault at 2019-09-20T03:21:00-04:00
Fix Travis CI, loosen .cabal bounds (#1089)

Tentatively for the 2.23 release:

  * updated Travis CI to work again
  * tweaked bounds in the `.cabal` files
  * adjusted `extra-source-files` to properly identify test files
- - - - -
ca559beb by Matthías Páll Gissurarson at 2019-09-28T12:14:40-04:00
Small change in to facilitate extended typed-holes (#1090)

This change has no functional effect on haddock itself, it just changes one pattern to use `_ (` rather than `_(`, so that we may use `_(` as a token for extended typed-holes later.
- - - - -
02e28976 by Vladislav Zavialov at 2019-09-28T12:17:45-04:00
Remove spaces around @-patterns (#1093)

This is needed to compile `haddock` when [GHC Proposal haskell/haddock#229](https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0229-whitespace-bang-patterns.rst) is implemented.
- - - - -
83cbbf55 by Alexis King at 2019-09-30T21:12:42-04:00
Fix the ignore-exports option (#1082)

The `ignore-exports` option has been broken since haskell/haddock#688, as mentioned in https://github.com/haskell/haddock/pull/766#issue-172505043. This PR fixes it.
- - - - -
e127e0ab by Ben Gamari at 2019-10-06T15:12:06-04:00
Fix a few haddock issues

- - - - -
3a0f5c89 by Zubin Duggal at 2019-10-07T17:56:13-04:00
Fix crash when there are no srcspans in the file due to CPP

- - - - -
339c5ff8 by Alec Theriault at 2019-10-07T17:56:13-04:00
Prefer un-hyperlinked sources to no sources

It is possible to fail to extract an HIE ast. This is however not a
reason to produce _no_ output - we should still make a colorized HTML
page.

- - - - -
d47ef478 by Alec Theriault at 2019-10-07T17:56:13-04:00
Add a regression test for haskell/haddock#1091

Previously, this input would crash Haddock.

- - - - -
ed7c8b0f by Alec Theriault at 2019-10-07T20:56:48-04:00
Add Hyperlinker test cases for TH-related stuff

Hopefully this will guard against regressions around quasiquotes, TH
quotes, and TH splices.

- - - - -
d00436ab by Andreas Klebinger at 2019-10-21T15:53:03+02:00
Refactor for withTiming changes.

- - - - -
4230e712 by Ben Gamari at 2019-10-22T09:36:37-04:00
Merge pull request haskell/haddock#1101 from AndreasPK/withTimingRefactor

Refactor for withTiming changes.
- - - - -
d155c5f4 by Ryan Scott at 2019-10-23T10:37:17-04:00
Reify oversaturated data family instances correctly (#1103)

This fixes haskell/haddock#1103 by adapting the corresponding patch for GHC (see
https://gitlab.haskell.org/ghc/ghc/issues/17296 and
https://gitlab.haskell.org/ghc/ghc/merge_requests/1877).

- - - - -
331a5adf by Sebastian Graf at 2019-10-25T17:14:40+02:00
Refactor for OutputableBndrId changes

- - - - -
48a490e0 by Ben Gamari at 2019-10-27T10:16:16-04:00
Merge pull request haskell/haddock#1105 from sgraf812/wip/flexible-outputable

Refactor for OutputableBndrId changes
- - - - -
f62a7dfc by Sebastian Graf at 2019-11-01T11:54:16+00:00
Define `XRec` for location information and get rid of `HasSrcSpan`

In https://gitlab.haskell.org/ghc/ghc/merge_requests/1970 I propose a
simpler way to encode location information into the GHC and Haddock AST
while incurring no cost for e.g. TH which doesn't need location
information.

These are just changes that have to happen in lock step.

- - - - -
d9b242ed by Ryan Scott at 2019-11-03T13:20:03-05:00
Changes from haskell/haddock#14579

We now have a top-level `tyConAppNeedsKindSig` function, which means
that we can delete lots of code in `Convert`.

(cherry picked from commit cfd682c5fd03b099a3d78c44f9279faf56a0ac70)

- - - - -
dfd42406 by Sebastian Graf at 2019-11-04T07:02:14-05:00
Define `XRec` for location information and get rid of `HasSrcSpan`

In https://gitlab.haskell.org/ghc/ghc/merge_requests/1970 I propose a
simpler way to encode location information into the GHC and Haddock AST
while incurring no cost for e.g. TH which doesn't need location
information.

These are just changes that have to happen in lock step.

- - - - -
0b15be7c by Ben Gamari at 2019-11-09T13:21:33-05:00
Import isRuntimeRepVar from Type rather than TyCoRep

isRuntimeRepVar is not longer exported from TyCoRep due to ghc#17441.

- - - - -
091f7283 by Ben Gamari at 2019-11-10T12:47:06-05:00
Bump to GHC 8.10

- - - - -
e88c71f2 by Ben Gamari at 2019-11-14T00:22:24-05:00
Merge pull request haskell/haddock#1110 from haskell/wip/T17441

Import isRuntimeRepVar from Type rather than TyCoRep
- - - - -
4e0bbc17 by Ben Gamari at 2019-11-14T00:22:45-05:00
Version bumps for GHC 8.11

- - - - -
0e85ceb4 by Ben Gamari at 2019-11-15T11:59:45-05:00
Bump to GHC 8.10

- - - - -
00d6d68b by Ben Gamari at 2019-11-16T18:35:58-05:00
Bump ghc version to 8.11

- - - - -
dde1fc3f by Ben Gamari at 2019-11-16T20:40:37-05:00
Drop support for base 4.13

- - - - -
f52e331d by Vladislav Zavialov at 2019-11-24T13:02:28+03:00
Update Hyperlinker.Parser.classify to use ITdollar

- - - - -
1ad96198 by Vladislav Zavialov at 2019-11-28T16:12:33+03:00
Remove HasSrcSpan (#17494)

- - - - -
651afd70 by Herbert Valerio Riedel at 2019-12-08T12:08:16+01:00
Document error-prone conditional definition of instances

This can easily trip up people if one isn't aware of it. Usually it's
better to avoid this kind of conditionality especially for typeclasses
for which there's an compat-package as conditional instances like
these tend to fragment the ecosystem into those packages that go the
extra mile to provide backward compat via those compat-packages and
those that fail to do so.

- - - - -
b521af56 by Herbert Valerio Riedel at 2019-12-08T12:09:54+01:00
Fix build-failure regression for base < 4.7

The `$>` operator definition is available only since base-4.7 which
unfortunately wasn't caught before release to Hackage (but has been
fixed up by a metadata-revision)

This commit introduces a `CompatPrelude` module which allows to reduce
the amount of CPP by ousting it to a central location, i.e. the new
`CompatPrelude` module. This pattern also tends to reduce the tricks
needed to silence unused import warnings.

Addresses haskell/haddock#1119

- - - - -
556c375d by Sylvain Henry at 2020-01-02T19:01:55+01:00
Fix after Iface modules renaming

- - - - -
bd6c53e5 by Sylvain Henry at 2020-01-07T00:48:48+01:00
hsyl20-modules-renamer

- - - - -
fb23713b by Ryan Scott at 2020-01-08T07:41:13-05:00
Changes for GHC#17608

See https://gitlab.haskell.org/ghc/ghc/merge_requests/2372

- - - - -
4a4dd382 by Ryan Scott at 2020-01-25T08:08:26-05:00
Changes for GHC#17566

See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469

- - - - -
e782a44d by Sylvain Henry at 2020-01-26T02:12:37+01:00
Rename PackageConfig into UnitInfo

- - - - -
ba3c9f05 by Sylvain Henry at 2020-01-26T02:12:37+01:00
Rename lookupPackage

- - - - -
ab37f9b3 by Ben Gamari at 2020-01-29T13:00:44-05:00
Merge pull request haskell/haddock#1125 from haskell/wip/T17566-take-two

Changes for GHC#17566
- - - - -
3ebd5ae0 by Ryan Scott at 2020-01-31T05:56:50-05:00
Merge branch 'wip-hsyl20-package-refactor' into ghc-head

- - - - -
602a747e by Richard Eisenberg at 2020-02-04T09:05:43+00:00
Echo GHC's removal of PlaceHolder module

This goes with GHC's !2083.

- - - - -
ccfe5679 by Sylvain Henry at 2020-02-10T10:13:56+01:00
Module hierarchy: runtime (cf haskell/haddock#13009)

- - - - -
554914ce by Cale Gibbard at 2020-02-10T16:10:39-05:00
Fix build of haddock in stage1

We have to use the correct version of the GHC API, but the version of the compiler itself doesn't matter.

- - - - -
5b6fa2a7 by John Ericson at 2020-02-10T16:18:07-05:00
Noramlize `tested-with` fields in cabal files

- - - - -
e6eb3ebe by Vladislav Zavialov at 2020-02-16T13:25:26+03:00
No MonadFail/Alternative for P

- - - - -
90e181f7 by Ben Gamari at 2020-02-18T14:13:47-05:00
Merge pull request haskell/haddock#1129 from obsidiansystems/wip/fix-stage1-build

Fix build of haddock in stage1
- - - - -
93b64636 by Sylvain Henry at 2020-02-19T11:20:27+01:00
Modules: Driver (#13009)

- - - - -
da4f6c7b by Vladislav Zavialov at 2020-02-22T15:33:02+03:00
Use RealSrcSpan in InstMap

- - - - -
479b1b50 by Ben Gamari at 2020-02-23T10:28:13-05:00
Merge remote-tracking branch 'upstream/ghc-head' into HEAD

- - - - -
55ecacf0 by Sylvain Henry at 2020-02-25T15:18:27+01:00
Modules: Core (#13009)

- - - - -
60867b3b by Vladislav Zavialov at 2020-02-28T15:53:52+03:00
Ignore the BufLoc/BufSpan added in GHC's !2516

- - - - -
1e5506d3 by Sylvain Henry at 2020-03-02T12:32:43+01:00
Modules: Core (#13009)

- - - - -
6fb53177 by Richard Eisenberg at 2020-03-09T14:49:40+00:00
Changes in GHC's !1913.

- - - - -
30b792ea by Ben Gamari at 2020-03-16T12:45:02-04:00
Merge pull request haskell/haddock#1130 from hsyl20/wip/hsyl20-modules-core2

Modules: Core (#13009)
- - - - -
cd761ffa by Sylvain Henry at 2020-03-18T15:24:00+01:00
Modules: Types

- - - - -
b6646486 by Ben Gamari at 2020-03-18T14:42:43-04:00
Merge pull request haskell/haddock#1133 from hsyl20/wip/hsyl20/modules/types

Modules: Types
- - - - -
9325d734 by Kleidukos at 2020-03-19T12:38:31-04:00
Replace the 'caption' class so that the collapsible sections are shown

- - - - -
5e2bb555 by Kleidukos at 2020-03-19T12:38:31-04:00
Force ghc-8.8.3

- - - - -
c6fcd0aa by Kleidukos at 2020-03-19T12:38:31-04:00
Update test fixtures

- - - - -
5c849cb1 by Sylvain Henry at 2020-03-20T09:34:39+01:00
Modules: Types

- - - - -
7f439155 by Alec Theriault at 2020-03-20T20:17:01-04:00
Merge branch 'ghc-8.8' into ghc-8.10

- - - - -
b7904e5c by Alina Banerjee at 2020-03-20T20:24:17-04:00
Update parsing to strip whitespace from table cells (#1074)

* Update parsing to strip leading & trailing whitespace from table cells

* Update fixture data to disallow whitespaces at both ends in table cells

* Add test case for whitespaces stripped from both ends of table cells

* Update table reference test data for html tests

- - - - -
b9d60a59 by Alec Theriault at 2020-03-22T11:46:42-04:00
Clean up warnings

  * unused imports
  * imports of `Data.List` without import lists
  * missing `CompatPrelude` file in `.cabal`

- - - - -
0c317dbe by Alec Theriault at 2020-03-22T18:46:54-04:00
Fix NPM security warnings

This was done by calling `npm audit fix`. Note that the security issues
seem to have been entirely in the build dependencies, since the output
JS has not changed.

- - - - -
6e306242 by Alec Theriault at 2020-03-22T20:10:52-04:00
Tentative 2.24 release

Adjusted changelogs and versions in `.cabal` files in preparation for
the upcoming release bundled with GHC 8.10.

- - - - -
1bfb4645 by Ben Gamari at 2020-03-23T16:40:54-04:00
Merge commit '3c2944c037263b426c4fe60a3424c27b852ea71c' into HEAD

More changes from the GHC types module refactoring.

- - - - -
be8c6f3d by Alec Theriault at 2020-03-26T20:10:53-04:00
Update `.travis.yml` to work with GHC 8.10.1

  * Regenerated the Travis file with `haskell-ci`

  * Beef up `.cabal` files with more `tested-with` information

- - - - -
b025a9c6 by Alec Theriault at 2020-03-26T20:10:53-04:00
Update README

Removed some out of date links/info, added some more useful links.

  * badge to Hackage
  * update old trac link
  * `ghc-head` => `ghc-8.10`
  * `cabal new-*` is now `cabal v2-*` and it should Just Work
  * `--test-option='--accept'` is the way to accept testsuite output

- - - - -
564d889a by Alec Theriault at 2020-03-27T20:34:33-04:00
Fix crash in `haddock-library` on unicode space

Our quickcheck tests for `haddock-library` stumbled across an edge case
input that was causing Haddock to crash: it was a unicode space
character.

The root cause of the crash is that we were implicitly assuming that
if a space character was not " \t\f\v\r", it would have to be "\n".
We fix this by instead defining horizontal space as: any space character
that is not '\n'.

Fixes haskell/haddock#1142

- - - - -
2d360ba1 by Alec Theriault at 2020-03-27T21:57:32-04:00
Disallow qualified uses of reserved identifiers

This a GHC bug (https://gitlab.haskell.org/ghc/ghc/issues/14109) too,
but it is a relatively easy fix in Haddock. Note that the fix must live
in `haddock-api` instead of `haddock-library` because we can only really
decide if an identifier is a reserved one by asking the GHC lexer.

Fixes haskell/haddock#952

- - - - -
47ae22ed by Alec Theriault at 2020-03-28T13:36:25-04:00
Remove unused `Haddock.Utils` functions

  * removed functions in `Haddock.Utils` that were not used anywhere
    (or exported from the `haddock-api` package)

  * moved GHC-specific utils from `Haddock.Utils` to `Haddock.GhcUtils`

- - - - -
c0291245 by Alec Theriault at 2020-03-28T13:36:25-04:00
Use TTG empty extensions to remove some `error`'s

None of these error cases should ever have been reachable, so this is
just a matter of leveraging the type system to assert this.

  * Use the `NoExtCon` and `noExtCon` to handle case matches for no
    extension constructors, instead of throwing an `error`.

  * Use the extension field of `HsSpliceTy` to ensure that this variant
    of `HsType` cannot exist in an `HsType DocNameI`.

- - - - -
0aff8dc4 by Alec Theriault at 2020-03-28T13:36:25-04:00
Use `unLoc`/`noLoc` from GHC instead of `unL`/`reL`

 * `unL` is already defined by GHC as `unLoc`
 * `reL` is already defined by GHC as `noLoc` (in a safer way too!)
 * Condense `setOutputDir` and add a about exporting from GHC

Fixes haskell/haddock#978

- - - - -
bf6f2fb7 by Alec Theriault at 2020-03-28T13:36:25-04:00
Cleanup up GHC flags in `.cabal` files

  * enable more useful warning flags in `haddock-api`, handle the new
    warnings generated

  * remove `-fwarn-tabs` (now we'd use `-Wtabs`, but this has been in
    `-Wall` for a while now)

- - - - -
c576fbf1 by Alec Theriault at 2020-03-28T13:36:25-04:00
`haddock-library` document header level

Document the fact the header level is going to always be between 1 and 6
inclusive. Along the way, I also optimized the parsing code a bit.

- - - - -
71bce0ee by Alec Theriault at 2020-03-28T14:26:27-04:00
Disallow links in section headers

This is quite straightforward to implement, since we already had a
function `docToHtmlNoAnchors` (which we used to generate the link in the
sidebar "Contents").

This breaks test `Bug387`, but that test case has aged badly: we now
automatically generate anchors for all headings, so manually adding an
anchor in a section makes no sense. Nested anchors are, as pointed out
in haskell/haddock#1054, disallowed by the HTML standard.

Fixes haskell/haddock#1054

- - - - -
b461b0ed by Sylvain Henry at 2020-03-30T10:34:23+02:00
Modules: type checker

- - - - -
cd8cd1ee by Ben Gamari at 2020-03-31T12:45:02-04:00
Merge pull request haskell/haddock#1152 from hsyl20/wip/hsyl20/modules/tc

Module renaming
- - - - -
5e8f8ea7 by Felix Yan at 2020-04-01T17:58:06-07:00
Allow QuickCheck 2.14

Builds fine and all tests pass.
- - - - -
dc6b1633 by Sylvain Henry at 2020-04-05T16:43:44+02:00
Module renaming: amend previous patch

- - - - -
eee2f4ae by Ryan Scott at 2020-04-05T09:04:43-07:00
Fix haskell/haddock#1050 by filtering out invisible AppTy arguments

This makes the `synifyType` case for `AppTy` more intelligent by
taking into consideration the visibilities of each `AppTy` argument
and filtering out any invisible arguments, as they aren't intended
to be displayed in the source code. (See haskell/haddock#1050 for an example of what
can happen if you fail to filter these out.)

Along the way, I noticed that a special `synifyType` case for
`AppTy t1 (CoercionTy {})` could be consolidated with the case below
it, so I took the opportunity to tidy this up.

- - - - -
23eb99e8 by Ben Gamari at 2020-04-07T11:19:58-04:00
Merge pull request haskell/haddock#1154 from hsyl20/wip/hsyl20/modules/tc

Module renaming: amend previous patch
- - - - -
072d994d by Ryan Scott at 2020-04-07T19:32:47-04:00
Make NoExtCon fields strict

These changes are a part of a fix for
[GHC#17992](https://gitlab.haskell.org/ghc/ghc/issues/17992).

- - - - -
d8ebf6c8 by Ignat Insarov at 2020-04-09T21:15:01-04:00
Recode Doc to Json. (#1159)

* Recode Doc to Json.

* More descriptive field labels.
- - - - -
52df4b4e by Sylvain Henry at 2020-04-10T12:39:18+02:00
Module renaming

- - - - -
d9ab8ec8 by Cale Gibbard at 2020-04-14T11:43:34-04:00
Add instance of XCollectPat for DocNameI

- - - - -
323d221d by Cale Gibbard at 2020-04-14T11:43:34-04:00
Rename XCollectPat -> CollectPass

- - - - -
2df80867 by Alec Theriault at 2020-04-15T07:30:51-07:00
Prune docstrings that are never rendered

When first creating a Haddock interface, trim `ifaceDocMap` and
`ifaceArgMap` to not include docstrings that can never appear in the
final output. Besides checking with GHC which names are exported, we
also need to keep all the docs attached to instance declarations (it is
much tougher to detect when an instance is fully private).

This change means:

  * slightly smaller interface files (7% reduction on boot libs)
  * slightly less work to do processing docstrings that aren't used
  * no warnings in Haddock's output about private docstrings (see haskell/haddock#1070)

I've tested manually that this does not affect any of the boot library
generated docs (the only change in output was some small re-ordering in
a handful of instance lists). This should mean no docstrings have been
incorrectly dropped.

- - - - -
f49c90cc by Alec Theriault at 2020-04-15T07:30:51-07:00
Don't warn about missing links in miminal sigs

When renaming the Haddock interface, never emit warnings when renaming a
minimal signature. Also added some documention around `renameInterface`.

Minimal signatures intentionally include references to potentially
un-exported methods (see the discussion in haskell/haddock#330), so it is expected
that they will not always have a link destination. On the principle
that warnings should always be resolvable, this shouldn't produce a
warning. See haskell/haddock#1070.

- - - - -
a9eda64d by Ben Gamari at 2020-04-17T09:27:35-04:00
Merge pull request haskell/haddock#1160 from hsyl20/wip/hsyl20/modules/systools

Module renaming
- - - - -
f40d7879 by Cale Gibbard at 2020-04-20T11:30:38-04:00
Merge remote-tracking branch 'origin/ghc-head' into wip/ttg-con-pat

- - - - -
a50e7753 by Ben Gamari at 2020-04-20T11:36:10-04:00
Merge pull request haskell/haddock#1165 from obsidiansystems/wip/ttg-con-pat

Trees that Grow refactor (GHC !2553)
- - - - -
6a24795c by Alec Theriault at 2020-04-21T08:06:45-07:00
Fallback to `hiDecl` when `extractDecl` fails

Sometimes, the declaration being exported is a subdecl (for instance, a
record accessor getting exported at the top-level). For these cases,
Haddock has to find a way to produce some synthetic sensible top-level
declaration. This is done with `extractDecl`.

As is shown by haskell/haddock#1067, this is sometimes impossible to do just at a
syntactic level (for instance when the subdecl is re-exported). In these
cases, the only sensible thing to do is to try to reify a declaration
based on a GHC `TyThing` via `hiDecl`.

- - - - -
eee1a8b7 by Sylvain Henry at 2020-04-24T15:46:05+02:00
Module structure

- - - - -
50b9259c by Iñaki at 2020-04-25T18:38:11-04:00
Add support for custom section anchors (#1179)

This allows to have stable anchors for groups, even if the set of
groups in the documentation is altered.

The syntax for setting the anchor of a group is

-- * Group name #desiredAnchor#

Which will produce an html anchor of the form '#g:desiredAnchor'

Co-authored-by: Iñaki García Etxebarria <git at inaki.blueleaf.cc>
- - - - -
4003c97a by Ben Gamari at 2020-04-26T09:35:15-04:00
Merge pull request haskell/haddock#1166 from hsyl20/wip/hsyl20/modules/utils

Module structure
- - - - -
5206ab60 by Sylvain Henry at 2020-04-27T16:47:39+02:00
Renamed UnitInfo fields

- - - - -
c32c333b by Sylvain Henry at 2020-04-27T17:32:58+02:00
UnitId has been renamed into Unit

- - - - -
3e87db64 by Sylvain Henry at 2020-04-27T17:36:00+02:00
Fix for GHC.Unit.* modules

- - - - -
ae3323a7 by Ben Gamari at 2020-04-29T12:36:37-04:00
Merge pull request haskell/haddock#1183 from hsyl20/wip/hsyl20/unitid

Refactoring of Unit code
- - - - -
b105564a by Artem Pelenitsyn at 2020-05-03T08:14:10+01:00
add dependency on exceptions because GHC.Exception was boiled down (ghc haskell/haddock#18075)

- - - - -
9857eff3 by Zubin Duggal at 2020-05-04T18:48:25+01:00
Atomic update of NameCache in readHieFile

- - - - -
86bbb226 by Sylvain Henry at 2020-05-14T16:36:27+02:00
Fix after Config module renaming

- - - - -
a4bbdbc2 by Gert-Jan Bottu at 2020-05-15T22:09:44+02:00
Explicit Specificity Support for Haddock

- - - - -
46199daf by Ben Gamari at 2020-05-19T09:59:56-04:00
Merge pull request haskell/haddock#1192 from hsyl20/hsyl20/modules-config

Fix after Config module renaming
- - - - -
f9a9d2ba by Gert-Jan Bottu at 2020-05-20T16:48:38-04:00
Explicit Specificity Support for Haddock

- - - - -
55c5b7ea by Ben Gamari at 2020-05-21T00:32:02-04:00
Merge commit 'a8d7e66da4dcc3b242103271875261604be42d6e' into ghc-head

- - - - -
a566557f by Cale Gibbard at 2020-05-21T16:02:06-04:00
isBootSummary now produces a result of type IsBootInterface

- - - - -
ea52f905 by Zubin Duggal at 2020-05-24T17:55:48+01:00
update for hiefile-typeclass-info

- - - - -
49ba7a67 by Willem Van Onsem at 2020-05-25T12:23:01-04:00
Use floor over round to calculate the percentage (#1195)

If we compile documentation where only a small fraction is undocumented,
it is misleading to see 100% coverage - 99% is more intuitive.

Fixes haskell/haddock#1194
- - - - -
c025ebf1 by Ben Gamari at 2020-05-29T14:32:42-04:00
Merge pull request haskell/haddock#1185 from obsidiansystems/boot-disambig

isBootSummary now produces a result of type IsBootInterface
- - - - -
74ab9415 by Ben Gamari at 2020-05-29T20:23:39-04:00
haddock: Bounds bumps for GHC 8.12

- - - - -
b40be944 by Ben Gamari at 2020-06-03T17:02:31-04:00
testsuite: Update expected output for simplified subsumption

- - - - -
624be71c by Ryan Scott at 2020-06-05T12:43:23-04:00
Changes for GHC#18191

See https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3337.

- - - - -
fbd8f7ce by Sylvain Henry at 2020-06-08T15:31:47+02:00
Fix after unit refactoring

- - - - -
743fda4d by Ben Gamari at 2020-06-09T12:09:58-04:00
Merge pull request haskell/haddock#1202 from hsyl20/wip/hsyl20/unitid-ii

Fix after unit refactoring
- - - - -
d07a06a9 by Ryan Scott at 2020-06-13T07:16:55-04:00
Use HsForAllTelescope (GHC#18235)

- - - - -
389bb60d by Ben Gamari at 2020-06-13T15:30:52-04:00
haddock: Bounds bumps for GHC 8.12

- - - - -
7a377f5f by Ben Gamari at 2020-06-17T14:53:16-04:00
Merge pull request haskell/haddock#1199 from bgamari/wip/ghc-8.12

haddock: Bounds bumps for GHC 8.12
- - - - -
9fd9e586 by Krzysztof Gogolewski at 2020-06-17T16:09:07-04:00
Adapt Haddock to LinearTypes

See ghc/ghc!852.

- - - - -
46fe7636 by Ben Gamari at 2020-06-18T14:20:02-04:00
Merge remote-tracking branch 'origin/ghc-head' into ghc-head

- - - - -
35a3c9e2 by Zubin Duggal at 2020-06-21T21:19:18+05:30
Use functions exported from HsToCore

- - - - -
8abe3928 by Ben Gamari at 2020-06-24T13:53:39-04:00
Merge pull request haskell/haddock#1204 from wz1000/wip/haddock-hstocore

Use functions exported from GHC.HsToCore.Docs
- - - - -
22f2c937 by Matthías Páll Gissurarson at 2020-06-26T19:07:03+02:00
Adapt Haddock for QualifiedDo

- - - - -
3f6208d7 by Vladislav Zavialov at 2020-06-28T14:28:16+03:00
Handle LexicalNegation's ITprefixminus

- - - - -
03a19f41 by Sylvain Henry at 2020-07-02T09:37:38+02:00
Rename hsctarget into backend

- - - - -
ea17ff23 by Andreas Klebinger at 2020-07-02T17:44:18+02:00
Update for UniqFM changes.

- - - - -
9872f2f3 by Ben Gamari at 2020-07-09T10:39:19-04:00
Merge pull request haskell/haddock#1209 from AndreasPK/wip/typed_uniqfm

Update for UniqFM changes.
- - - - -
68f7b668 by Krzysztof Gogolewski at 2020-07-12T18:16:57+02:00
Sync with GHC removing {-# CORE #-} pragma

See ghc ticket haskell/haddock#18048

- - - - -
eb372681 by Sylvain Henry at 2020-07-20T11:41:30+02:00
Rename hscTarget into backend

- - - - -
fb7f78bf by Ben Gamari at 2020-07-21T12:15:25-04:00
Merge pull request haskell/haddock#1214 from hsyl20/wip/hsyl20/hadrian/ncg

Rename hscTarget into backend
- - - - -
1e8f5b56 by Ben Gamari at 2020-07-23T09:11:50-04:00
Merge commit '904dce0cafe0a241dd3ef355775db47fc12f434d' into ghc-head

- - - - -
d8fd1775 by Zubin Duggal at 2020-07-23T18:46:40+05:30
Update for modular ping pong

- - - - -
8416f872 by Ben Gamari at 2020-07-23T09:35:03-04:00
Merge pull request haskell/haddock#1200 from wz1000/wip/wz1000-modular-ping-pong

Modular ping pong
- - - - -
a24a8577 by Ben Gamari at 2020-07-28T15:23:36-04:00
Bump GHC version to 9.0

- - - - -
6a51c9dd by Sylvain Henry at 2020-08-05T18:47:05+02:00
Fix after Outputable refactoring

- - - - -
c05e1c99 by Ben Gamari at 2020-08-10T14:41:41-04:00
Merge pull request haskell/haddock#1223 from hsyl20/wip/hsyl20/dynflags/exception

Fix after Outputable refactoring
- - - - -
d964f15b by Sylvain Henry at 2020-08-12T11:58:49+02:00
Fix after HomeUnit

- - - - -
8e6d5b23 by Ben Gamari at 2020-08-12T14:25:30-04:00
Merge pull request haskell/haddock#1225 from hsyl20/wip/hsyl20/plugins/homeunit

Fix after HomeUnit
- - - - -
8c7880fe by Sylvain Henry at 2020-08-17T14:13:29+02:00
Remove Ord FastString instance

- - - - -
8ea410db by Alex Biehl at 2020-08-19T10:56:32+02:00
Another round of `npm audit fix` (#1228)

This should shut down the warnings on Github. Note that the security issues
seem to have been entirely in the build dependencies, since the output
JS has not changed.

Last NPM dependency audit happend in d576b2327e2bc117f912fe0a9d595e9ae62614e0

Co-authored-by: Alex Biehl <alex.biehl at target.com>
- - - - -
7af6e2a8 by Ben Gamari at 2020-08-31T13:59:34-04:00
Merge pull request haskell/haddock#1226 from hsyl20/wip/hsyl20/fs_ord

Remove Ord FastString instance
- - - - -
ffbc8702 by Alan Zimmerman at 2020-09-07T21:47:41+01:00
Match GHC for haskell/haddock#18639, remove GENERATED pragma

- - - - -
a93f1268 by Alan Zimmerman at 2020-09-07T23:11:38+01:00
Merge pull request haskell/haddock#1232 from haskell/wip/T18639-remove-generated-pragma,

Match GHC for haskell/haddock#18639, remove GENERATED pragma
- - - - -
1f605d50 by Ben Gamari at 2020-09-14T18:30:01-04:00
Bump GHC version to 9.1

- - - - -
6599df62 by Vladislav Zavialov at 2020-09-18T14:05:15+03:00
Bump base upper bound to 4.16

- - - - -
a01b3c43 by Ben Gamari at 2020-09-22T15:41:48-04:00
Update hypsrc-test for QuickLook

This appears to be a spurious change.

- - - - -
e9cc6cac by Vladislav Zavialov at 2020-09-26T21:00:12+03:00
Updates for the new linear types syntax: a %p -> b

- - - - -
30e3ca7c by Sylvain Henry at 2020-09-29T11:18:32-04:00
Update for parser (#1234)


- - - - -
b172f3e3 by Vladislav Zavialov at 2020-09-30T01:01:30+03:00
Updates for the new linear types syntax: a %p -> b

- - - - -
0b9c08d3 by Sylvain Henry at 2020-09-30T11:02:33+02:00
Adapt to GHC parser changes

- - - - -
b9540b7a by Sylvain Henry at 2020-10-12T09:13:38-04:00
Don't pass the HomeUnitId (#1239)


- - - - -
34762e80 by HaskellMouse at 2020-10-13T12:58:04+03:00
Changed tests due to unification of `Nat` and `Natural`

in the follwing merge request:
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3583

- - - - -
256f86b6 by Vladislav Zavialov at 2020-10-15T10:48:03+03:00
Add whitespace in: map ($ v)

- - - - -
4a3f711b by Alan Zimmerman at 2020-10-19T08:57:27+01:00
Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaled

- - - - -
072cdd21 by Alan Zimmerman at 2020-10-21T14:48:28-04:00
Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaled

(cherry picked from commit a7d1d8e034d25612d5d08ed8fdbf6f472aded4a1)

- - - - -
9e09a445 by Alan Zimmerman at 2020-10-21T23:53:34-04:00
Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaled

(cherry picked from commit a7d1d8e034d25612d5d08ed8fdbf6f472aded4a1)

- - - - -
636d7de3 by Sylvain Henry at 2020-10-26T14:31:54-04:00
GHC.Driver.Types refactoring (#1242)


- - - - -
a597f000 by Ryan Scott at 2020-10-29T04:18:05-04:00
Adapt to the removal of Hs{Boxed,Constraint}Tuple

See ghc/ghc!4097 and GHC#18723.

- - - - -
b96660fb by Ryan Scott at 2020-10-30T04:53:05-04:00
Adapt to HsConDecl{H98,GADT}Details split

Needed for GHC#18844.

- - - - -
c287d82c by Ryan Scott at 2020-10-30T19:35:59-04:00
Adapt to HsOuterTyVarBndrs

These changes accompany ghc/ghc!4107, which aims to be a fix
for haskell/haddock#16762.

- - - - -
a34c31a1 by Ryan Scott at 2020-11-13T13:38:34-05:00
Adapt to splitPiTysInvisible being renamed to splitInvisPiTys

This is a part of !4434, a fix for GHC#18939.

- - - - -
66ea459d by Sylvain Henry at 2020-11-16T10:59:30+01:00
Fix after Plugins moved into HscEnv

- - - - -
508556d8 by Ben Gamari at 2020-11-18T15:47:40-05:00
Merge pull request haskell/haddock#1253 from hsyl20/wip/hsyl20/plugins/hscenv

Fix after Plugins moved into HscEnv
- - - - -
620fec1a by Andreas Klebinger at 2020-11-24T20:51:59+01:00
Update for changes in GHC's Pretty

- - - - -
01cc13ab by Richard Eisenberg at 2020-11-25T23:18:35-05:00
Avoid GHC#18932.

- - - - -
8d29ba21 by Cale Gibbard at 2020-11-25T23:18:35-05:00
Add type arguments to PrefixCon

- - - - -
414d5f87 by Sylvain Henry at 2020-11-30T17:06:04+01:00
DynFlags's unit fields moved to HscEnv

- - - - -
e356668c by Ben Gamari at 2020-11-30T11:11:37-05:00
Merge pull request haskell/haddock#1258 from hsyl20/wip/hsyl20/hscenv/unitstate

Unit fields moved from DynFlags to HscEnv
- - - - -
7cf552f1 by Ben Gamari at 2020-12-03T10:31:27-05:00
Merge pull request haskell/haddock#1257 from AndreasPK/wip/andreask/opt_dumps

Update for changes in GHC's Pretty
- - - - -
fc0871c3 by Veronika Romashkina at 2020-12-08T16:35:33+01:00
Fix docs links from Darcs to GitHub in intro (#1262)


- - - - -
7059e808 by Veronika Romashkina at 2020-12-08T16:36:16+01:00
Use gender neutral word in docs (#1260)


- - - - -
1b16e5ee by Maximilian Tagher at 2020-12-08T16:40:03+01:00
Allow scrolling search results (#1235)

Closes https://github.com/haskell/haddock/issues/1231
- - - - -
8a118c01 by dependabot[bot] at 2020-12-08T16:40:25+01:00
Bump bl from 1.2.2 to 1.2.3 in /haddock-api/resources/html (#1255)

Bumps [bl](https://github.com/rvagg/bl) from 1.2.2 to 1.2.3.
- [Release notes](https://github.com/rvagg/bl/releases)
- [Commits](https://github.com/rvagg/bl/compare/v1.2.2...v1.2.3)

Signed-off-by: dependabot[bot] <support at github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- - - - -
c89ff587 by Xia Li-yao at 2020-12-08T16:42:17+01:00
Allow more characters in anchor following module reference (#1220)


- - - - -
14af7d64 by Xia Li-yao at 2020-12-08T16:43:05+01:00
Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)

* Fix multiple typos and inconsistencies in doc/markup.rst

Note: I noticed some overlap with haskell/haddock#1112 from @wygulmage and haskell/haddock#1081 from
@parsonsmatt after creating these proposed changes - mea culpa for not
looking at the open PRs sooner.

* Fix haskell/haddock#1113 If no Signatures, no section of index.html

* Change the formatting of missing link destinations

The current formatting of the missing link destination does not really
help user to understand the reasons of the missing link.

To address this, I've changed the formatting in two ways:

- the missing link symbol name is now fully qualified. This way you
immediately know which haskell module cannot be linked. It is then easier
to understand why this module does not have documentation (hidden module
or broken documentation).
- one line per missing link, that's more readable now that symbol name
can be longer due to qualification.

For example, before haddock was listing missing symbol such as:

```
could not find link destinations for:
  Word8 Word16 mapMaybe
```

Now it is listed as:

```
could not find link destinations for:
  - Data.Word.Word8
  - Data.Word.Word16
  - Data.Maybe.mapMaybe
```

* Add `--ignore-link-symbol` command line argument

This argument can be used multiples time. A missing link to a symbol
listed by `--ignore-link-symbol` won't trigger "missing link" warning.

* Forbid spaces in anchors (#1148)

* Improve error messages with context information (#1060)

Co-authored-by: Matt Audesse <matt at mattaudesse.com>
Co-authored-by: Mike Pilgrem <mpilgrem at users.noreply.github.com>
Co-authored-by: Guillaume Bouchard <guillaume.bouchard at tweag.io>
Co-authored-by: Pepe Iborra <pepeiborra at gmail.com>
- - - - -
89e3af13 by tomjaguarpaw at 2020-12-08T18:00:04+01:00
Enable two warnings (#1245)

because they will be soon be added to -Wall.

See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
- - - - -
c3320f8d by Willem Van Onsem at 2020-12-08T18:26:55+01:00
simplify calculating percentages fixing haskell/haddock#1194 (#1236)


- - - - -
685df308 by Alex Biehl at 2020-12-08T20:06:26+01:00
Changes for GHC#17566

See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469

- - - - -
be3ec3c0 by Alex Biehl at 2020-12-08T20:06:26+01:00
Import intercalate

- - - - -
32c33912 by Matthías Páll Gissurarson at 2020-12-08T21:15:30+01:00
Adapt Haddock for QualifiedDo

- - - - -
31696088 by Alex Biehl at 2020-12-08T22:06:02+01:00
Fix haddock-library tests

- - - - -
fbc0998a by Alex Biehl at 2020-12-08T23:08:23+01:00
Move to GitHub CI (#1266)

* Initial version of ci.yml

This is a straight copy from Dmitrii Kovanikov's blog post
at https://kodimensional.dev/github-actions.

Will adapt to haddock in successive commits.

* Delete .travis.yml

* Modify to only test on ghc-8.10.{1,2}

* Use actions/setup-haskell at v1.1.4

* Relax QuickCheck bound on haddock-api

* Remove stack matrix for now

* Nail down to ghc-8.10 branch for now

* Pin index state to 2020-12-08T20:13:44Z for now

* Disable macOS and Windows tests for now for speed up
- - - - -
5b946b9a by tomjaguarpaw at 2020-12-10T19:01:41+01:00
Enable two warnings (#1245) (#1268)

because they will be soon be added to -Wall.

See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
- - - - -
bc5a408f by dependabot[bot] at 2020-12-10T19:02:16+01:00
Bump ini from 1.3.5 to 1.3.7 in /haddock-api/resources/html (#1269)

Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.7.
- [Release notes](https://github.com/isaacs/ini/releases)
- [Commits](https://github.com/isaacs/ini/compare/v1.3.5...v1.3.7)

Signed-off-by: dependabot[bot] <support at github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- - - - -
d02995f1 by Andrew Martin at 2020-12-14T16:48:40-05:00
Update for boxed rep

- - - - -
a381aeff by Ben Gamari at 2020-12-15T15:13:30-05:00
Revert "Enable two warnings (#1245) (#1268)"

As this does not build on GHC `master`.

This reverts commit 7936692badfe38f23ae95b51fb7bd7c2ff7e9bce.

- - - - -
a63c0a9e by Ben Gamari at 2020-12-15T15:17:59-05:00
Revert "Update for boxed rep"

This reverts commit 4ffb30d8b637ccebecc81ce610f0af451ac8088d.

- - - - -
53bfbb29 by Ben Gamari at 2020-12-15T15:37:24-05:00
Merge remote-tracking branch 'upstream/ghc-head' into ghc-head

- - - - -
bae76a30 by Ben Gamari at 2020-12-16T02:44:42+00:00
Update output for nullary TyConApp optimisation (ghc/ghc!2952)

- - - - -
4b733b57 by Krzysztof Gogolewski at 2020-12-16T20:03:14+01:00
Display linear/multiplicity arrows correctly (#1238)

Previously we were ignoring multiplicity and displayed
a %1 -> b as a -> b.
- - - - -
ee463bd3 by Ryan Scott at 2020-12-16T16:55:23-05:00
Adapt to HsCoreTy (formerly NewHsTypeX) becoming a type synonym

Needed for !4417, the fix for GHC#15706 and GHC#18914.

- - - - -
ed0b02f8 by tomjaguarpaw at 2020-12-19T10:17:19+00:00
Enable two warnings (#1245) (#1268)

because they will be soon be added to -Wall.

See https://gitlab.haskell.org/ghc/ghc/-/issues/15656

- - - - -
d80bf8f5 by Sylvain Henry at 2020-12-21T10:09:25+01:00
Fix after binder collect changes

- - - - -
bf4c9d32 by Adam Gundry at 2020-12-23T21:35:01+00:00
Adapt to changes to GlobalRdrElt and AvailInfo

Needed for ghc/ghc!4467

- - - - -
37736c4c by John Ericson at 2020-12-28T12:27:02-05:00
Support a new ghc --make node type for parallel backpack upsweep

- - - - -
717bdeac by Vladislav Zavialov at 2020-12-29T10:50:02+03:00
Inline and fix getGADTConTypeG

The getGADTConTypeG used HsRecTy, which is at odds with GHC issue haskell/haddock#18782.

I noticed that getGADTConTypeG was only used in the Hoogle backend.
Interestingly, when handling H98 constructors, Hoogle converts RecCon to
PrefixCon (see Haddock.Backends.Hoogle.ppCtor).

So I changed getGADTConTypeG to handle RecConGADT in the same manner as
PrefixConGADT, and after this simplification moved it into the 'where'
clause of ppCtor, to the only place where it is used.

The practical effect of this change is as follows.
Consider this example:
	data TestH98 = T98 { bar::Int }
	data TestGADT where
	  TG :: { foo :: Int } -> TestGADT

Before this patch,  haddock --hoogle  used to produce:
	T98 :: Int -> TestH98
	[TG] :: {foo :: Int} -> TestGADT

Notice how the record syntax was discarded in T98 but not TG.
With this patch, we always produce signatures without record syntax:
	T98 :: Int -> TestH98
	[TG] :: Int -> TestGADT

I suspect this might also be a bugfix, as currently Hoogle doesn't seem
to render GADT record constructors properly.

- - - - -
cb1b8c56 by Andreas Abel at 2020-12-30T21:12:37+01:00
Build instructions: haddock-library and -api first!

- - - - -
b947f6ad by Ben Gamari at 2020-12-31T13:04:19-05:00
Merge pull request haskell/haddock#1281 from obsidiansystems/wip/backpack-j

Changes to support -j with backpack
- - - - -
120e1cfd by Hécate Moonlight at 2021-01-04T19:54:58+01:00
Merge pull request haskell/haddock#1282 from andreasabel/master

Build instructions: haddock-library and -api first!
- - - - -
fd45e41a by Ben Gamari at 2021-01-05T16:14:31-05:00
Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0

- - - - -
b471bdec by Ben Gamari at 2021-01-05T16:23:02-05:00
Merge commit '1e56f63c3197e7ca1c1e506e083c2bad25d08793' into ghc-9.0

- - - - -
81cdbc41 by Alex Biehl at 2021-01-09T12:14:41+01:00
Prepare Haddock for being a GHC Plugin

- - - - -
b646d952 by Alex Biehl at 2021-01-09T12:14:41+01:00
Make Haddock a GHC Plugin

- - - - -
cc044674 by Alex Biehl at 2021-01-09T12:14:41+01:00
Add -j[n] CLI param to Haddock executable

It translates to `--ghcopt=-j[n]`

- - - - -
84a04073 by Alex Biehl at 2021-01-09T12:14:41+01:00
Abstract Monad for interface creation

I found that when running as a plugin the lookupName function (which
runs in Ghc monad) does not work correctly from the
typeCheckResultAction hook.

Instead, we abstracted the monad used when creating interfaces, so
that access to GHC session specific parts is explicit and so that the
TcM can provide their (correct) implementation of lookupName.

- - - - -
5be2c4f7 by Alex Biehl at 2021-01-09T12:14:41+01:00
Accept tests

- - - - -
8cefee9d by Alex Biehl at 2021-01-09T16:10:47+01:00
Add missing dependency for mtl

- - - - -
3681f919 by Ben Gamari at 2021-01-13T18:39:25-05:00
Merge remote-tracking branch 'origin/ghc-9.0' into ghc-head

- - - - -
33c6b152 by Hécate Moonlight at 2021-01-14T16:04:20+01:00
Merge pull request haskell/haddock#1273 from hsyl20/wip/hsyl20/arrows

Fix after binder collect changes
- - - - -
70d13e8e by Joachim Breitner at 2021-01-22T19:03:45+01:00
Make haddock more robust to changes to the `Language` data type

With the introduction of GHC2021, the `Languages` data type in GHC will
grow. In preparation of that (and to avoid changing haddock with each
new language), this change makes the code handle extensions to that data
type gracefully.

(cherry picked from commit c341dd7c9c3fc5ebc83a2d577c5a726f3eb152a5)

- - - - -
7d6dd57a by John Ericson at 2021-01-22T22:02:02+00:00
Add `NoGhcTc` instance now that it's not closed

- - - - -
e5fdaf0a by Alan Zimmerman at 2021-01-23T22:57:44+00:00
Merge pull request haskell/haddock#1293 from obsidiansystems/wip/fix-18936

Add `NoGhcTc` instance now that it's not closed
- - - - -
989a1e05 by Oleg Grenrus at 2021-01-24T16:11:46+03:00
Add import list to Data.List

- - - - -
368e144a by Ben Gamari at 2021-01-28T22:15:48+01:00
Adapt to "Make PatSyn immutable"

- - - - -
abe66c21 by Alfredo Di Napoli at 2021-02-01T08:05:35+01:00
Rename pprLogErrMsg to new name

- - - - -
e600e75c by Hécate Moonlight at 2021-02-05T14:53:00+01:00
Move CI to ghc-9.0

- - - - -
dd492961 by Vladislav Zavialov at 2021-02-05T14:53:00+01:00
Update cabal.project and README build instructions

- - - - -
31bd292a by Hécate Moonlight at 2021-02-05T15:03:56+01:00
Merge pull request haskell/haddock#1296 from Kleidukos/ghc-9.0

Merge the late additions to ghc-8.10 into ghc-9.0
- - - - -
6388989e by Vladislav Zavialov at 2021-02-05T17:41:57+03:00
Cleanup: fix build warnings

- - - - -
f99407ef by Daniel Rogozin at 2021-02-05T18:11:48+03:00
type level characters support for haddock (required for haskell/haddock#11342)

- - - - -
d8c6b26f by Hécate Moonlight at 2021-02-05T17:44:50+01:00
Add a CONTRIBUTING.md file

- - - - -
6a01ad98 by Hécate Moonlight at 2021-02-05T17:58:16+01:00
Merge pull request haskell/haddock#1312 from Kleidukos/proper-branch-etiquette

Add a CONTRIBUTING.md file
- - - - -
955eecc4 by Vladislav Zavialov at 2021-02-05T20:29:00+03:00
Merge commit 'a917dfd29f3103b69378138477514cbfa38558a9' into ghc-head

- - - - -
47b3d6ab by Hécate Moonlight at 2021-02-05T19:09:38+01:00
Amend the CONTRIBUTING.md file

- - - - -
23de6137 by Hécate Moonlight at 2021-02-05T19:16:49+01:00
Merge pull request haskell/haddock#1313 from Kleidukos/amend-contributing

Amend the CONTRIBUTING.md file
- - - - -
69026b59 by Krzysztof Gogolewski at 2021-02-05T23:05:56+01:00
Display linear/multiplicity arrows correctly (#1238)

Previously we were ignoring multiplicity and displayed
a %1 -> b as a -> b.

(cherry picked from commit b4b4d896d2d68d6c48e7db7bfe95c185ca0709cb)

- - - - -
ea026b78 by Oleg Grenrus at 2021-02-06T17:14:45+01:00
Add import list to Data.List

- - - - -
5204326f by Hécate Moonlight at 2021-02-06T17:15:44+01:00
Merge pull request haskell/haddock#1316 from Kleidukos/explicit-imports-to-data-list

Add import list to Data.List
- - - - -
1f4d2136 by Ben Gamari at 2021-02-06T11:53:31-05:00
Merge remote-tracking branch 'origin/ghc-head' into wip/ghc-head-merge

- - - - -
13f0d09a by Ben Gamari at 2021-02-06T11:53:45-05:00
Fix partial record selector warning

- - - - -
5c115f7e by Ben Gamari at 2021-02-06T11:55:52-05:00
Merge commit 'a917dfd29f3103b69378138477514cbfa38558a9' into wip/ghc-head-merge

- - - - -
b6fd8b75 by Ben Gamari at 2021-02-06T12:01:31-05:00
Merge commit '41964cb2fd54b5a10f8c0f28147015b7d5ad2c02' into wip/ghc-head-merge

- - - - -
a967194c by Ben Gamari at 2021-02-06T18:30:35-05:00
Merge branch 'wip/ghc-head-merge' into ghc-head

- - - - -
1f4c3a91 by MorrowM at 2021-02-07T01:52:33+02:00
Fix search div not scrolling

- - - - -
684b1287 by Iñaki García Etxebarria at 2021-02-07T16:13:04+01:00
Add support for labeled module references

Support a markdown-style way of annotating module references. For instance

-- | [label]("Module.Name#anchor")

will create a link that points to the same place as the module
reference "Module.Name#anchor" but the text displayed on the link will
be "label".

- - - - -
bdb55a5d by Hécate Moonlight at 2021-02-07T16:18:10+01:00
Merge pull request haskell/haddock#1319 from alexbiehl/alex/compat

Backward compat: Add support for labeled module references
- - - - -
6ca70991 by Hécate Moonlight at 2021-02-07T16:21:29+01:00
Merge pull request haskell/haddock#1314 from tweag/show-linear-backport

Backport haskell/haddock#1238 (linear types) to ghc-9.0
- - - - -
d9d73298 by Alex Biehl at 2021-02-07T17:46:25+01:00
Remove dubious parseModLink

Instead construct the ModLink value directly when parsing.

- - - - -
33b4d020 by Hécate Moonlight at 2021-02-07T17:52:05+01:00
Merge pull request haskell/haddock#1320 from haskell/alex/fix

Remove dubious parseModLink
- - - - -
54211316 by Hécate Moonlight at 2021-02-07T18:12:07+01:00
Merge pull request haskell/haddock#1318 from MorrowM/ghc-9.0

Fix search div not scrolling
- - - - -
19db679e by alexbiehl-gc at 2021-02-07T18:14:46+01:00
Merge pull request haskell/haddock#1317 from bgamari/wip/ghc-head-merge

Merge ghc-8.10 into ghc-head
- - - - -
6bc1e9e4 by Willem Van Onsem at 2021-02-07T18:25:30+01:00
simplify calculating percentages fixing haskell/haddock#1194 (#1236)

- - - - -
c8537cf8 by alexbiehl-gc at 2021-02-07T18:30:40+01:00
Merge pull request haskell/haddock#1322 from haskell/alex/forward-port

simplify calculating percentages fixing haskell/haddock#1194 (#1236)
- - - - -
2d47ae4e by alexbiehl-gc at 2021-02-07T18:39:59+01:00
Merge branch 'ghc-head' into ghc-9.0
- - - - -
849e4733 by Hécate Moonlight at 2021-02-07T18:43:19+01:00
Merge pull request haskell/haddock#1321 from Kleidukos/ghc-9.0

Merge ghc-9.0 into ghc-head
- - - - -
ee6095d7 by Sylvain Henry at 2021-02-08T11:36:38+01:00
Update for Logger

- - - - -
4ad688c9 by Alex Biehl at 2021-02-08T18:11:24+01:00
Merge pull request haskell/haddock#1310 from hsyl20/wip/hsyl20/logger2

Logger refactoring
- - - - -
922a9e0e by Ben Gamari at 2021-02-08T12:54:33-05:00
Merge remote-tracking branch 'upstream/ghc-head' into ghc-head

- - - - -
991649d2 by Sylvain Henry at 2021-02-09T10:55:17+01:00
Fix to build with HEAD

- - - - -
a8348dc2 by Hécate Moonlight at 2021-02-09T10:58:51+01:00
Merge pull request haskell/haddock#1327 from hsyl20/wip/hsyl20/logger2

Fix to build with HEAD
- - - - -
0abdbca6 by Fendor at 2021-02-09T20:06:15+01:00
Add UnitId to Target record

- - - - -
d5790a0e by Alex Biehl at 2021-02-11T10:32:32+01:00
Stable sort for (data/newtype) instances

- - - - -
8e6036f5 by Alex Biehl at 2021-02-11T10:32:32+01:00
Also make TyLit deterministic

- - - - -
f76d2945 by Hécate Moonlight at 2021-02-11T11:00:31+01:00
Merge pull request haskell/haddock#1329 from hsyl20/hsyl20/stabe_iface

Stable sort for instances
- - - - -
5e0469ea by Oleg Grenrus at 2021-02-14T15:28:15+02:00
Add import list to Data.List in Haddock.Interface.Create

- - - - -
fa57cd24 by Hécate Moonlight at 2021-02-14T17:19:27+01:00
Merge pull request haskell/haddock#1331 from phadej/more-explicit-data-list-imports

Add import list to Data.List in Haddock.Interface.Create
- - - - -
f0cd629c by Hécate Moonlight at 2021-02-21T00:22:01+01:00
Merge pull request haskell/haddock#1311 from fendor/wip/add-targetUnitId-to-target

Add UnitId to Target record
- - - - -
674ef723 by Joachim Breitner at 2021-02-22T10:39:18+01:00
html-test: Always set language

from ghc-9.2 on, the “default” langauge of GHC is expected to change
more wildly. To prepare for that (and unblock
https://gitlab.haskell.org/ghc/ghc/-/merge_requests/4853), this sets the
language for all the test files to `Haskell2010`. This should insolate
this test suite against changes to the default.

Cherry-picked from https://github.com/haskell/haddock/pull/1341

- - - - -
f072d623 by Hécate Moonlight at 2021-02-22T10:56:51+01:00
Merge pull request haskell/haddock#1342 from nomeata/joachim/haskell2010-in-tests-ghc-head

html-test: Always set language
- - - - -
caebbfca by Hécate Moonlight at 2021-02-22T11:53:07+01:00
Clean-up of Interface and Interface.Create's imports and pragmata

- - - - -
f6caa89d by Hécate Moonlight at 2021-02-22T11:54:58+01:00
Merge pull request haskell/haddock#1345 from Kleidukos/head/fix-interface-imports

[ghc-head] Clean-up of Interface and Interface.Create's imports and pragmata 
- - - - -
7395c9cb by Hécate Moonlight at 2021-02-22T18:44:57+01:00
Explicit imports for Haddock.Interface and Haddock.Interface.Create

- - - - -
6e9fb5d5 by Hécate Moonlight at 2021-02-22T18:45:28+01:00
Merge pull request haskell/haddock#1348 from Kleidukos/head/explicit-imports-interface

Explicit imports for Haddock.Interface and Haddock.Interface.Create
- - - - -
9198b118 by Alan Zimmerman at 2021-02-22T20:04:24+00:00
Context becomes a Maybe in the GHC AST

This prevents noLoc's appearing in the ParsedSource.

Match the change in GHC.

- - - - -
0af20f64 by Hécate Moonlight at 2021-02-23T12:36:12+01:00
Fix the call-site of guessTarget in Interface.hs

Explicit the imports from GHC.HsToCore.Docs

- - - - -
b7886885 by Hécate Moonlight at 2021-02-23T12:37:54+01:00
Merge pull request haskell/haddock#1349 from Kleidukos/fix-interface-guesstarget-call

Fix the call-site of guessTarget in Interface.hs
- - - - -
9cf041ba by Sylvain Henry at 2021-02-24T11:08:20+01:00
Fix haddockHypsrcTest output in ghc-head

- - - - -
b194182a by Hécate Moonlight at 2021-02-24T11:12:36+01:00
Merge pull request haskell/haddock#1351 from hsyl20/wip/hsyl20/fix-head

Fix haddockHypsrcTest output in ghc-head
- - - - -
3ce8b375 by Shayne Fletcher at 2021-03-06T09:55:03-05:00
Add ITproj to parser

- - - - -
d2abf762 by Ben Gamari at 2021-03-06T19:26:49-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
a0f6047d by Andrew Martin at 2021-03-07T11:25:23-05:00
Update for boxed rep

- - - - -
6f63c99e by Ben Gamari at 2021-03-10T13:20:21-05:00
Update for "FastString: Use FastMutInt instead of IORef Int"

- - - - -
e13f01df by Luke Lau at 2021-03-10T15:38:40-05:00
Implement template-haskell's putDoc

This catches up to GHC using the new extractTHDocs function, which
returns documentation added via the putDoc function (provided it was
compiled with Opt_Haddock). Since it's already a map from names -> docs,
there's no need to do traversal etc.
It also matches the change from the argument map being made an IntMap
rather than a Map Int

- - - - -
89263d94 by Alan Zimmerman at 2021-03-15T17:15:26+00:00
Match changes in GHC AST for in-tree API Annotations

As landed via https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2418

- - - - -
28db1934 by Alan Zimmerman at 2021-03-15T20:40:09+00:00
Change some type family test results.

It is not clear to me whether the original was printing
incorrectly (since we did not have the TopLevel flag before now), or
if this behaviour is expected.

For the time being I am assuming the former.

- - - - -
7c11c989 by Sylvain Henry at 2021-03-22T10:05:19+01:00
Fix after NameCache changes

- - - - -
addbde15 by Sylvain Henry at 2021-03-22T10:05:19+01:00
NameCache doesn't store a UniqSupply anymore

- - - - -
15ec6cec by Ben Gamari at 2021-03-22T17:53:44-04:00
Bump GHC version to 9.2

- - - - -
dbd6aa63 by Hécate Moonlight at 2021-03-24T14:28:36+01:00
Merge pull request haskell/haddock#1365 from hsyl20/wip/hsyl20/iface1

NameCache refactoring
- - - - -
2d32da7e by Oleg Grenrus at 2021-03-27T01:12:00+02:00
Specialization of Data.List

- - - - -
32b84fa6 by Fendor at 2021-03-27T10:50:17+01:00
Add UnitId to Target record

This way we always know to which home-unit a given target belongs to.
So far, there only exists a single home-unit at a time, but it
enables having multiple home-units at the same time.

- - - - -
54bf9f0e by Hécate Moonlight at 2021-03-28T14:08:35+02:00
Merge pull request haskell/haddock#1368 from fendor/target-unit-id-revert

Add UnitId to Target record
- - - - -
7dea168a by Alan Zimmerman at 2021-03-29T08:45:52+01:00
EPA : Rename ApiAnn to EpAnn

- - - - -
72967f65 by Alfredo Di Napoli at 2021-03-29T09:47:01+02:00
pprError changed name in GHC

- - - - -
4bc61035 by Alan Zimmerman at 2021-03-29T16:16:27-04:00
EPA : Rename ApiAnn to EpAnn

- - - - -
108d031d by Ben Gamari at 2021-03-29T18:49:36-04:00
Merge commit '36418c4f70d7d2b179a77925b3ad5caedb08c9b5' into HEAD

- - - - -
1444f700 by Ben Gamari at 2021-03-31T09:18:39-04:00
Merge pull request haskell/haddock#1370 from adinapoli/wip/adinapoli-diag-reason-severity

Rename pprError to mkParserErr
- - - - -
d3087b79 by Ben Gamari at 2021-03-31T11:34:17-04:00
Merge commit 'd8d8024ad6796549a8d3b5512dabf3288d14e30f' into ghc-head

- - - - -
170b79e9 by Ben Gamari at 2021-03-31T12:24:56-04:00
Merge remote-tracking branch 'upstream/ghc-head' into ghc-head

- - - - -
db0d6bae by Ben Gamari at 2021-04-10T09:34:35-04:00
Bump GHC version to 9.3

- - - - -
a9f2c421 by Alan Zimmerman at 2021-04-19T18:26:46-04:00
Update for EPA changes in GHC

(cherry picked from commit cafb48118f7c111020663776845897e225607b41)

- - - - -
1ee4b7c7 by Sylvain Henry at 2021-05-11T10:00:06+02:00
Removal of HsVersions.h (#1388)

* Update for EPA changes in GHC

* Account for HsVersions.h removal

Co-authored-by: Alan Zimmerman <alan.zimm at gmail.com>
- - - - -
79e819e9 by Hécate Moonlight at 2021-05-11T10:14:47+02:00
Revert "Removal of HsVersions.h (#1388)"

This reverts commit 72118896464f94d81f10c52f5d9261efcacc57a6.

- - - - -
3dbd3f8b by Alan Zimmerman at 2021-05-11T10:15:17+02:00
Update for EPA changes in GHC

- - - - -
2ce80c17 by Sylvain Henry at 2021-05-11T10:15:19+02:00
Account for HsVersions.h removal

- - - - -
00e4c918 by Christiaan Baaij at 2021-05-13T08:21:56+02:00
Add Haddock support for the OPAQUE pragma (#1380)


- - - - -
8f9049b2 by Hécate Moonlight at 2021-05-13T08:40:22+02:00
fixup! Use GHC 9.2 in CI runner

- - - - -
27ddec38 by Alan Zimmerman at 2021-05-13T22:51:20+01:00
EPA: match changes from GHC T19834

- - - - -
f8a1d714 by Felix Yan at 2021-05-14T17:10:04+02:00
Allow hspec 2.8 (#1389)

All tests are passing.
- - - - -
df44453b by Divam Narula at 2021-05-20T15:42:42+02:00
Update ref, the variables got renamed. (#1391)

This is due to ghc/ghc!5555 which caused a change in ModDetails in case of
NoBackend. Now the initModDetails is used to recreate the ModDetails from
interface and in-memory ModDetails is not used.
- - - - -
e46bfc87 by Alan Zimmerman at 2021-05-20T19:05:09+01:00
Remove Maybe from HsQualTy

Match changes in GHC for haskell/haddock#19845

- - - - -
79bd7b62 by Shayne Fletcher at 2021-05-22T08:20:39+10:00
FieldOcc: rename extFieldOcc to foExt

- - - - -
6ed68c74 by Ben Gamari at 2021-05-21T22:29:30-04:00
Merge commit '3b6a8774bdb543dad59b2618458b07feab8a55e9' into ghc-head

- - - - -
f9a02d34 by Alfredo Di Napoli at 2021-05-24T13:53:00+02:00
New Parser diagnostics interface

- - - - -
392807d0 by Ben Gamari at 2021-05-24T09:57:40-04:00
Merge pull request haskell/haddock#1394 from adinapoli/wip/adinapoli-align-ps-messages

Align Haddock to use the new Parser diagnostics interface
- - - - -
33023cd8 by Ben Gamari at 2021-05-24T11:19:16-04:00
Revert "Add Haddock support for the OPAQUE pragma (#1380)"

This reverts commit a1337c599ef7720b0482a25c55f11794112496dc.

The GHC patch associated with this change is not yet ready to be merged.

- - - - -
8c005af7 by Ben Simms at 2021-05-28T07:56:20+02:00
CI configuration for ghc-head (#1395)


- - - - -
1e947612 by Hécate Moonlight at 2021-05-28T12:27:35+02:00
Use GHC 9.2 in CI runner (#1378)


- - - - -
e6fa10ab by CGenie at 2021-05-31T09:02:13+02:00
Add page about common errors (#1396)

* Update index.rst

Common errors page

* Create common-errors.rst

* Update common-errors.rst

* Use GHC 9.2 in CI runner (#1378)

* [haddock-api] remove .hspec-failures

Co-authored-by: Hécate Moonlight <Kleidukos at users.noreply.github.com>
- - - - -
abc72a8d by Sylvain Henry at 2021-06-01T10:02:06+02:00
Adapt Haddock to Logger and Parser changes (#1399)


- - - - -
91373656 by Zubin Duggal at 2021-06-01T20:45:10+02:00
Update haddockHypSrc tests since we now compute slighly more type info (#1397)


- - - - -
ed712822 by Marcin Szamotulski at 2021-06-02T08:54:33+02:00
Added myself to contributors

- - - - -
49fdbcb7 by Marcin Szamotulski at 2021-06-02T08:57:24+02:00
Document multi component support

- - - - -
9ddc8d7d by Hécate Moonlight at 2021-06-02T09:35:55+02:00
Merge pull request haskell/haddock#1379 from coot/coot/document-multi-component-support

Document multi component support
- - - - -
585b5c5e by Ben Simms at 2021-06-02T19:46:54+02:00
Update CONTRIBUTING.md (#1402)


- - - - -
1df4a605 by Ben Simms at 2021-06-02T19:47:14+02:00
Update CONTRIBUTING.md (#1403)


- - - - -
58ea43d2 by sheaf at 2021-06-02T22:09:06+02:00
Update Haddock Bug873 to account for renaming

- - - - -
c5d0ab23 by Vladislav Zavialov at 2021-06-10T13:35:42+03:00
HsToken in FunTy, RecConGADT

- - - - -
1ae2f40c by Hécate Moonlight at 2021-06-11T11:19:09+02:00
Update the CI badges
- - - - -
6fdc4de2 by Sylvain Henry at 2021-06-28T19:21:17+02:00
Fix mkParserOpts (#1411)


- - - - -
18201670 by Alfredo Di Napoli at 2021-07-05T07:55:12+02:00
Rename getErrorMessages Lexer import

This commit renames the Lexer import in `Hyperlinker.Parser` from
`getErrorMessages` to `getPsErrorMessages` to eliminate the ambiguity
with the `getErrorMessages` function defined in `GHC.Types.Error`.

- - - - -
23173ca3 by Ben Gamari at 2021-07-07T11:31:44-04:00
Merge pull request haskell/haddock#1413 from adinapoli/wip/adinapoli-issue-19920

Rename getErrorMessages Lexer import
- - - - -
b3dc4ed8 by Alan Zimmerman at 2021-07-28T22:30:59+01:00
EPA: match changes from GHC T19834

(cherry picked from commit 2fec1b44e0ee7e263286709aa528b4ecb99ac6c2)

- - - - -
5f177278 by Ben Gamari at 2021-08-06T01:17:37-04:00
Merge commit '2a966c8ca37' into HEAD

- - - - -
cdd81d08 by Marcin Szamotulski at 2021-08-08T17:19:06+02:00
coot/multiple packages (ghc-9.2) (#1418)


- - - - -
be0d71f1 by Marcin Szamotulski at 2021-08-16T08:46:03+02:00
coot/multiple package (ghc-head) (#1419)

* FromJSON class

Aeson style FromJSON class with Parsec based json parser.

* doc-index.json file for multiple packages

When creating haddock summary page for multiple packages render
doc-index.json file using contents of all found 'doc-index.json' files.

* Render doc-index.json

When rendering html, render doc-index.json file independently of
maybe_index_url option.  doc-index.json file is useful now even if
maybe_index_url is not `Nothing`.

* base url option

New `Flag_BaseURL` which configures from where static files are loaded
(--base-url).  If given and not equal "." static files are not coppied,
as this indicates that they are not read from the the directory where
we'd copy them.  The default value is ".".
- - - - -
3b09dbdf by Hécate Moonlight at 2021-10-07T23:26:03+02:00
Update GHC 9.2 to latest pre-release in CI

- - - - -
7ac55417 by Zubin Duggal at 2021-10-11T12:10:19+02:00
Enable Haddock tests in GHC windows CI (#1428)

* testsuite: strip windows line endings for haddock

* hyperlinker: Work around double escaping (#19236)

* deterministic SCC
- - - - -
1cb81f25 by Andrew Lelechenko at 2021-10-12T15:23:19+02:00
haddock-library does not depend on bytestring or transformers (#1426)


- - - - -
a890b9aa by sheaf at 2021-10-15T22:19:42+02:00
update haddockHypsrcTest for GHC MR !6705 (#1430)


- - - - -
42a55c6c by Sylvain Henry at 2021-10-15T22:20:10+02:00
Fix after PkgQual refactoring (#1429)


- - - - -
91659238 by Alan Zimmerman at 2021-10-28T18:57:10+01:00
Update for changes in GHC for branch

wip/az/no-srcspan-anno-instances

- - - - -
acf23e60 by Vladislav Zavialov at 2021-11-05T02:09:47+03:00
Do not use forall as an identifier

See GHC ticket haskell/haddock#20609

- - - - -
c565db0e by Krzysztof Gogolewski at 2021-11-27T02:42:35+01:00
Update after NoExtCon -> DataConCantHappen rename

- - - - -
b5f55590 by Artem Pelenitsyn at 2021-11-27T11:14:17+01:00
fix CI for 9.2 (#1436)


- - - - -
25cd621e by Matthew Pickering at 2021-12-02T11:46:54+00:00
Update html-test for Data.List revert

- - - - -
1d5ff85f by malteneuss at 2021-12-15T07:56:55+01:00
Add hint about inline link issue (#1444)


- - - - -
791fde81 by Sylvain Henry at 2021-12-16T09:29:51+01:00
Bump ghc-head (#1445)

* Update after NoExtCon -> DataConCantHappen rename

* Update html-test for Data.List revert

* Fix for new Plugins datatype

Co-authored-by: Krzysztof Gogolewski <krzysztof.gogolewski at tweag.io>
Co-authored-by: Matthew Pickering <matthewtpickering at gmail.com>
- - - - -
44236317 by Sylvain Henry at 2021-12-17T09:39:00+01:00
Fix for new Plugins datatype

- - - - -
80ada0fa by Hécate Moonlight at 2021-12-17T17:28:48+01:00
Remove ghc-head workflow (#1446)

Contributions of GHC glue code are now done on the GHC gitlab, not in the GitHub repo anymore.
- - - - -
49e171cd by Matthew Pickering at 2021-12-28T09:47:09+00:00
Remove use of ExtendedModSummary

- - - - -
0e91b5ea by askeblad at 2022-01-04T09:18:35+01:00
update URLs
- - - - -
9f13c212 by Hécate Moonlight at 2022-02-25T10:19:46+01:00
Fix solver for GHC 9.2

- - - - -
386751a1 by Meng Weng Wong at 2022-02-25T19:19:11+01:00
IDoc link has bitrotted; replaced with web.archive.org cache. (#1454)


- - - - -
d877cbe6 by Hécate Moonlight at 2022-02-25T19:21:58+01:00
Fix haddock user guide  (#1456)


- - - - -
cc47f036 by Andrew Lelechenko at 2022-03-04T17:29:36+01:00
Allow text-2.0 in haddock-library (#1459)


- - - - -
7b3685a3 by malteneuss at 2022-03-07T19:27:24+01:00
Add multi-line style hint to style section (#1460)


- - - - -
c51088b8 by John Ericson at 2022-03-11T16:46:26+01:00
Fix CollectPass instance to match TTG refactor

Companion to GHC !7614 (https://gitlab.haskell.org/ghc/ghc/-/merge_requests/7614)

- - - - -
b882195b by Vladislav Zavialov at 2022-03-14T20:32:30+01:00
Link to (~)

- - - - -
877349b8 by Christiaan Baaij at 2022-03-16T09:20:43+01:00
Add Haddock support for the OPAQUE pragma

- - - - -
0ea22721 by askeblad at 2022-03-16T09:44:27+01:00
typos (#1464)


- - - - -
a6d13da1 by Matthew Pickering at 2022-03-22T13:41:17+00:00
Minimum changes needed for compilation with hi-haddock

With hi-haddock, of course there is a much large refactoring of haddock
which could be achieved but that is left for a future patch which can
implemented at any time independently of GHC.

- - - - -
e7ac9129 by Matthew Pickering at 2022-03-22T21:17:50+00:00
Update test output

- - - - -
6d916214 by Matthew Pickering at 2022-03-24T15:06:26+00:00
Merge branch 'wip/opaque_pragma' into 'ghc-head'

Add Haddock support for the OPAQUE pragma

See merge request ghc/haddock!2
- - - - -
42208183 by Steve Hart at 2022-03-25T20:43:50+01:00
Fix CI (#1467)

* CI: Reinstall GHC with docs

CI tests were failing because the GHC preinstalled to the CI
environment does not include documentation, which is required for
running the Haddock tests. This commit causes the CI workflow to
reinstall GHC with docs so that tests can succeed.
- - - - -
9676fd79 by Steve Hart at 2022-03-25T21:33:34+01:00
Make links in Synopsis functional again (#1458)

Commit e41c1cbe9f0476997eac7b4a3f17cbc6b2262faf added a call to
e.preventDefault() when handling click events that reach a toggle
element. This prevents the browser from following hyperlinks within the
Synopsis section when they are clicked by a user. This commit restores
functioning hyperlinks within the Synopsis section by removing the call
to e.preventDefault(), as it does not appear to be necessary, and
removing it increases the flexibility of the details-helper code.
- - - - -
d1edd637 by sheaf at 2022-04-01T12:02:02+02:00
Keep track of promotion ticks in HsOpTy

Keeping track of promotion ticks in HsOpTy allows us to properly
pretty-print promoted constructors such as lists.

- - - - -
9dcb2dfc by Jakob Brünker at 2022-04-01T15:46:22+00:00
Add support for \cases

See merge request ghc/ghc!7873
- - - - -
b0412ee5 by askeblad at 2022-04-06T17:47:57+02:00
spelling errors (#1471)


- - - - -
6b18829b by Vladislav Zavialov at 2022-04-06T18:53:58+02:00
Rename [] to List

- - - - -
2d046691 by Vladislav Zavialov at 2022-04-07T20:25:54+03:00
HsToken ConDeclGADT con_dcolon

- - - - -
90b43da4 by Steve Hart at 2022-04-12T13:29:46+02:00
Parse Markdown links at beginning of line within a paragraph (#1470)

* Catch Markdown links at beginning of line within paragraph

Per Issue haskell/haddock#774, Markdown links were being parsed as ordinary text when
they occurred at the beginning of a line other than the first line of
the paragraph. This occurred because the parser was not interpreting a
left square bracket as a special character that could delimit special
markup. A space character was considered a special character, so, if a
space occurred at the beginning of the new line, then the parser would
interpret the space by itself and then continue parsing, thereby
catching the Markdown link. '\n' was not treated as a special character,
so the parser did not catch a Markdown link that may have followed.

Note that this will allow for Markdown links that are not surrounded by
spaces. For example, the following text includes a Markdown link that
will be parsed:

  Hello, world[label](url)

This is consistent with how the parser handles other types of markup.

* Remove obsolete documentation hint

Commit 6b9aeafddf20efc65d3725c16e3fc43a20aac343 should eliminate the
need for the workaround suggested in the documentation.
- - - - -
5b08312d by Hécate Moonlight at 2022-04-12T13:36:38+02:00
Force ghc-9.2 in the cabal.project

- - - - -
0d0ea349 by dependabot[bot] at 2022-04-12T13:57:41+02:00
Bump path-parse from 1.0.5 to 1.0.7 in /haddock-api/resources/html (#1469)

Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.5 to 1.0.7.
- [Release notes](https://github.com/jbgutierrez/path-parse/releases)
- [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7)

---
updated-dependencies:
- dependency-name: path-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support at github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- - - - -
2b9fc65e by dependabot[bot] at 2022-04-12T13:57:54+02:00
Bump copy-props from 2.0.4 to 2.0.5 in /haddock-api/resources/html (#1468)

Bumps [copy-props](https://github.com/gulpjs/copy-props) from 2.0.4 to 2.0.5.
- [Release notes](https://github.com/gulpjs/copy-props/releases)
- [Changelog](https://github.com/gulpjs/copy-props/blob/master/CHANGELOG.md)
- [Commits](https://github.com/gulpjs/copy-props/compare/2.0.4...2.0.5)

---
updated-dependencies:
- dependency-name: copy-props
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support at github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- - - - -
ea98a6fb by Ben Gamari at 2022-04-23T22:54:37-04:00
Update for GHC 9.4

- - - - -
9e11864f by Ben Gamari at 2022-04-25T16:24:31-04:00
Merge remote-tracking branch 'upstream/ghc-9.2' into ghc-head

- - - - -
f83cc506 by Ben Gamari at 2022-04-25T17:00:25-04:00
Bump ghc version to 9.5

- - - - -
e01c2e7d by Ben Gamari at 2022-04-28T16:19:04-04:00
Revert "Bump ghc-head (#1445)"

This reverts commit b29a78ef6926101338f62e84f456dac8659dc9d2.

This should not have been merged.

- - - - -
a2b5ee8c by Ben Gamari at 2022-04-28T16:19:24-04:00
Merge commit '2627a86c' into ghc-head

- - - - -
0c6fe4f9 by Ben Gamari at 2022-04-29T10:05:54-04:00
Merge remote-tracking branch 'origin/ghc-head' into ghc-9.4

- - - - -
b6e5cb0a by Ben Gamari at 2022-04-29T11:46:06-04:00
Revert "HsToken ConDeclGADT con_dcolon"

This reverts commit 24208496649a02d5f87373052c430ea4a97842c5.

- - - - -
15a62888 by Ben Gamari at 2022-04-29T15:12:55-04:00
Bump base upper bound

- - - - -
165b9031 by Ben Gamari at 2022-04-29T23:58:38-04:00
Update test output

- - - - -
e0c3e5da by Phil de Joux at 2022-05-02T14:46:38+02:00
Add hlint action .hlint.yaml with ignores & CPP. (#1475)


- - - - -
ead1158d by Raphael Das Gupta at 2022-05-02T14:46:48+02:00
fix grammar in docs: "can the" → "can be" (#1477)


- - - - -
cff97944 by Ben Gamari at 2022-05-02T18:38:56-04:00
Allow base-4.17

- - - - -
e4ecb201 by Phil de Joux at 2022-05-03T13:14:55+02:00
Remove unused imports that GHC warned about. (#1480)


- - - - -
222890b1 by Phil de Joux at 2022-05-03T13:15:46+02:00
Follow hlint suggestion to remove redundant bang. (#1479)


- - - - -
058b671f by Phil de Joux at 2022-05-03T13:34:04+02:00
Follow hlint, remove language pragmas in libs. (#1478)


- - - - -
0a645049 by Ben Simms at 2022-05-03T14:19:24+02:00
Keep track of ordered list indexes and render them (#1407)

* Keep track of ordered list indexes and render them

* Rename some identifiers to clarify
- - - - -
f0433304 by Norman Ramsey at 2022-05-04T15:13:34-04:00
update for changes in GHC API

- - - - -
3740cf71 by Emily Martins at 2022-05-06T18:23:48+02:00
Add link to the readthedocs in cabal description to show on hackage.

(cherry picked from commit 52e2d40d47295c02d3181aac0c53028e730f1e3b)

- - - - -
5d754f1e by Hécate Moonlight at 2022-05-06T18:44:57+02:00
remove Bug873

- - - - -
968fc267 by Hécate Moonlight at 2022-05-06T18:48:28+02:00
Ignore "Use second" HLint suggestion. It increases laziness.

- - - - -
02d14e97 by Jade Lovelace at 2022-05-07T17:42:08+02:00
Fix hyperlinks to external items and modules (#1482)

Fixes haskell/haddock#1481.

There were two bugs in this:
* We were assuming that we were always getting a relative path to the
  module in question, while Nix gives us file:// URLs sometimes. This
  change checks for those and stops prepending `..` to them.
* We were not linking to the file under the module. This seems
  to have been a regression introduced by haskell/haddock#977. That is, the URLs were
  going to something like
  file:///nix/store/3bwbsy0llxxn1pixx3ll02alln56ivxy-ghc-9.0.2-doc/share/doc/ghc/html/libraries/base-4.15.1.0/src
  which does not have the appropriate HTML file or fragment for the item
  in question at the end.

There is a remaining instance of the latter bug, but not in the
hyperlinker: the source links to items reexported from other modules are
also not including the correct file name. e.g. the reexport of Entity in
esqueleto, from persistent.

NOTE: This needs to get tested with relative-path located modules. It seems
correct for Nix based on my testing.

Testing strategy:

```
nix-shell '<nixpkgs>' --pure -A haskell.packages.ghc922.aeson
mkdir /tmp/aesonbuild && cd /tmp/aesonbuild
export out=/tmp/aesonbuild/out
genericBuild

ln -sf $HOME/co/haddock/haddock-api/resources .
./Setup haddock --with-haddock=$HOME/path/to/haddock/exec --hyperlink-source
```
- - - - -
b22b87ed by Artem Pelenitsyn at 2022-05-08T16:19:47+02:00
fix parsing trailing quotes in backticked identifiers (#1408) (#1483)


- - - - -
80ae107b by Alex Biehl at 2022-05-08T16:37:16+02:00
Fix "Defined by not used" error

(cherry picked from commit 6e02a620a26c3a44f98675dd1b93b08070c36c0a)

- - - - -
4c838e84 by Hécate Moonlight at 2022-05-08T16:37:16+02:00
Fix the changelog and bump the version of haddock-library on ghc-9.2

- - - - -
fc9827b4 by Hécate Moonlight at 2022-05-08T16:40:40+02:00
Fix the changelog and bump the version of haddock-library on ghc-9.2

- - - - -
b153b555 by Xia Li-yao at 2022-05-20T17:52:42+02:00
Hide synopsis from search when hidden (#1486)

Fix haskell/haddock#1451
- - - - -
f3e38b85 by Marcin Szamotulski at 2022-05-21T23:32:31+02:00
Allow to hide interfaces when rendering multiple components (#1487)

This is useful when one wishes to `--gen-contents` when rendering
multiple components, but one does not want to render all modules.  This
is in particular useful when adding base package.
- - - - -
f942863b by Marcin Szamotulski at 2022-05-24T08:29:59+02:00
Check if doc-index.json exists before reading it (#1488)


- - - - -
31e92982 by Marcin Szamotulski at 2022-05-25T16:22:13+02:00
Version bump 2.26.1 (#1489)

* Version bump 2.26.1

We extended format accepted by `--read-interface` option, which requires
updating the minor version.

* Update documentation of --read-interface option
- - - - -
7cc873e0 by sheaf at 2022-05-25T16:42:31+02:00
Updated HaddockHypsrcTest output for record update changes (MR !7981)

- - - - -
cd196942 by Marcin Szamotulski at 2022-05-25T20:28:47+02:00
Use visibility to decide which interfaces are included in quickjump (#1490)

This is also consistent with how html index is build.  See
haskell/cabal#7669 for rationale behind this decision.
- - - - -
00c713c5 by Hécate Moonlight at 2022-05-26T17:09:15+02:00
Add code of conduct and hspec failure files in .gitignore

- - - - -
2f3039f1 by Hécate Moonlight at 2022-05-26T17:10:59+02:00
Add code of conduct and hspec failure files in .gitignore

- - - - -
63a5650c by romes at 2022-05-31T12:43:22+01:00
TTG: Match new GHC AST

- - - - -
dd7d1617 by romes at 2022-06-02T16:11:00+01:00
Update for IE changes in !8228

- - - - -
c23aaab7 by cydparser at 2022-06-06T08:48:14+02:00
Fix and improve CI (#1495)

* Pin GHC version before creating the freeze file

* Use newest action versions

* Improve caching

* Avoid unnecessarily reinstalling GHC

* Use GHC 9.2.2 for CI

Co-authored-by: Cyd Wise <cwise at tripshot.com>
- - - - -
c156fa77 by Hécate Moonlight at 2022-06-06T11:59:35+02:00
Add Mergify configuration (#1496)


- - - - -
2dba4188 by Hécate Moonlight at 2022-06-06T16:12:50+02:00
Bump haddock's version in cabal file to 2.26.1 (#1497)


- - - - -
d7d4b8b9 by Marcin Szamotulski at 2022-06-07T06:09:40+00:00
Render module tree per package in the content page (#1492)

* Render module tree per package in the content page

When rendering content page for multiple packages it is useful to split
the module tree per package.  Package names in this patch are inferred
from haddock's interface file names.

* Write PackageInfo into interface file

To keep interface file format backward compatible, instead of using
`Binary` instance for `InterfaceFile` we introduce functions to
serialise and deserialise, which depends on the interface file version.
- - - - -
77765665 by Mike Pilgrem at 2022-06-12T21:57:19+01:00
Fix haskell/haddock#783 Don't show button if --quickjump not present

- - - - -
b0e079b0 by mergify[bot] at 2022-06-13T11:49:37+00:00
Merge pull request haskell/haddock#1108 from mpilgrem/fix783

Fix haskell/haddock#783 Don't show button if --quickjump not present
- - - - -
6c0292b1 by Hécate Moonlight at 2022-06-21T17:21:08+02:00
Update the contribution guide

- - - - -
e413b9fa by dependabot[bot] at 2022-06-21T23:38:19+02:00
Bump shell-quote from 1.6.1 to 1.7.3 in /haddock-api/resources/html (#1500)

Bumps [shell-quote](https://github.com/substack/node-shell-quote) from 1.6.1 to 1.7.3.
- [Release notes](https://github.com/substack/node-shell-quote/releases)
- [Changelog](https://github.com/substack/node-shell-quote/blob/master/CHANGELOG.md)
- [Commits](https://github.com/substack/node-shell-quote/compare/1.6.1...1.7.3)

---
updated-dependencies:
- dependency-name: shell-quote
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support at github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- - - - -
29d0ef70 by romes at 2022-07-06T11:29:39+02:00
TTG: AST Updates for !8308

- - - - -
1bae7c87 by Alan Zimmerman at 2022-07-06T22:50:43+01:00
Match GHC changes for T21805

This brings in a newtype for FieldLabelString

- - - - -
6fe8b988 by Phil de Joux at 2022-07-16T20:54:26+00:00
Bump hlint version to 3.4.1, the version with counts. (#1503)

Redo the counts available with the --default option.
- - - - -
48fb43af by Phil de Joux at 2022-07-19T09:32:55+02:00
Follow hlint suggestion: unused LANGUAGE pragma. (#1504)

* Follow hlint suggestion: unused LANGUAGE pragma.

* Ignore within modules to pass linting and pass tests.
- - - - -
c1cf1fa7 by Phil de Joux at 2022-07-24T13:45:59+02:00
Follow hlint suggestion: redundant $. (#1505)

* Follow hlint suggestion: redundant $.

* Remove $ and surplus blank lines in Operators.
- - - - -
74777eb2 by Jade Lovelace at 2022-07-29T11:02:41+01:00
Fix hyperlinks to external items and modules (#1482)

Fixes haskell/haddock#1481.

There were two bugs in this:
* We were assuming that we were always getting a relative path to the
  module in question, while Nix gives us file:// URLs sometimes. This
  change checks for those and stops prepending `..` to them.
* We were not linking to the file under the module. This seems
  to have been a regression introduced by haskell/haddock#977. That is, the URLs were
  going to something like
  file:///nix/store/3bwbsy0llxxn1pixx3ll02alln56ivxy-ghc-9.0.2-doc/share/doc/ghc/html/libraries/base-4.15.1.0/src
  which does not have the appropriate HTML file or fragment for the item
  in question at the end.

There is a remaining instance of the latter bug, but not in the
hyperlinker: the source links to items reexported from other modules are
also not including the correct file name. e.g. the reexport of Entity in
esqueleto, from persistent.

NOTE: This needs to get tested with relative-path located modules. It seems
correct for Nix based on my testing.

Testing strategy:

```
nix-shell '<nixpkgs>' --pure -A haskell.packages.ghc922.aeson
mkdir /tmp/aesonbuild && cd /tmp/aesonbuild
export out=/tmp/aesonbuild/out
genericBuild

ln -sf $HOME/co/haddock/haddock-api/resources .
./Setup haddock --with-haddock=$HOME/path/to/haddock/exec --hyperlink-source
```

(cherry picked from commit ab53ccf089ea703b767581ac14be0f6c78a7678a)

- - - - -
faa4cfcf by Hécate Moonlight at 2022-07-29T20:31:20+02:00
Merge pull request haskell/haddock#1516 from duog/9-4-backport-fix-hyperlinks

Backport 9-4: Fix hyperlinks to external items and modules (#1482)
- - - - -
5d2450f3 by Ben Gamari at 2022-08-05T17:41:15-04:00
Merge remote-tracking branch 'origin/ghc-9.4'

- - - - -
63954f73 by Ben Gamari at 2022-08-05T19:08:36-04:00
Clean up build and testsuite for GHC 9.4

- - - - -
d4568cb8 by Hécate Moonlight at 2022-08-05T19:10:49-04:00
Bump the versions

- - - - -
505583a4 by Ben Gamari at 2022-08-06T13:58:27-04:00
Merge pull request haskell/haddock#1518 from bgamari/wip/ghc-9.4-merge

Merge GHC 9.4 into `main`
- - - - -
5706f6a4 by Ben Gamari at 2022-08-06T22:57:21-04:00
html-test: Testsuite changes for GHC 9.4.1

- - - - -
5f2a45a2 by Ben Gamari at 2022-08-15T14:33:05-04:00
doc: Fix a few minor ReST issues

Sphinx was complaining about too-short title underlines.

- - - - -
220e6410 by Ben Gamari at 2022-08-15T14:41:24-04:00
Merge branch 'main' into ghc-head

- - - - -
fbeb1b02 by Ben Gamari at 2022-08-15T14:45:16-04:00
Updates for GHC 9.5

- - - - -
eee562eb by Vladislav Zavialov at 2022-08-15T14:46:13-04:00
HsToken ConDeclGADT con_dcolon

- - - - -
c5f073db by Ben Gamari at 2022-08-15T16:55:35-04:00
Updates for GHC 9.5

- - - - -
3f7ab242 by Vladislav Zavialov at 2022-08-15T16:55:35-04:00
HsToken ConDeclGADT con_dcolon

- - - - -
a18e473d by Ben Gamari at 2022-08-16T08:35:19-04:00
Merge branch 'wip/ghc-head-bump' into ghc-head

- - - - -
af0ff3a4 by M Farkas-Dyck at 2022-09-15T21:16:05+00:00
Disuse `mapLoc`.

- - - - -
a748fc38 by Matthew Farkas-Dyck at 2022-09-17T10:44:18+00:00
Scrub partiality about `NewOrData`.

- - - - -
2758fb6c by John Ericson at 2022-09-18T03:27:37+02:00
Test output changed because of change to `base`

Spooky, but I guess that is intended?

- - - - -
a7eec128 by Torsten Schmits at 2022-09-21T11:06:55+02:00
update tests for the move of tuples to GHC.Tuple.Prim

- - - - -
461e7b9d by Ross Paterson at 2022-09-24T22:01:25+00:00
match implementation of GHC proposal haskell/haddock#106 (Define Kinds Without Promotion)

- - - - -
f7fd77ef by sheaf at 2022-10-17T14:53:01+02:00
Update Haddock for GHC MR !8563 (configuration of diagnostics)

- - - - -
3d3e85ab by Vladislav Zavialov at 2022-10-22T23:04:06+03:00
Class layout info

- - - - -
cbde4cb0 by Simon Peyton Jones at 2022-10-25T23:19:18+01:00
Adapt to Constraint-vs-Type

See haskell/haddock#21623 and !8750

- - - - -
7108ba96 by Tom Smeding at 2022-11-01T22:33:23+01:00
Remove outdated footnote about module re-exports

The footnote is invalid with GHC 9.2.4 (and possibly earlier): the described behaviour in the main text works fine.
- - - - -
206c6bc7 by Hécate Moonlight at 2022-11-01T23:00:46+01:00
Merge pull request haskell/haddock#1534 from tomsmeding/patch-1


- - - - -
a57b4c4b by Andrew Lelechenko at 2022-11-21T00:39:52+00:00
Support mtl-2.3

- - - - -
e9d62453 by Simon Peyton Jones at 2022-11-25T13:49:12+01:00
Track small API change in TyCon.hs

- - - - -
eb1c73f7 by Ben Gamari at 2022-12-07T08:46:21-05:00
Update for GhC 9.6

- - - - -
063268dd by Ben Gamari at 2022-12-07T11:26:32-05:00
Merge remote-tracking branch 'upstream/ghc-head' into HEAD

- - - - -
4ca722fe by Ben Gamari at 2022-12-08T14:43:26-05:00
Bump bounds to accomodate base-4.18

- - - - -
340b7511 by Vladislav Zavialov at 2022-12-10T12:31:28+00:00
HsToken in HsAppKindTy

- - - - -
946226ec by Ben Gamari at 2022-12-13T20:12:56-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
fd8faa66 by Ben Gamari at 2022-12-22T13:44:28-05:00
Bump GHC version to 9.7

- - - - -
2958aa9c by Ben Gamari at 2022-12-22T14:49:16-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
9e0fefd8 by Andrei Borzenkov at 2023-01-30T14:02:04+04:00
Rename () to Unit, Rename (,,...,,) to Tuple<n>

- - - - -
eb3968b5 by Ben Gamari at 2023-03-10T02:32:43-05:00
Bump versions for ghc-9.6 release

- - - - -
4aeead36 by Adam Gundry at 2023-03-23T13:53:47+01:00
Adapt to warning categories changes

- - - - -
642d8d60 by sheaf at 2023-03-29T13:35:56+02:00
Adapt to record field refactor

This commit adapts to the changes in GHC MR !8686, which overhauls
the treatment of record fields in the renamer, adding separate record
field namespaces and entirely removing the GreName datatype.

- - - - -
ac8d4333 by doyougnu at 2023-03-29T11:11:44-04:00
Update UniqMap API

- - - - -
7866fc86 by Ben Orchard at 2023-04-20T11:29:33+02:00
update classify with new tokens

- - - - -
ffcdd683 by Finley McIlwaine at 2023-04-24T09:36:18-06:00
Remove index-state

- - - - -
05b70982 by Finley McIlwaine at 2023-04-26T08:16:31-06:00
`renameInterface` space leak fixes

- Change logic for accumulation of names for which link warnings
  will be generated
- Change handling of `--ignore-link-symbol` to allow qualified and
  unqualified names. Added to CHANGES.md
- Some formatting changes and comments here and there

- - - - -
e5697d7c by Finley McIlwaine at 2023-04-27T18:46:36-06:00
Messy things

- ghc-debug dependency and instrumentation
- cabal.project custom with-compiler
- hie.yaml files
- traces and such

- - - - -
0b8ef80b by Finley McIlwaine at 2023-05-02T18:08:52-06:00
Stop retaining GRE closures

GRE closures should never be necessary to Haddock, so we never want to
keep them on the heap. Despite that, they are retained by a lot of the
data structures that Haddock makes use of.

- Attempt to fix that situation by adding strictness to various
  computations and pruning the `ifaceInstances` field of `Interface` to
  a much thinner data type.

- Removes the `ifaceFamInstances` field, as it was never used.

- Move some of the attach instances types (e.g. `SimpleType`) to the
  types module

- - - - -
8bda991b by Finley McIlwaine at 2023-05-08T16:07:51-06:00
Memory usage fixes

- Refactor `ifaceDeclMap` to drastically reduce memory footprint. We
  no longer store all declarations associated with a given name, since
  we only cared to determine if the only declaration associated with a
  name was a value declaration. Change the `DeclMap` type to better
  reflect this.
- Drop pre-renaming export items after the renaming step. Since the
  Hoogle backend used the pre-renamed export items, this isn't trivial.
  We now generate Hoogle output for exported declarations during the
  renaming step (if Hoogle output /should/ be generated), and store that
  with the renamed export item.
- Slightly refactor Hoogle backend to handle the above change and allow
  for early generation of Hoogle output.
- Remove the `ifaceRnDocMap` and `ifaceRnArgMap` fields of the
  `Interface` type, as they were never used.
- Remove some unnecessary strictness
- Remove a lot of dead code from `Syb` module

- - - - -
1611ac0c by Finley McIlwaine at 2023-05-09T11:51:57-06:00
Unify ErrMsgM and IfM

- Delete ErrMsgM, stop accumulating warnings in a writer
- Make IfM a state monad, print warnings directly to stdout, move IfM
  type into types module
- Drop ErrMsg = String synonym
- Unset IORefs from plugin after they are read, preventing unnecessary
  retention of interfaces

- - - - -
42d696ab by Finley McIlwaine at 2023-05-11T15:52:07-06:00
Thunk leak fixes

The strictness introduced in this commit was motivated by observing
thunk leaks in the eventlog2html output.

- Refactor attach instances list comprehension to avoid large
  intermediate thunks
- Refactor some HTML backend list comprehensions to avoid large
  intermediate thunks
- Avoid thunks accumulating in documentation types or documentation
  parser
- A lot of orphan NFData instances to allow us to force documentation
  values

- - - - -
68561cf6 by Finley McIlwaine at 2023-05-11T17:02:10-06:00
Remove GHC debug dep

- - - - -
10519e3d by Finley McIlwaine at 2023-05-15T12:40:48-06:00
Force HIE file path

Removes a potential retainer of `ModSummary`s

- - - - -
1e4a6ec6 by Finley McIlwaine at 2023-05-15T14:20:34-06:00
Re-add index-state, with-compiler, delete hie.yamls

- - - - -
a2363fe9 by Hécate Moonlight at 2023-05-15T22:45:16+02:00
Merge pull request haskell/haddock#1594 from FinleyMcIlwaine/finley/ghc-9.6-mem-fixes

Reduce memory usage
- - - - -
e8a78383 by Finley McIlwaine at 2023-05-17T12:19:16-06:00
Merge branch ghc-9.6 into ghc-head

- - - - -
22e25581 by Finley McIlwaine at 2023-05-17T12:20:23-06:00
Merge branch 'ghc-head' of gitlab.haskell.org:ghc/haddock into ghc-head

- - - - -
41bbf0df by Bartłomiej Cieślar at 2023-05-24T08:57:58+02:00
changes to the WarningTxt cases

Signed-off-by: Bartłomiej Cieślar <bcieslar2001 at gmail.com>

- - - - -
c686ba9b by Hécate Moonlight at 2023-06-01T14:03:02-06:00
Port the remains of Hi-Haddock

- - - - -
9d8a85fd by Hécate Moonlight at 2023-06-01T14:03:06-06:00
Stdout for tests

- - - - -
36331d07 by Finley McIlwaine at 2023-06-01T14:06:02-06:00
Formatting, organize imports

- - - - -
a06059b1 by Finley McIlwaine at 2023-06-01T14:06:04-06:00
Fix empty context confusion in Convert module

- - - - -
379346ae by Finley McIlwaine at 2023-06-01T14:06:04-06:00
Fix associated type families in Hoogle output

- - - - -
fc6ea7ed by Finley McIlwaine at 2023-06-01T14:06:04-06:00
Fix test refs

Accept several changes in Hoogle tests:

Pretty printing logic no longer prints the `(Proxy (Proxy (...))`
chain in Bug806 with parentheses. Since this test was only meant
to verify that line breaks do not occur, accept the change.

`tyThingToLHsDecl` is called for class and data declarations, which ends
up "synifying" the type variables and giving unlifted types kind
signatures. As a result, type variables of kind `Type -> Type`
are now printed with kind signatures in Hoogle output. This could
be changed by manually drop kind signatures from class variables
in the Hoogle backend if the behavior is deemed unacceptable.

Sometimes subordinate declarations are exported separate from their
parent declarations (e.g. record selectors). In this case, a type
signature is cobbled together for the export item in `extractDecl`.
Since this type signature is very manually constructed, it may lack
kind signatures of decls constructed from `tyThingToLHsDecl`. An
example of this is the `type-sigs` Hoogle test.

Change `*` to `Type` in Hoogle test refs. I don't think this will
break Hoogle behavior, since it appears to not consider type
signatures in search. I have not fully verified this.

- - - - -
e14b7e58 by Finley McIlwaine at 2023-06-01T14:06:05-06:00
Fix LaTeX backend test refs

Changes to GHC pretty printing code have resulted in some
differences to Haddock's LaTeX output.

- Type variables are printed explicitly quantified in the
  LinearTypes test
- Wildcard types in type family equations are now printed numbered,
  e.g. _1 _2, in the TypeFamilies3 test
- Combined signatures in DefaultSignatures test are now documented
  as separate signatures

- - - - -
41b5b296 by Finley McIlwaine at 2023-06-01T14:06:05-06:00
Formatting and test source updates

- Stop using kind `*` in html test sources
- Add TypeOperators where necessary to avoid warnings and future errors
- Rename some test modules to match their module names

- - - - -
c640e2a2 by Finley McIlwaine at 2023-06-01T14:06:05-06:00
Fix missing deprecation warnings on record fields

`lookupOccEnv` was used to resolve `OccNames` with warnings attached, but
it doesn't look in the record field namespace. Thus, if a record field
had a warning attached, it would not resolve and the warning map would
not include it. This commit fixes by using `lookupOccEnv_WithFields`
instead.

- - - - -
fad0c462 by Finley McIlwaine at 2023-06-01T14:06:05-06:00
Formatting and some comments

- - - - -
751fd023 by Finley McIlwaine at 2023-06-01T14:11:41-06:00
Accept HTML test diffs

All diffs now boil down to the expected differences resulting from
declarations being reified from TyThings in hi-haddock. Surface
syntax now has much less control over the syntax used in the
documentation.

- - - - -
d835c845 by Finley McIlwaine at 2023-06-01T14:11:45-06:00
Adapt to new load' type

- - - - -
dcf776c4 by Finley McIlwaine at 2023-06-01T14:13:13-06:00
Update mkWarningMap and moduleWarning

- - - - -
8e8432fd by Finley McIlwaine at 2023-06-01T14:28:54-06:00
Revert load' changes

- - - - -
aeb2982c by Finley McIlwaine at 2023-06-01T14:40:24-06:00
Accept change to Instances test in html-test

Link to Data.Tuple instead of GHC.Tuple.Prim

- - - - -
8adfdbac by Finley McIlwaine at 2023-06-01T15:53:17-06:00
Reset ghc dep to ^>= 9.6

- - - - -
2b1ce93d by Finley McIlwaine at 2023-06-06T07:50:04-06:00
Update CHANGES.md, user guide, recomp avoidance

* Add --trace-args flag for tracing arguments received to standard output
* Avoid recompiling due to changes in optimization flags
* Update users guide and changes.md

- - - - -
f3da6676 by Finley McIlwaine at 2023-06-06T14:12:56-06:00
Add "Avoiding Recompilation" section to docs

This section is a bit of a WIP due to the unstable nature of hi-haddock
and the lack of tooling supporting it, but its a good start.

- - - - -
bf36c467 by Matthew Pickering at 2023-06-07T10:16:09+01:00
Revert back to e16e20d592a6f5d9ed1af17b77fafd6495242345

Neither of these MRs are ready to land yet which causes issues with
other MRs which are ready to land and need haddock changes.

- - - - -
421510a9 by Vladislav Zavialov at 2023-06-07T09:36:30+00:00
atSign has no unicode variant

Prior to this change, atSign was defined as follows:

	atSign unicode = text (if unicode then "@" else "@")

Yes, this is the same symbol '\64' and not your font playing
tricks on you. Now we define:

	atSign = char '@'

Both the LaTeX and the Xhtml backend are updated accordingly.

- - - - -
3785c276 by Vladislav Zavialov at 2023-06-07T09:36:30+00:00
LaTeX: fix printing of type variable bindings

Consider this type signature:

	kindOf :: forall {k} (a :: k). Proxy a -> Proxy k

Prior to this fix, the LaTeX backend rendered it like this:

	kindOf :: forall k a. Proxy a -> Proxy k

Now we preserve explicit specificity and kind annotations.

- - - - -
0febf3a8 by Vladislav Zavialov at 2023-06-07T09:36:30+00:00
Add support for invisible binders in type declarations

- - - - -
13e33bb3 by Finley McIlwaine at 2023-06-08T07:51:59-06:00
Add "Avoiding Recompilation" section to docs

This section is a bit of a WIP due to the unstable nature of hi-haddock
and the lack of tooling supporting it, but its a good start.

- - - - -
3e5340ce by Finley McIlwaine at 2023-06-08T07:54:27-06:00
Add note about stubdir to recompilation docs

- - - - -
db7e84dc by Finley at 2023-06-08T08:11:03-06:00
Merge pull request haskell/haddock#1597 from haskell/finley/hi-haddock-9.6

hi-haddock for ghc 9.6
- - - - -
4e085d17 by Finley McIlwaine at 2023-06-14T13:41:06-06:00
Replace SYB traversals

- - - - -
7b39aec5 by Finley McIlwaine at 2023-06-14T14:20:17-06:00
Test ref accepts, remove unused HaddockClsInst

- - - - -
df9c2090 by Finley McIlwaine at 2023-06-15T08:02:51-06:00
Use batchMsg for progress reporting during load

With hi-haddock as is, there is an awkward silence during the load operation.
This commit makes haddock use the default `batchMsg` Messager for progress
reporting, and makes the default GHC verbosity level 1, so the user can see
what GHC is doing.

- - - - -
f23679a8 by Hécate Moonlight at 2023-06-15T20:31:53+02:00
Merge pull request haskell/haddock#1600 from haskell/finley/hi-haddock-optim


- - - - -
a7982192 by Finley McIlwaine at 2023-06-15T15:02:16-06:00
hi-haddock squashed

- - - - -
c34f0c8d by Finley McIlwaine at 2023-06-15T16:22:03-06:00
Merge remote-tracking branch 'origin/ghc-9.6' into finley/hi-haddock-squashed

- - - - -
40452797 by Bartłomiej Cieślar at 2023-06-16T12:26:04+02:00
Changes related to MR !10283

MR !10283 changes the alternatives for WarningTxt pass. This MR reflects those changes in the haddock codebase.

Signed-off-by: Bartłomiej Cieślar <bcieslar2001 at gmail.com>

- - - - -
e58673bf by Ben Gamari at 2023-06-16T09:33:35-04:00
Bump GHC version to 9.8

- - - - -
74bdf972 by Ben Gamari at 2023-06-16T09:36:18-04:00
Merge commit 'fcaaad06770a26d35d4aafd65772dedadf17669c' into ghc-head

- - - - -
418ee3dc by Finley McIlwaine at 2023-06-20T15:39:05-04:00
Remove NFData SourceText, IfaceWarnings updates

The NFData SourceText instance is now available in GHC

Handle mod_iface mi_warns now being IfaceWarnings

- - - - -
62f31380 by Finley McIlwaine at 2023-06-20T15:39:05-04:00
Accept Instances.hs test output

Due to ghc!10469.

- - - - -
a8f2fc0e by Ben Gamari at 2023-06-20T15:48:08-04:00
Test fixes for "Fix associated data family doc structure items"

Associated data families were being given their own export DocStructureItems,
which resulted in them being documented separately from their classes in
haddocks. This commit fixes it.

- - - - -
cb1ac33e by Bartłomiej Cieślar at 2023-06-21T12:56:02-04:00
Changes related to MR !10283

MR !10283 changes the alternatives for WarningTxt pass. This MR reflects those changes in the haddock codebase.

Signed-off-by: Bartłomiej Cieślar <bcieslar2001 at gmail.com>

- - - - -
9933e10b by Ben Gamari at 2023-06-21T12:56:02-04:00
Bump GHC version to 9.8

- - - - -
fe8c18b6 by Ben Gamari at 2023-06-21T15:36:29-04:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
c61a0d5b by Ben Gamari at 2023-06-21T16:10:51-04:00
Bump GHC version to 9.9

- - - - -
0c2a756e by sheaf at 2023-07-07T13:45:12+02:00
Avoid incomplete record update in Haddock Hoogle

This commit avoids running into an incomplete record update warning
in the Hoogle backend of Haddock.

This was only noticed now, because incomplete record updates were broken
in GHC 9.6. Now that they are fixed, we have to avoid running into them!

- - - - -
f9b952a7 by Ben Gamari at 2023-07-21T11:58:05-04:00
Bump base bound to <4.20

For GHC 9.8.

- - - - -
1b27e151 by Vladislav Zavialov at 2023-08-02T10:42:11+00:00
Check for puns (see ghc#23368)

- - - - -
457341fd by Vladislav Zavialov at 2023-08-02T10:42:11+00:00
Remove fake exports for (~), List, and Tuple<n>

The old reasoning no longer applies, nowadays those names can be
mentioned in export lists.

- - - - -
bf3dcddf by Vladislav Zavialov at 2023-08-02T10:42:11+00:00
Fix pretty-printing of Solo and MkSolo

- - - - -
495b2241 by Matthew Pickering at 2023-09-01T13:02:07+02:00
Fix issue with duplicate reexported definitions (T23616)

When a class method was reexported, it's default methods were also
showing up in the generated html page.

The simplest and most non-invasive fix is to not look for the default
method if we are just exporting the class method.. because the backends
are just showing default methods when the whole class is exported.

In general it would be worthwhile to rewrite this bit of code I think as
the logic and what gets included is split over `lookupDocs` and
`availExportDecl` it would be clearer to combine the two. The result of
lookupDocs is always just passed to availExportDecl so it seems simpler
and more obvious to just write the function directly.

- - - - -
6551824d by Finley McIlwaine at 2023-09-05T13:06:57-07:00
Remove fake export of `FUN` from Prelude

This prevents `data FUN` from being shown at the top of the Prelude docs. Fixes
\#23920 on GHC.

- - - - -
9ab5a448 by Alan Zimmerman at 2023-09-08T18:26:53+01:00
Match changes in wip/az/T23885-unicode-funtycon

- - - - -
4d08364e by Alan Zimmerman at 2023-10-31T19:46:45+00:00
EPA: match changes in GHC

- EPA: Comments in AnchorOperation
- EPA: Remove EpaEofComment

- - - - -
e7da0d25 by Alan Zimmerman at 2023-11-05T11:20:31+00:00
EPA: match changes in GHC, l2l cleanup

- - - - -
4ceac14d by Alan Zimmerman at 2023-11-11T15:16:41+00:00
EPA: Replace Anchor with EpaLocation

Match GHC

- - - - -
94fb8d47 by Alan Zimmerman at 2023-11-29T18:10:26+00:00
Match GHC, No comments in EpaDelta for comments

- - - - -
32d208e1 by Vladislav Zavialov at 2023-12-12T20:41:36+03:00
EPA: Match changes to LHsToken removal

- - - - -
eebdd316 by Apoorv Ingle at 2024-01-23T13:49:12+00:00
Changes for haskell/haddock#18324

- - - - -
ae856a82 by Matthew Pickering at 2024-02-05T12:22:39+00:00
ghc-internals fallout

- - - - -
f8429266 by Jade at 2024-02-08T14:56:50+01:00
Adjust test for ghc MR !10993

- - - - -
6d1e2386 by Alan Zimmerman at 2024-02-13T22:00:28+03:00
EPA: Match changes to HsParTy and HsFunTy

- - - - -
9c588f19 by Fendor at 2024-02-14T11:05:36+01:00
Adapt to GHC giving better Name's for linking

- - - - -
778e1db3 by Andrei Borzenkov at 2024-02-16T16:12:07+03:00
Namespace specifiers for fixity signatures

- - - - -
826c5b47 by Torsten Schmits at 2024-02-21T13:17:05+01:00
rename GHC.Tuple.Prim to GHC.Tuple

- - - - -
2cff14d5 by Ben Gamari at 2024-02-22T09:35:56-05:00
Bump bounds

- - - - -
f49376b3 by Ben Gamari at 2024-02-22T09:35:56-05:00
Allow `@since` annotations in export lists

Here we extend Haddock to admit `@since` annotations in export lists.
These can be attached to most export list items (although not
subordinate lists). These annotations supercede the declaration's
`@since` annotation in produced Haddocks.

- - - - -
b5aa93df by Ben Gamari at 2024-02-22T12:09:06-05:00
Allow package-qualified @since declarations

- - - - -
8f5957f2 by Ben Gamari at 2024-02-22T13:55:19-05:00
Documentation changes from ghc-internal restructuring

Previously many declarations (e.g. `Int`) were declared to have a "home"
in `Prelude`. However, now Haddock instead chooses to put these in
more specific homes (e.g. `Data.Int`). Given that the "home" decision is
driven by heuristics and in general these changes seem
quite reasonable I am accepting them:

 * `Int` moved from `Prelude` to `Data.Int`
 * `(~)` moved from `Prelude` to `Data.Type.Equality`
 * `Type` moved from `GHC.Types` to `Data.Kind`
 * `Maybe` moved from `Prelude` to `Data.Maybe`
 * `Bool` moved from `Prelude` to `Data.Bool`
 * `Ordering` moved from `Prelude` to `Data.Ord`

As well, more identifiers are now hyperlinked; it's not immediately
clear *why*, but it is an improvement nevertheless.

- - - - -
ec33fec3 by Ben Gamari at 2024-02-22T20:36:24-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
30cfd251 by Torsten Schmits at 2024-02-24T13:00:42-05:00
rename GHC.Tuple.Prim to GHC.Tuple

- - - - -
732db81d by Ben Gamari at 2024-02-24T19:12:18-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
86bf7010 by Ben Gamari at 2024-02-27T19:28:10-05:00
Merge remote-tracking branch 'origin/ghc-head' into HEAD

- - - - -
4b6e76b5 by Patrick at 2024-03-07T22:09:30+08:00
fix haskell/haddock#24493, with module name introduced in hieAst

The accompanies haddoc PR with GHC PR https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12153
Two things have been done:
1. Link is introduced to every `X` in `module X where`, since we introduce the module name to HieAst,
2. `{-# LINE 4 "hypsrc-test/src/PositionPragmas.hs" #-}` is added before the `module PositionPragmas where` in ` hypsrc-test/ref/src/PositionPragmas.html `.It ensures only a single hieAst for file `hypsrc-test/src/PositionPragmas.hs` is generated.

- - - - -
635abccc by Ben Gamari at 2024-03-08T17:09:06-05:00
Bump ghc version to 9.10

- - - - -
5b934048 by Ben Gamari at 2024-03-08T18:50:12-05:00
Bump base upper bound

- - - - -
b30d134e by Ben Gamari at 2024-03-08T18:50:44-05:00
Testsuite output update

- - - - -
9bdf3586 by Ben Gamari at 2024-03-09T21:37:44-05:00
Merge branch 'ghc-9.10' into ghc-head

- - - - -
cec76981 by Ben Gamari at 2024-03-09T21:54:00-05:00
Bump GHC version to 9.11

- - - - -
4c59feb7 by Ben Gamari at 2024-03-09T22:15:01-05:00
Merge remote-tracking branch 'origin/ghc-head' into ghc-head

- - - - -
bee54c24 by Krzysztof Gogolewski at 2024-04-19T11:13:00+02:00
Update quantification order following GHC haskell/haddock#23764

- - - - -
2814eb89 by Ben Gamari at 2024-04-19T18:57:05+02:00
hypsrc-test: Fix output of PositionPragmas.html

- - - - -
a27c6a49 by Fendor at 2024-04-22T10:13:03+02:00
Adapt to UserData split

- - - - -
1efc5a7a by Fendor at 2024-04-22T10:13:03+02:00
Adapt to BinHandle split

- - - - -
c62239b7 by Sylvain Henry at 2024-04-29T10:35:00+02:00
Fix tests for T22229

- - - - -
adba68e7 by John Ericson at 2024-05-05T19:35:56-04:00
Substitute bindist files with Hadrian not configure

The `ghc-toolchain` overhaul will eventually replace all this stuff with
something much more cleaned up, but I think it is still worth making
this sort of cleanup in the meantime so other untanglings and dead code
cleaning can procede.

I was able to delete a fair amount of dead code doing this too.

`LLVMTarget_CPP` is renamed to / merged with `LLVMTarget` because it
wasn't actually turned into a valid CPP identifier. (Original to
1345c7cc42c45e63ab1726a8fd24a7e4d4222467, actually.)

Progress on #23966

Co-Authored-By: Sylvain Henry <hsyl20 at gmail.com>

- - - - -
18f4ff84 by Alan Zimmerman at 2024-05-05T19:36:32-04:00
EPA: fix mkHsOpTyPV duplicating comments

Closes #24753

- - - - -
a19201d4 by Matthew Craven at 2024-05-06T19:54:29-04:00
Add test cases for #24664

...since none are present in the original MR !12463 fixing this issue.

- - - - -
46328a49 by Alan Zimmerman at 2024-05-06T19:55:05-04:00
EPA: preserve comments in data decls

Closes #24771

- - - - -
3b51995c by Andrei Borzenkov at 2024-05-07T14:39:40-04:00
Rename Solo# data constructor to MkSolo# (#24673)

- data Solo# a = (# a #)
+ data Solo# a = MkSolo# a

And `(# foo #)` syntax now becomes just a syntactic
sugar for `MkSolo# a`.

- - - - -
4d59abf2 by Arsen Arsenović at 2024-05-07T14:40:24-04:00
Add the cmm_cpp_is_gcc predicate to the testsuite

A future C-- test called T24474-cmm-override-g0 relies on the
GCC-specific behaviour of -g3 implying -dD, which, in turn, leads to it
emitting #defines past the preprocessing stage.  Clang, at least, does
not do this, so the test would fail if ran on Clang.

As the behaviour here being tested is ``-optCmmP-g3'' undoing effects of
the workaround we apply as a fix for bug #24474, and the workaround was
for GCC-specific behaviour, the test needs to be marked as fragile on
other compilers.

- - - - -
25b0b404 by Arsen Arsenović at 2024-05-07T14:40:24-04:00
Split out the C-- preprocessor, and make it pass -g0

Previously, C-- was processed with the C preprocessor program.  This
means that it inherited flags passed via -optc.  A flag that is somewhat
often passed through -optc is -g.  At certain -g levels (>=2), GCC
starts emitting defines *after* preprocessing, for the purposes of
debug info generation.  This is not useful for the C-- compiler, and, in
fact, causes lexer errors.  We can suppress this effect (safely, if
supported) via -g0.

As a workaround, in older versions of GCC (<=10), GCC only emitted
defines if a certain set of -g*3 flags was passed.  Newer versions check
the debug level.  For the former, we filter out those -g*3 flags and,
for the latter, we specify -g0 on top of that.

As a compatible and effective solution, this change adds a C--
preprocessor distinct from the C compiler and preprocessor, but that
keeps its flags.  The command line produced for C-- preprocessing now
looks like:

  $pgmCmmP $optCs_without_g3 $g0_if_supported $optCmmP

Closes: https://gitlab.haskell.org/ghc/ghc/-/issues/24474

- - - - -
9b4129a5 by Andreas Klebinger at 2024-05-08T13:24:20-04:00
-fprof-late: Only insert cost centres on functions/non-workfree cafs.

They are usually useless and doing so for data values comes with
a large compile time/code size overhead.

Fixes #24103

- - - - -
259b63d3 by Sebastian Graf at 2024-05-08T13:24:57-04:00
Simplifier: Preserve OccInfo on DataAlt fields when case binder is dead (#24770)

See the adjusted `Note [DataAlt occ info]`.
This change also has a positive repercussion on
`Note [Combine case alts: awkward corner]`.

Fixes #24770.

We now try not to call `dataConRepStrictness` in `adjustFieldsIdInfo` when all
fields are lazy anyway, leading to a 2% ghc/alloc decrease in T9675.

Metric Decrease:
    T9675

- - - - -
31b28cdb by Sebastian Graf at 2024-05-08T13:24:57-04:00
Kill seqRule, discard dead seq# in Prep (#24334)

Discarding seq#s in Core land via `seqRule` was problematic; see #24334.
So instead we discard certain dead, discardable seq#s in Prep now.
See the updated `Note [seq# magic]`.

This fixes the symptoms of #24334.

- - - - -
b2682534 by Rodrigo Mesquita at 2024-05-10T01:47:51-04:00
Document NcgImpl methods

Fixes #19914

- - - - -
4d3acbcf by Zejun Wu at 2024-05-10T01:48:28-04:00
Make renamer to be more flexible with parens in the LHS of the rules

We used to reject LHS like `(f a) b` in RULES and requires it to be written as
`f a b`. It will be handy to allow both as the expression may be more
readable with extra parens in some cases when infix operator is involved.
Espceially when TemplateHaskell is used, extra parens may be added out of
user's control and result in "valid" rules being rejected and there
are not always ways to workaround it.

Fixes #24621

- - - - -
ab840ce6 by Ben Gamari at 2024-05-10T01:49:04-04:00
IPE: Eliminate dependency on Read

Instead of encoding the closure type as decimal string we now simply
represent it as an integer, eliminating the need for `Read` in
`GHC.Internal.InfoProv.Types.peekInfoProv`.

Closes #24504.

-------------------------
Metric Decrease:
    T24602_perf_size
    size_hello_artifact
-------------------------

- - - - -
a9979f55 by Cheng Shao at 2024-05-10T01:49:43-04:00
testsuite: fix testwsdeque with recent clang

This patch fixes compilation of testwsdeque.c with recent versions of
clang, which will fail with the error below:

```
testwsdeque.c:95:33: error:
     warning: format specifies type 'long' but the argument has type 'void *' [-Wformat]
       95 |         barf("FAIL: %ld %d %d", p, n, val);
          |                     ~~~         ^

testwsdeque.c:95:39: error:
     warning: format specifies type 'int' but the argument has type 'StgWord' (aka 'unsigned long') [-Wformat]
       95 |         barf("FAIL: %ld %d %d", p, n, val);
          |                            ~~         ^~~
          |                            %lu

testwsdeque.c:133:42: error:
     error: incompatible function pointer types passing 'void (void *)' to parameter of type 'OSThreadProc *' (aka 'void *(*)(void *)') [-Wincompatible-function-pointer-types]
      133 |         createOSThread(&ids[n], "thief", thief, (void*)(StgWord)n);
          |                                          ^~~~~

/workspace/ghc/_build/stage1/lib/../lib/x86_64-linux-ghc-9.11.20240502/rts-1.0.2/include/rts/OSThreads.h:193:51: error:
     note: passing argument to parameter 'startProc' here
      193 |                                     OSThreadProc *startProc, void *param);
          |                                                   ^

2 warnings and 1 error generated.
```

- - - - -
c2b33fc9 by Rodrigo Mesquita at 2024-05-10T01:50:20-04:00
Rename pre-processor invocation args

Small clean up. Uses proper names for the various groups of arguments
that make up the pre-processor invocation.

- - - - -
2b1af08b by Cheng Shao at 2024-05-10T01:50:55-04:00
ghc-heap: fix typo in ghc-heap cbits

- - - - -
fc2d6de1 by Jade at 2024-05-10T21:07:16-04:00
Improve performance of Data.List.sort(By)

This patch improves the algorithm to sort lists in base.
It does so using two strategies:

1) Use a four-way-merge instead of the 'default' two-way-merge.
This is able to save comparisons and allocations.

2) Use `(>) a b` over `compare a b == GT` and allow inlining and specialization.
This mainly benefits types with a fast (>).

Note that this *may* break instances with a *malformed* Ord instance
where `a > b` is *not* equal to `compare a b == GT`.

CLC proposal: https://github.com/haskell/core-libraries-committee/issues/236

Fixes #24280

-------------------------
Metric Decrease:
    MultiLayerModulesTH_Make
    T10421
    T13719
    T15164
    T18698a
    T18698b
    T1969
    T9872a
    T9961
    T18730
    WWRec
    T12425
    T15703
-------------------------

- - - - -
1012e8aa by Matthew Pickering at 2024-05-10T21:07:52-04:00
Revert "ghcup-metadata: Drop output_name field"

This reverts commit ecbf22a6ac397a791204590f94c0afa82e29e79f.

This breaks the ghcup metadata generation on the nightly jobs.

- - - - -
daff1e30 by Jannis at 2024-05-12T13:38:35-04:00
Division by constants optimization

- - - - -
413217ba by Andreas Klebinger at 2024-05-12T13:39:11-04:00
Tidy: Add flag to expose unfoldings if they take dictionary arguments.

Add the flag `-fexpose-overloaded-unfoldings` to be able to control this
behaviour.

For ghc's boot libraries file size grew by less than 1% when it was
enabled. However I refrained from enabling it by default for now.

I've also added a section on specialization more broadly to the users
guide.

-------------------------
Metric Decrease:
    MultiLayerModulesTH_OneShot
Metric Increase:
    T12425
    T13386
    hard_hole_fits
-------------------------

- - - - -
c5d89412 by Zubin Duggal at 2024-05-13T22:19:53-04:00
Don't store a GlobalRdrEnv in `mi_globals` for GHCi.

GHCi only needs the `mi_globals` field for modules imported with
:module +*SomeModule.

It uses this field to make the top level environment in `SomeModule` available
to the repl.

By default, only the first target in the command line parameters is
"star" loaded into GHCi. Other modules have to be manually "star" loaded
into the repl.

Storing the top level GlobalRdrEnv for each module is very wasteful, especially
given that we will most likely never need most of these environments.

Instead we store only the information needed to reconstruct the top level environment
in a module, which is the `IfaceTopEnv` data structure, consisting of all import statements
as well as all top level symbols defined in the module (not taking export lists into account)

When a particular module is "star-loaded" into GHCi (as the first commandline target, or via
an explicit `:module +*SomeModule`, we reconstruct the top level environment on demand using
the `IfaceTopEnv`.

- - - - -
d65bf4a2 by Fendor at 2024-05-13T22:20:30-04:00
Add perf regression test for `-fwrite-if-simplified-core`

- - - - -
2c0f8ddb by Andrei Borzenkov at 2024-05-13T22:21:07-04:00
Improve pattern to type pattern transformation (23739)

`pat_to_type_pat` function now can handle more patterns:
  - TuplePat
  - ListPat
  - LitPat
  - NPat
  - ConPat

Allowing these new constructors in type patterns significantly
increases possible shapes of type patterns without `type` keyword.

This patch also changes how lookups in `lookupOccRnConstr` are
performed, because we need to fall back into
types when we didn't find a constructor on data level to perform
`ConPat` to type transformation properly.

- - - - -
be514bb4 by Cheng Shao at 2024-05-13T22:21:43-04:00
hadrian: fix hadrian building with ghc-9.10.1

- - - - -
ad38e954 by Cheng Shao at 2024-05-13T22:21:43-04:00
linters: fix lint-whitespace compilation with ghc-9.10.1

- - - - -
a593f284 by Andreas Klebinger at 2024-05-15T07:32:10-04:00
Expand the `inline` rule to look through casts/ticks.

Fixes #24808

- - - - -
b1e0c313 by Cheng Shao at 2024-05-15T07:32:46-04:00
testsuite: bump PartialDownSweep timeout to 5x on wasm32

- - - - -
b2227487 by Fendor at 2024-05-15T17:14:06-04:00
Add Eq and Ord instance to `IfaceType`

We add an `Ord` instance so that we can store `IfaceType` in a
`Data.Map` container.
This is required to deduplicate `IfaceType` while writing `.hi` files to
disk. Deduplication has many beneficial consequences to both file size
and memory usage, as the deduplication enables implicit sharing of
values.
See issue #24540 for more motivation.

The `Ord` instance would be unnecessary if we used a `TrieMap` instead
of `Data.Map` for the deduplication process. While in theory this is
clerarly the better option, experiments on the agda code base showed
that a `TrieMap` implementation has worse run-time performance
characteristics.

To the change itself, we mostly derive `Eq` and `Ord`. This requires us
to change occurrences of `FastString` with `LexicalFastString`, since
`FastString` has no `Ord` instance.
We change the definition of `IfLclName` to a newtype of
`LexicalFastString`, to make such changes in the future easier.

Bump haddock submodule for IfLclName changes

- - - - -
d368f9a6 by Fendor at 2024-05-15T17:14:06-04:00
Move out LiteralMap to avoid cyclic module dependencies

- - - - -
2fcc09fd by Fendor at 2024-05-15T17:14:06-04:00
Add deduplication table for `IfaceType`

The type `IfaceType` is a highly redundant, tree-like data structure.
While benchmarking, we realised that the high redundancy of `IfaceType`
causes high memory consumption in GHCi sessions when byte code is
embedded into the `.hi` file via `-fwrite-if-simplified-core` or
`-fbyte-code-and-object-code`.
Loading such `.hi` files from disk introduces many duplicates of
memory expensive values in `IfaceType`, such as `IfaceTyCon`,
`IfaceTyConApp`, `IA_Arg` and many more.

We improve the memory behaviour of GHCi by adding an additional
deduplication table for `IfaceType` to the serialisation of `ModIface`,
similar to how we deduplicate `Name`s and `FastString`s.
When reading the interface file back, the table allows us to automatically
share identical values of `IfaceType`.

To provide some numbers, we evaluated this patch on the agda code base.
We loaded the full library from the `.hi` files, which contained the
embedded core expressions (`-fwrite-if-simplified-core`).

Before this patch:

* Load time: 11.7 s, 2.5 GB maximum residency.

After this patch:

* Load time:  7.3 s, 1.7 GB maximum residency.

This deduplication has the beneficial side effect to additionally reduce
the size of the on-disk interface files tremendously.

For example, on agda, we reduce the size of `.hi` files (with
`-fwrite-if-simplified-core`):

* Before: 101 MB on disk
* Now:     24 MB on disk

This has even a beneficial side effect on the cabal store. We reduce the
size of the store on disk:

* Before: 341 MB on disk
* Now:    310 MB on disk

Note, none of the dependencies have been compiled with
`-fwrite-if-simplified-core`, but `IfaceType` occurs in multiple
locations in a `ModIface`.

We also add IfaceType deduplication table to .hie serialisation and
refactor .hie file serialisation to use the same infrastrucutre as
`putWithTables`.

Bump haddock submodule to accomodate for changes to the deduplication
table layout and binary interface.

- - - - -
36aa7cf1 by Fendor at 2024-05-15T17:14:06-04:00
Add run-time configurability of `.hi` file compression

Introduce the flag `-fwrite-if-compression=<n>` which allows to
configure the compression level of writing .hi files.

The motivation is that some deduplication operations are too expensive
for the average use case. Hence, we introduce multiple compression
levels with variable impact on performance, but still reduce the
memory residency and `.hi` file size on disk considerably.

We introduce three compression levels:

* `1`: `Normal` mode. This is the least amount of compression.
    It deduplicates only `Name` and `FastString`s, and is naturally the
    fastest compression mode.
* `2`: `Safe` mode. It has a noticeable impact on .hi file size and is
  marginally slower than `Normal` mode. In general, it should be safe to
  always use `Safe` mode.
* `3`: `Full` deduplication mode. Deduplicate as much as we can,
  resulting in minimal .hi files, but at the cost of additional
  compilation time.

Reading .hi files doesn't need to know the initial compression level,
and can always deserialise a `ModIface`, as we write out a byte that
indicates the next value has been deduplicated.
This allows users to experiment with different compression levels for
packages, without recompilation of dependencies.

Note, the deduplication also has an additional side effect of reduced
memory consumption to implicit sharing of deduplicated elements.
See https://gitlab.haskell.org/ghc/ghc/-/issues/24540 for example where
that matters.

-------------------------
Metric Decrease:
    MultiLayerModulesDefsGhciWithCore
    T16875
    T21839c
    T24471
    hard_hole_fits
    libdir
-------------------------

- - - - -
1e63a6fb by Matthew Pickering at 2024-05-15T17:14:07-04:00
Introduce regression tests for `.hi` file sizes

Add regression tests to track how `-fwrite-if-compression` levels affect
the size of `.hi` files.

- - - - -
639d742b by M Farkas-Dyck at 2024-05-15T17:14:49-04:00
TTG: ApplicativeStatement exist only in Rn and Tc

Co-Authored-By: romes <rodrigo.m.mesquita at gmail.com>

- - - - -
aa7b336b by Jade at 2024-05-15T23:06:17-04:00
Documentation: Improve documentation for symbols exported from System.IO

- - - - -
c561de8f by Jade at 2024-05-15T23:06:54-04:00
Improve suggestions for language extensions

- When suggesting Language extensions, also suggest Extensions which imply them
- Suggest ExplicitForAll and GADTSyntax instead of more specific
  extensions
- Rephrase suggestion to include the term 'Extension'
- Also moves some flag specific definitions out of Session.hs into
Flags.hs (#24478)

Fixes: #24477
Fixes: #24448
Fixes: #10893

- - - - -
4c7ae2a1 by Andreas Klebinger at 2024-05-15T23:07:30-04:00
Testsuite: Check if llvm assembler is available for have_llvm

- - - - -
bc672166 by Torsten Schmits at 2024-05-15T23:08:06-04:00
refactor quadratic search in warnMissingHomeModules

- - - - -
7875e8cb by Torsten Schmits at 2024-05-15T23:08:06-04:00
add test that runs MakeDepend on thousands of modules

- - - - -
b84b91f5 by Adam Gundry at 2024-05-16T15:32:06-04:00
Representation-polymorphic HasField (fixes #22156)

This generalises the HasField class to support representation polymorphism,
so that instead of

    type HasField :: forall {k} . k -> Type -> Type -> Constraint

we have

    type HasField :: forall {k} {r_rep} {a_rep} . k -> TYPE r_rep -> TYPE a_rep -> Constraint

- - - - -
05285090 by Matthew Pickering at 2024-05-16T15:32:43-04:00
Bump os-string submodule to 2.0.2.2

Closes #24786

- - - - -
886ab43a by Cheng Shao at 2024-05-17T01:34:50-04:00
rts: do not prefetch mark_closure bdescr in non-moving gc when ASSERTS_ENABLED

This commit fixes a small an oversight in !12148: the prefetch logic
in non-moving GC may trap in debug RTS because it calls Bdescr() for
mark_closure which may be a static one. It's fine in non-debug RTS
because even invalid bdescr addresses are prefetched, they will not
cause segfaults, so this commit implements the most straightforward
fix: don't prefetch mark_closure bdescr when assertions are enabled.

- - - - -
b38dcf39 by Teo Camarasu at 2024-05-17T01:34:50-04:00
rts: Allocate non-moving segments with megablocks

Non-moving segments are 8 blocks long and need to be aligned.
Previously we serviced allocations by grabbing 15 blocks, finding
an aligned 8 block group in it and returning the rest.
This proved to lead to high levels of fragmentation as a de-allocating a segment
caused an 8 block gap to form, and this could not be reused for allocation.

This patch introduces a segment allocator based around using entire
megablocks to service segment allocations in bulk.

When there are no free segments, we grab an entire megablock and fill it
with aligned segments. As the megablock is free, we can easily guarantee
alignment. Any unused segments are placed on a free list.

It only makes sense to free segments in bulk when all of the segments in
a megablock are freeable. After sweeping, we grab the free list, sort it,
and find all groups of segments where they cover the megablock and free
them.
This introduces a period of time when free segments are not available to
the mutator, but the risk that this would lead to excessive allocation
is low. Right after sweep, we should have an abundance of partially full
segments, and this pruning step is relatively quick.

In implementing this we drop the logic that kept NONMOVING_MAX_FREE
segments on the free list.

We also introduce an eventlog event to log the amount of pruned/retained
free segments.

See Note [Segment allocation strategy]

Resolves #24150

-------------------------
Metric Decrease:
    T13253
    T19695
-------------------------

- - - - -
710665bd by Cheng Shao at 2024-05-17T01:35:30-04:00
rts: fix I/O manager compilation errors for win32 target

This patch fixes I/O manager compilation errors for win32 target
discovered when cross-compiling to win32 using recent clang:

```
rts/win32/ThrIOManager.c:117:7: error:
     error: call to undeclared function 'is_io_mng_native_p'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
      117 |   if (is_io_mng_native_p ()) {
          |       ^
    |
117 |   if (is_io_mng_native_p ()) {
    |       ^

1 error generated.
`x86_64-w64-mingw32-clang' failed in phase `C Compiler'. (Exit code: 1)

rts/fs.c:143:28: error:
     error: a function declaration without a prototype is deprecated in all versions of C [-Werror,-Wstrict-prototypes]
      143 | int setErrNoFromWin32Error () {
          |                            ^
          |                             void
    |
143 | int setErrNoFromWin32Error () {
    |                            ^

1 error generated.
`x86_64-w64-mingw32-clang' failed in phase `C Compiler'. (Exit code: 1)

rts/win32/ConsoleHandler.c:227:9: error:
     error: call to undeclared function 'interruptIOManagerEvent'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
      227 |         interruptIOManagerEvent ();
          |         ^
    |
227 |         interruptIOManagerEvent ();
    |         ^

rts/win32/ConsoleHandler.c:227:9: error:
     note: did you mean 'getIOManagerEvent'?
    |
227 |         interruptIOManagerEvent ();
    |         ^

rts/include/rts/IOInterface.h:27:10: error:
     note: 'getIOManagerEvent' declared here
       27 | void *   getIOManagerEvent  (void);
          |          ^
   |
27 | void *   getIOManagerEvent  (void);
   |          ^

1 error generated.
`x86_64-w64-mingw32-clang' failed in phase `C Compiler'. (Exit code: 1)

rts/win32/ConsoleHandler.c:196:9: error:
     error: call to undeclared function 'setThreadLabel'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
      196 |         setThreadLabel(cap, t, "signal handler thread");
          |         ^
    |
196 |         setThreadLabel(cap, t, "signal handler thread");
    |         ^

rts/win32/ConsoleHandler.c:196:9: error:
     note: did you mean 'postThreadLabel'?
    |
196 |         setThreadLabel(cap, t, "signal handler thread");
    |         ^

rts/eventlog/EventLog.h:118:6: error:
     note: 'postThreadLabel' declared here
      118 | void postThreadLabel(Capability    *cap,
          |      ^
    |
118 | void postThreadLabel(Capability    *cap,
    |      ^

1 error generated.
`x86_64-w64-mingw32-clang' failed in phase `C Compiler'. (Exit code: 1)
```

- - - - -
28b9cee0 by Rodrigo Mesquita at 2024-05-17T01:36:05-04:00
configure: Check C99-compat for Cmm preprocessor

Fixes #24815

- - - - -
8927e0c3 by Andreas Klebinger at 2024-05-17T01:36:41-04:00
Ensure `tcHasFixedRuntimeRep (# #)` returns True.

- - - - -
04179044 by doyougnu at 2024-05-17T09:00:32-04:00
testsuite: make find_so regex less general

Closes #24759

Background. In MR !12372 we began tracking shared object files and
directories sizes for dependencies. However, this broke  release builds
because release builds alter the filenames swapping "in-place" for a
hash. This was not considered in the MR and thus broke release
pipelines. Furthermore, the rts_so test was found to be wildly varying
and was therefore disabled in !12561.

This commit fixes both of these issues:

- fix the rts_so test by making the regex less general, now the rts_so
test and all other foo.so tests must match
"libHS<some-lib>-<version>-<hash|'in-place>-<ghc>". This prevents the
rts_so test from accidentally matching different rts variants such as
rts_threaded, which was the cause of the wild swings after !12372.

- add logic to match either a hash or the string in-place. This should
make the find_so function build agnostic.

- - - - -
0962b50d by Andreas Klebinger at 2024-05-17T09:01:08-04:00
TagAnalysis: Treat all bottom ids as tagged during analysis.

Ticket #24806 showed that we also need to treat dead end thunks as
tagged during the analysis.

- - - - -
7eb9f184 by Ben Gamari at 2024-05-17T11:23:37-04:00
Remove haddock submodule

In preparation for merge into the GHC, as proposed in #23178.

- - - - -
47b14dcc by Fendor at 2024-05-17T11:28:17-04:00
Adapt to `IfLclName` newtype changes

(cherry picked from commit a711607e29b925f3d69e27c5fde4ba655c711ff1)

- - - - -
6cc6681d by Fendor at 2024-05-17T11:28:17-04:00
Add IfaceType deduplication table to interface file serialisation

Although we do not really need it in the interface file serialisation,
as the deserialisation uses `getWithUserData`, we need to mirror the
structure `getWithUserData` expects. Thus, we write essentially an empty
`IfaceType` table at the end of the file, as the interface file doesn't
reference `IfaceType`.

(cherry picked from commit c9bc29c6a708483d2abc3d8ec9262510ce87ca61)

- - - - -
b9721206 by Ben Gamari at 2024-05-17T11:30:22-04:00
ghc-tags.yaml: Initial commit

- - - - -
074e7d8f by Ben Gamari at 2024-05-17T11:31:29-04:00
fourmolu: Add configuration

- - - - -
151b1736 by Ben Gamari at 2024-05-17T11:32:52-04:00
Makefile: Rework for use by haddock developers

Previously the Makefile was present only for GHC's old make-based build
system. Now since the make-based build system is gone we can use it for
more useful ends.

- - - - -
a7dcf13b by Ben Gamari at 2024-05-17T11:36:14-04:00
Reformat with fourmolu

Using previously-added configuration and `fourmolu -i .`
Note that we exclude the test-cases
(`./{hoogle,html-hypsrc,latex}-test`) as they are sensitive to
formatting.

- - - - -
0ea6017b by Ben Gamari at 2024-05-17T11:40:04-04:00
Add 'utils/haddock/' from commit 'a7dcf13bfbb97b20e75cc8ce650e2bb628db4660'

git-subtree-dir: utils/haddock
git-subtree-mainline: 7eb9f1849b1c72a1c61dee88462b4244550406f3
git-subtree-split: a7dcf13bfbb97b20e75cc8ce650e2bb628db4660

- - - - -
aba1d304 by Hécate Moonlight at 2024-05-17T11:40:48-04:00
Add exceptions to the dangling notes list

- - - - -
527bfbfb by Hécate Moonlight at 2024-05-17T11:40:52-04:00
Add haddock to the whitespace lint ignore list

- - - - -
43274677 by Ben Gamari at 2024-05-17T11:41:20-04:00
git-blame-ignore-revs: Ignore haddock reformatting

- - - - -
0e679e37 by Fendor at 2024-05-18T00:27:24-04:00
Pass cpp options to the CC builder in hadrian

- - - - -
bb40244e by Sylvain Henry at 2024-05-18T00:28:06-04:00
JS: fix allocation constant (fix #24746)

- - - - -
646d30ab by Jade at 2024-05-18T19:23:31+02:00
Add highlighting for inline-code snippets in haddock

- - - - -
64459a3e by Hécate Moonlight at 2024-05-19T08:42:27-04:00
haddock: Add a .readthedocs.yml file for online documentation

- - - - -
7d3d9bbf by Serge S. Gulin at 2024-05-19T18:47:05+00:00
Unicode: General Category size test (related #24789)

Added trivial size performance test which involves unicode general category usage via `read`.
The `read` itself uses general category to detect spaces.

The purpose for this test is to measure outcome of applying improvements at General Category representation in code discussed at #24789.

- - - - -
8e04efcf by Alan Zimmerman at 2024-05-19T21:29:34-04:00
EPA: Remove redundant code

Remove unused
  epAnnAnns function
  various cases for showAstData that no longer exist

- - - - -
071d7a1e by Rodrigo Mesquita at 2024-05-20T10:55:16-04:00
Improve docs on closed type families in hs-boots

Fixes #24776

- - - - -
d9e2c119 by Torsten Schmits at 2024-05-20T10:55:52-04:00
Use default deviation for large-project test

This new performance test has the purpose of detecting regressions in
complexity in relation to the number of modules in a project, so 1%
deviation is way too small to avoid false positives.

- - - - -
20b0136a by Ben Gamari at 2024-05-22T00:31:39-04:00
ghcup-metadata: Various fixes from 9.10.1

Use Debian 12/x86-64, Debian 10/aarch64, and Debian 11/aarch64 bindists
where possible.

- - - - -
6838a7c3 by Sylvain Henry at 2024-05-22T00:32:23-04:00
Reverse arguments to stgCallocBytes (fix #24828)

- - - - -
f50f46c3 by Fendor at 2024-05-22T00:32:59-04:00
Add log messages for Iface serialisation compression level

Fix the label of the number of 'IfaceType' entries in the log message.
Add log message for the compression level that is used to serialise a an
interface file.

Adds `Outputable` instance for 'CompressionIFace'.

- - - - -
3bad5d55 by Hécate Moonlight at 2024-05-22T00:33:40-04:00
base: Update doctests outputs

ghc-internal: Update doctests outputs

- - - - -
9317c6fb by David Binder at 2024-05-22T00:34:21-04:00
haddock: Fix the testsuites of the haddock-library

- Apply all the metadata revisions from Hackage
  to the cabal file.
- Fix the `ParserSpec.hs` file in the `spec`
  testsuite of haddock-library.
- Make `CHANGES.md` an extra-doc-file instead of
  an extra-source-file.

- - - - -
54073b02 by David Binder at 2024-05-22T00:34:21-04:00
haddock: Fix parser of @since pragma

The testsuite contained tests for annotations of
the form `@since foo-bar-0.5.0`, but the parser was
written incorrectly.

- - - - -
ede6ede3 by Matthew Pickering at 2024-05-22T00:34:57-04:00
Fix nightly pages job

It seems likely broken by 9f99126a which moved `index.html` from the
root folder into `docs/` folder.

Fixes #24840

- - - - -
b7bcf729 by Cheng Shao at 2024-05-22T00:35:32-04:00
autoconf: remove unused context diff check

This patch removes redundant autoconf check for the context diff
program given it isn't actually been used anywhere, especially since
make removal.

- - - - -
ea2fe66e by Hécate Moonlight at 2024-05-22T00:36:13-04:00
haddock: Rework the contributing guide

- - - - -
0f302a94 by Hécate Moonlight at 2024-05-22T00:36:52-04:00
haddock: Add module relationships diagrams of haddock-api and haddock-library

- - - - -
d1a9f34f by Hécate Moonlight at 2024-05-22T00:36:52-04:00
Add instructions

- - - - -
b880ee80 by Hécate Moonlight at 2024-05-22T00:36:52-04:00
Add SVG outputs

- - - - -
6d7e6ad8 by Ben Gamari at 2024-05-22T13:40:05-04:00
rts: Fix size of StgOrigThunkInfo frames

Previously the entry code of the `stg_orig_thunk` frame failed to
account for the size of the profiling header as it hard-coded the frame
size. Fix this.

Fixes #24809.

- - - - -
c645fe40 by Fendor at 2024-05-22T13:40:05-04:00
Add regression test T24809 for stg_orig_thunk_info_frame size

- - - - -
4181aa40 by Andreas Klebinger at 2024-05-22T13:40:42-04:00
bindists: Check for existence of share folder before trying to copy it.

This folder isn't distributed in windows bindists

A lack of doing so resulted us copying loads of files twice.

- - - - -
d216510e by Matthew Pickering at 2024-05-22T13:40:42-04:00
Remove ad-hoc installation of mingw toolchain in relocatable bindists

This reverts 616ac30026e8dd7d2ebb98d92dde071eedf5d951

The choice about whether to install mingw is taken in the installation
makefile.

This is also broken on non-windows systems.

The actual issue was the EnableDistroToolchain variable wasn't declared
in mk/config.mk and therefore the check to install mingw was failing.

- - - - -
7b4c1998 by Cheng Shao at 2024-05-22T21:52:52-04:00
testsuite: fix T17920 for wasm backend

T17920 was marked as fragile on wasm before; it can be trivially fixed
by avoiding calling variadic printf() in cmm.

- - - - -
c739383b by Cheng Shao at 2024-05-22T21:53:29-04:00
testsuite: bump T22744 timeout to 5x

- - - - -
c4c6d714 by Cheng Shao at 2024-05-22T21:54:06-04:00
testsuite: don't attempt to detect host cpu features when testing cross ghc

The testsuite driver CPU feature detection logic only detects host CPU
and only makes sense when we are not testing a cross GHC.

- - - - -
3d9e4ce6 by Simon Peyton Jones at 2024-05-22T21:54:43-04:00
Better skolemisation

As #24810 showed, it is (a little) better to skolemise en-bloc,
so that Note [Let-bound skolems] fires more often.

See Note [Skolemisation en bloc] in GHC.Tc.Utils.Instantiate.

- - - - -
a3cd3a1d by Ryan Scott at 2024-05-22T21:55:19-04:00
Add missing parenthesizePat in cvtp

We need to ensure that the output of `cvtp` is parenthesized (at precedence
`sigPrec`) so that any pattern signatures with a surrounding pattern signature
can parse correctly.

Fixes #24837.

- - - - -
4bb2a7cc by Hécate Moonlight at 2024-05-22T21:55:59-04:00
[base] Document the memory overhead of ByteArray

Add a diagram that shows the constituent parts of a ByteArray and their
memory overhead.

- - - - -
8b2a016a by Hécate Moonlight at 2024-05-22T21:56:38-04:00
Haddock: Add MR template for Haddock

- - - - -
ead75532 by Peter Trommler at 2024-05-23T02:28:05-04:00
PPC: Support ELF v2 on powerpc64 big-endian

Detect ELF v2 on PowerPC 64-bit systems. Check for `_CALL_ELF`
preprocessor macro.

Fixes #21191

- - - - -
9d4c10f2 by Hécate Kleidukos at 2024-05-23T02:28:44-04:00
gitlab: Add @Kleidukos to CODEOWNERS for utils/haddock

- - - - -
28e64170 by Preetham Gujjula at 2024-05-23T07:20:48-04:00
haddock: Add cabal-fmt to tools for `make style`

- - - - -
00126a89 by Andrei Borzenkov at 2024-05-23T07:21:24-04:00
haddock: fix verbosity option parsing

- - - - -
a3e0b68b by Ryan Hendrickson at 2024-05-23T15:52:03-04:00
base: specify tie-breaking behavior of min, max, and related list/Foldable functions

- - - - -
bdcc0f37 by doyougnu at 2024-05-24T07:51:18-04:00
cmm: add word <-> double/float bitcast

- closes: #25331

This is the last step in the project plan described in #25331. This
commit:

- adds bitcast operands for x86_64, LLVM, aarch64
- For PPC and i386 we resort to using the cmm implementations
- renames conversion MachOps from Conv to Round|Truncate

- - - - -
f0d257f7 by Krzysztof Gogolewski at 2024-05-24T07:51:55-04:00
StgToByteCode: minor refactor

Some functions in StgToByteCode were filtering out void arguments.
However, StgToByteCode is called after unarisation: the void arguments
should have been removed earlier.
Instead of filtering out, we assert that the args are non-void.

- - - - -
03137fd2 by Krzysztof Gogolewski at 2024-05-24T07:51:55-04:00
StgToByteCode: minor refactor

`layoutNativeCall` was always called with a `primRepCmmType platform`
callback. Hence we can put it inside of `layoutNativeCall` rather than
repeat it.

- - - - -
27c430f3 by David Binder at 2024-05-24T07:52:38-04:00
haddock: Remove compatibility shims for GHC < 8.4 from haddock-library

- - - - -
8dd8a076 by Cheng Shao at 2024-05-24T07:53:14-04:00
compiler: avoid saving foreign call target to local when there are no caller-save GlobalRegs

This patch makes the STG->Cmm backend avoid saving foreign call target
to local when there are no caller-save GlobalRegs.

Since 321941a8ebe25192cdeece723e1058f2f47809ea, when we lower a
foreign call, we unconditionally save the foreign call target to a
temporary local first, then rely on cmmSink to clean it up later,
which only happens with -fcmm-sink (implied by -O) and not in
unoptimized code.

And this is troublesome for the wasm backend NCG, which needs to infer
a foreign call target symbol's type signature from the Cmm call site.
Previously, the NCG has been emitting incorrect type signatures for
unoptimized code, which happens to work with `wasm-ld` most of the
time, but this is never future-proof against upstream toolchain
updates, and it causes horrible breakages when LTO objects are
included in linker input. Hence this patch.

- - - - -
986df1ab by Cheng Shao at 2024-05-24T07:53:14-04:00
testsuite: add callee-no-local regression test

- - - - -
52d62e2a by Sylvain Henry at 2024-05-24T07:53:57-04:00
Fix HasCallStack leftovers from !12514 / #24726

- - - - -
c5e00c35 by crumbtoo at 2024-05-24T07:54:38-04:00
user_guide: Fix typo in MultiWayIf chapter

Close #24829

- - - - -
bd323b0e by Ben Gamari at 2024-05-24T07:55:15-04:00
base: Ensure that CHANGELOG is included in extra-source-files

This was missed in the `ghc-internal` split.

Closes #24831.

- - - - -
1bfd32e8 by Ben Gamari at 2024-05-24T07:55:15-04:00
base: Fix changelog reference to setBacktraceMechanismState

(cherry picked from commit b63f7ba01fdfd98a01d2f0dec8d9262b3e595c5d)

- - - - -
43e8e4f3 by Sylvain Henry at 2024-05-24T12:16:43-04:00
Float/double unboxed literal support for HexFloatLiterals (fix #22155)

- - - - -
4a7f4713 by Fendor at 2024-05-24T12:17:19-04:00
Improve test labels for binary interface file size tests

Test labels for binary interface file sizes are hard to read and overly
verbose at the same time. Extend the name for the metric title, but
shorten it in the actual comparison table.

- - - - -
14e554cf by Zubin Duggal at 2024-05-24T12:17:55-04:00
Revert "Fix haskell/haddock#783 Don't show button if --quickjump not present"

This reverts commit 7776566531e72c415f66dd3b13da9041c52076aa.

- - - - -
f56838c3 by Ben Gamari at 2024-05-24T12:17:55-04:00
Fix default hyperlinked sources pattern

Previously this didn't include the `%M` token which manifested as broken
links to the hyperlinked sources of reexports of declarations defined
in other packages.

Fixes haddock#1628.

(cherry picked from commit 1432bcc943d41736eca491ecec4eb9a6304dab36)

- - - - -
42efa62c by Ben Gamari at 2024-05-24T12:17:55-04:00
Make DocPaths a proper data type

(cherry picked from commit 7f3a5c4da0023ae47b4c376c9b1ea2d706c94d8c)

- - - - -
53d9ceb3 by Ben Gamari at 2024-05-24T12:17:55-04:00
haddock: Bump version to 2.30

(cherry picked from commit 994989ed3d535177e57b778629726aeabe8c7602)

- - - - -
e4db1112 by Zubin Duggal at 2024-05-24T12:17:55-04:00
haddock-api: allow base 4.20 and ghc 9.11

- - - - -
e294f7a2 by PHO at 2024-05-24T12:17:55-04:00
Add a flag "threaded" for building haddock with the threaded RTS

GHC isn't guaranteed to have a threaded RTS. There should be a way to build
it with the vanilla one.

(cherry picked from commit 75a94e010fb5b0236c670d22b04f5472397dc15d)

- - - - -
51165bc9 by Andreas Klebinger at 2024-05-25T10:58:03-04:00
Update ticky counter event docs.

Add the info about the info table address and json fields.

Fixes #23200

- - - - -
98597ad5 by Sylvain Henry at 2024-05-25T10:58:45-04:00
Export extractPromotedList (#24866)

This can be useful in plugins.

- - - - -
228dcae6 by Teo Camarasu at 2024-05-28T13:12:24+00:00
template-haskell: Move wired-ins to ghc-internal

Thus we make `template-haskell` reinstallable and keep it as the public
API for Template Haskell.
All of the wired-in identifiers are moved to `ghc-internal`.
This necessitates also moving much of `ghc-boot-th` into `ghc-internal`.
These modules are then re-exported from `ghc-boot-th` and
`template-haskell`.
To avoid a dependency on `template-haskell` from `lib:ghc`, we instead
depend on the TH ASTs via `ghc-boot-th`.

As `template-haskell` no longer has special status, we can drop the
logic adding an implicit dependency on `template-haskell` when using TH.
We can also drop the `template-haskell-next` package, which was
previously used when bootstrapping.

When bootstrapping, we need to vendor the TH AST modules from
`ghc-internal` into `ghc-boot-th`. This is controlled by the `bootstrap`
cabal flag as before. See Note [Bootstrapping Template Haskell].

We split out a GHC.Internal.TH.Lift module resolving #24752.
This module is only built when not bootstrapping.

Resolves #24703

-------------------------
Metric Increase:
    ghc_boot_th_dir
    ghc_boot_th_so
-------------------------

- - - - -
62dded28 by Teo Camarasu at 2024-05-28T13:12:24+00:00
testsuite: mark tests broken by #24886

Now that `template-haskell` is no longer wired-in.
These tests are triggering #24886, and so need to be marked broken.

- - - - -
3ca72ad9 by Cheng Shao at 2024-05-30T02:57:06-04:00
rts: fix missing function prototypes in ClosureMacros.h

- - - - -
e0029e3d by Andreas Klebinger at 2024-05-30T02:57:43-04:00
UnliftedFFITypes: Allow `(# #)` as argument when it's the only argument.

This allows representing functions like:

    int foo(void);

to be imported like this:

    foreign import ccall "a_number_c"
      c_number :: (# #) -> Int64#

Which can be useful when the imported function isn't implicitly
stateful.

- - - - -
d0401335 by Matthew Pickering at 2024-05-30T02:58:19-04:00
ci: Update ci-images commit for fedora38 image

The fedora38 nightly job has been failing for quite a while because
`diff` was no longer installed. The ci-images bump explicitly installs
`diffutils` into these images so hopefully they now pass again.

- - - - -
3c97c74a by Jan Hrček at 2024-05-30T02:58:58-04:00
Update exactprint docs

- - - - -
77760cd7 by Jan Hrček at 2024-05-30T02:58:58-04:00
Incorporate review feedback

- - - - -
87591368 by Jan Hrček at 2024-05-30T02:58:58-04:00
Remove no longer relevant reference to comments

- - - - -
05f4f142 by Jan Hrček at 2024-05-30T02:58:59-04:00
Replace outdated code example

- - - - -
45a4a5f3 by Andreas Klebinger at 2024-05-30T02:59:34-04:00
Reword error resulting from missing -XBangPatterns.

It can be the result of either a bang pattern or strict binding,
so now we say so instead of claiming it must be a bang pattern.

Fixes #21032

- - - - -
e17f2df9 by Cheng Shao at 2024-05-30T03:00:10-04:00
testsuite: bump MultiLayerModulesDefsGhciReload timeout to 10x

- - - - -
7a660042 by Cheng Shao at 2024-05-30T14:42:29-04:00
rts: ensure gc_thread/gen_workspace is allocated with proper alignment

gc_thread/gen_workspace are required to be aligned by 64 bytes.
However, this property has not been properly enforced before, and
numerous alignment violations at runtime has been caught by
UndefinedBehaviorSanitizer that look like:

```
rts/sm/GC.c:1167:8: runtime error: member access within misaligned address 0x0000027a3390 for type 'gc_thread' (aka 'struct gc_thread_'), which requires 64 byte alignment
0x0000027a3390: note: pointer points here
 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00
              ^
SUMMARY: UndefinedBehaviorSanitizer: undefined-behavior rts/sm/GC.c:1167:8

rts/sm/GC.c:1184:13: runtime error: member access within misaligned address 0x0000027a3450 for type 'gen_workspace' (aka 'struct gen_workspace_'), which requires 64 byte alignment
0x0000027a3450: note: pointer points here
 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  00 00 00 00
              ^
SUMMARY: UndefinedBehaviorSanitizer: undefined-behavior rts/sm/GC.c:1184:13
```

This patch fixes the gc_thread/gen_workspace misalignment issue by
explicitly allocating them with alignment constraint.

- - - - -
c77a48af by Cheng Shao at 2024-05-30T14:42:29-04:00
rts: fix an unaligned load in nonmoving gc

This patch fixes an unaligned load in nonmoving gc by ensuring the
closure address is properly untagged first before attempting to
prefetch its header. The unaligned load is reported by
UndefinedBehaviorSanitizer:

```
rts/sm/NonMovingMark.c:921:9: runtime error: member access within misaligned address 0x0042005f3a71 for type 'StgClosure' (aka 'struct StgClosure_'), which requires 8 byte alignment
0x0042005f3a71: note: pointer points here
 00 00 00  98 43 13 8e 12 7f 00 00  50 3c 5f 00 42 00 00 00  58 17 b7 92 12 7f 00 00  89 cb 5e 00 42
              ^
SUMMARY: UndefinedBehaviorSanitizer: undefined-behavior rts/sm/NonMovingMark.c:921:9
```

This issue had previously gone unnoticed since it didn't really harm
runtime correctness, the invalid header address directly loaded from a
tagged pointer is only used as prefetch address and will not cause
segfaults. However, it still should be corrected because the prefetch
would be rendered useless by this issue, and untagging only involves a
single bitwise operation without memory access so it's cheap enough to
add.

- - - - -
05c4fafb by Cheng Shao at 2024-05-30T14:42:29-04:00
rts: use __builtin_offsetof to implement STG_FIELD_OFFSET

This patch fixes the STG_FIELD_OFFSET macro definition by using
__builtin_offsetof, which is what gcc/clang uses to implement offsetof
in standard C. The previous definition that uses NULL pointer involves
subtle undefined behavior in C and thus reported by
UndefinedBehaviorSanitizer as well:

```
rts/Capability.h:243:58: runtime error: member access within null pointer of type 'Capability' (aka 'struct Capability_')
SUMMARY: UndefinedBehaviorSanitizer: undefined-behavior rts/Capability.h:243:58
```

- - - - -
5ff83bfc by Sylvain Henry at 2024-05-30T14:43:10-04:00
JS: remove useless h$CLOCK_REALTIME (#23202)

- - - - -
95ef2d58 by Matthew Pickering at 2024-05-30T14:43:47-04:00
ghcup-metadata: Fix metadata generation

There were some syntax errors in the generation script which were
preventing it from running.

I have tested this with:

```
nix shell --extra-experimental-features nix-command -f .gitlab/rel_eng -c ghcup-metadata --metadata ghcup-0.0.7.yaml --date="2024-05-27" --pipeline-id=95534 --version=9.11.20240525
```

which completed successfully.

- - - - -
1bc66ee4 by Jakob Bruenker at 2024-05-30T14:44:22-04:00
Add diagrams to Arrows documentation

This adds diagrams to the documentation of Arrows, similar to the ones found on
https://www.haskell.org/arrows/.

It does not add diagrams for ArrowChoice for the time being, mainly because it's
not clear to me how to visually distinguish them from the ones for Arrow. Ideally,
you might want to do something like highlight the arrows belonging to the same
tuple or same Either in common colors, but that's not really possible with unicode.

- - - - -
d10a1c65 by Matthew Craven at 2024-05-30T23:35:48-04:00
Make UnsafeSNat et al. into pattern synonyms

...so that they do not cause coerce to bypass the nominal
role on the corresponding singleton types when they are imported.
See Note [Preventing unsafe coercions for singleton types] and
the discussion at #23478.

This also introduces unsafeWithSNatCo (and analogues for Char
and Symbol) so that users can still access the dangerous coercions
that importing the real constructors would allow, but only in a
very localized way.

- - - - -
0958937e by Cheng Shao at 2024-05-30T23:36:25-04:00
hadrian: build C/C++ with split sections when enabled

When split sections is enabled, ensure -fsplit-sections is passed to
GHC as well when invoking GHC to compile C/C++; and pass
-ffunction-sections -fdata-sections to gcc/clang when compiling C/C++
with the hadrian Cc builder. Fixes #23381.

- - - - -
02b1f91e by Cheng Shao at 2024-05-30T23:36:25-04:00
driver: build C/C++ with -ffunction-sections -fdata-sections when split sections is enabled

When -fsplit-sections is passed to GHC, pass -ffunction-sections
-fdata-sections to gcc/clang when building C/C++. Previously,
-fsplit-sections was only respected by the NCG/LLVM backends, but not
the unregisterised backend; the GHC driver did not pass
-fdata-sections and -ffunction-sections to the C compiler, which
resulted in excessive executable sizes.

Fixes #23381.

-------------------------
Metric Decrease:
    size_hello_artifact
    size_hello_unicode
-------------------------

- - - - -
fd47e2e3 by Cheng Shao at 2024-05-30T23:37:00-04:00
testsuite: mark process005 as fragile on JS

- - - - -
34a04ea1 by Matthew Pickering at 2024-05-31T06:08:36-04:00
Add -Wderiving-typeable to -Wall

Deriving `Typeable` does nothing, and it hasn't done for a long while.

There has also been a warning for a long while which warns you about
uselessly deriving it but it wasn't enabled in -Wall.

Fixes #24784

- - - - -
75fa7b0b by Matthew Pickering at 2024-05-31T06:08:36-04:00
docs: Fix formatting of changelog entries

- - - - -
303c4b33 by Preetham Gujjula at 2024-05-31T06:09:21-04:00
docs: Fix link to injective type families paper

Closes #24863

- - - - -
df97e9a6 by Ben Gamari at 2024-05-31T06:09:57-04:00
ghc-internal: Fix package description

The previous description was inherited from `base` and was inappropriate
for `ghc-internal`. Also fix the maintainer and bug reporting fields.

Closes #24906.

- - - - -
bf0737c0 by Cheng Shao at 2024-05-31T06:10:33-04:00
compiler: remove ArchWasm32 special case in cmmDoCmmSwitchPlans

This patch removes special consideration for ArchWasm32 in
cmmDoCmmSwitchPlans, which means the compiler will now disable
cmmImplementSwitchPlans for wasm unreg backend, just like unreg
backend of other targets. We enabled it in the past to workaround some
compile-time panic in older versions of LLVM, but those panics are no
longer present, hence no need to keep this workaround.

- - - - -
7eda4bd2 by Cheng Shao at 2024-05-31T15:52:04-04:00
utils: add hie.yaml config file for ghc-config

Add hie.yaml to ghc-config project directory so it can be edited using
HLS.

- - - - -
1e5752f6 by Cheng Shao at 2024-05-31T15:52:05-04:00
hadrian: handle findExecutable "" gracefully

hadrian may invoke findExecutable "" at run-time due to a certain
program is not found by configure script. Which is fine and
findExecutable is supposed to return Nothing in this case. However, on
Windows there's a directory bug that throws an exception (see
https://github.com/haskell/directory/issues/180), so we might as well
use a wrapper for findExecutable and handle exceptions gracefully.

- - - - -
4eb5ad09 by Cheng Shao at 2024-05-31T15:52:05-04:00
configure: do not set LLC/OPT/LLVMAS fallback values when FIND_LLVM_PROG fails

When configure fails to find LLC/OPT/LLVMAS within supported version
range, it used to set "llc"/"opt"/"clang" as fallback values. This
behavior is particularly troublesome when the user has llc/opt/clang
with other versions in their PATH and run the testsuite, since hadrian
will incorrectly assume have_llvm=True and pass that to the testsuite
driver, resulting in annoying optllvm test failures (#23186). If
configure determines llc/opt/clang wouldn't work, then we shouldn't
pretend it'll work at all, and the bindist configure will invoke
FIND_LLVM_PROG check again at install time anyway.

- - - - -
5f1afdf7 by Sylvain Henry at 2024-05-31T15:52:52-04:00
Introduce UniqueSet and use it to replace 'UniqSet Unique'

'UniqSet Unique' represents a set of uniques as a 'Map Unique Unique',
which is wasting space (associated key/value are always the same).

Fix #23572 and #23605

- - - - -
e0aa42b9 by crumbtoo at 2024-05-31T15:53:33-04:00
Improve template-haskell haddocks

Closes #15822

- - - - -
ae170155 by Olivier Benz at 2024-06-01T09:35:17-04:00
Bump max LLVM version to 19 (not inclusive)

- - - - -
92aa65ea by Matthew Pickering at 2024-06-01T09:35:17-04:00
ci: Update CI images to test LLVM 18

The debian12 image in this commit has llvm 18 installed.

- - - - -
adb1fe42 by Serge S. Gulin at 2024-06-01T09:35:53-04:00
Unicode: make ucd2haskell build-able again

ucd2haskell tool used streamly library which version in cabal was out of date. It is updated to the latest version at hackage with deprecated parts rewritten.

Also following fixes were applied to existing code in suppose that from its last run the code structure was changed and now it was required to be up to date with actual folder structures:
1. Ghc module path environment got a suffix with `src`.
2. Generated code got
2.1 `GHC.Internal` prefix for `Data.*`.
2.2 `GHC.Unicode.Internal` swapped on `GHC.Internal.Unicode` according to actual structure.

- - - - -
ad56fd84 by Jade at 2024-06-01T09:36:29-04:00
Replace 'NB' with 'Note' in error messages

- - - - -
6346c669 by Cheng Shao at 2024-06-01T09:37:04-04:00
compiler: fix -ddump-cmm-raw when compiling .cmm

This patch fixes missing -ddump-cmm-raw output when compiling .cmm,
which is useful for debugging cmm related codegen issues.

- - - - -
1c834ad4 by Ryan Scott at 2024-06-01T09:37:40-04:00
Print namespace specifiers in FixitySig's Outputable instance

For whatever reason, the `Outputable` instance for `FixitySig` simply did not
print out namespace specifiers, leading to the confusing `-ddump-splices`
output seen in #24911. This patch corrects this oversight.

Fixes #24911.

- - - - -
cf49fb5f by Sylvain Henry at 2024-06-01T09:38:19-04:00
Configure: display C++ compiler path

- - - - -
f9c1ae12 by Cheng Shao at 2024-06-02T14:01:55-04:00
hadrian: disable PIC for in-tree GMP on wasm32

This patch disables PIC for in-tree GMP on wasm32 target. Enabling PIC
unconditionally adds undesired code size and runtime overhead for
wasm32.

- - - - -
1a32f828 by Cheng Shao at 2024-06-02T14:01:55-04:00
hadrian: disable in-tree gmp fft code path for wasm32

This patch disables in-tree GMP FFT code paths for wasm32 target in
order to give up some performance of multiplying very large operands
in exchange for reduced code size.

- - - - -
06277d56 by Cheng Shao at 2024-06-02T14:01:55-04:00
hadrian: build in-tree GMP with malloc-notreentrant on wasm32

This patch makes hadrian build in-tree GMP with the
--enable-alloca=malloc-notreentrant configure option. We will only
need malloc-reentrant when we have threaded RTS and SMP support on
wasm32, which will take some time to happen, before which we should
use malloc-notreentrant to avoid undesired runtime overhead.

- - - - -
9f614270 by ARATA Mizuki at 2024-06-02T14:02:35-04:00
Set package include paths when assembling .S files

Fixes #24839.

Co-authored-by: Sylvain Henry <hsyl20 at gmail.com>

- - - - -
b1d77716 by Jade at 2024-06-02T21:31:48+02:00
wip

- - - - -


30 changed files:

- + .git-blame-ignore-revs
- .gitignore
- .gitlab-ci.yml
- .gitlab/ci.sh
- + .gitlab/merge_request_templates/Haddock.md
- .gitlab/rel_eng/mk-ghcup-metadata/mk_ghcup_metadata.py
- .gitmodules
- CODEOWNERS
- compiler/GHC.hs
- compiler/GHC/Builtin/Names/TH.hs
- compiler/GHC/Builtin/Types.hs
- compiler/GHC/Cmm.hs
- compiler/GHC/Cmm/Config.hs
- compiler/GHC/Cmm/LRegSet.hs
- compiler/GHC/Cmm/Liveness.hs
- compiler/GHC/Cmm/MachOp.hs
- compiler/GHC/Cmm/Opt.hs
- compiler/GHC/Cmm/Parser.y
- compiler/GHC/Cmm/Pipeline.hs
- compiler/GHC/Cmm/Sink.hs
- compiler/GHC/CmmToAsm/AArch64/CodeGen.hs
- compiler/GHC/CmmToAsm/AArch64/Instr.hs
- compiler/GHC/CmmToAsm/AArch64/Ppr.hs
- compiler/GHC/CmmToAsm/AArch64/RegInfo.hs
- compiler/GHC/CmmToAsm/Monad.hs
- compiler/GHC/CmmToAsm/PPC/CodeGen.hs
- compiler/GHC/CmmToAsm/Wasm/Asm.hs
- compiler/GHC/CmmToAsm/Wasm/FromCmm.hs
- compiler/GHC/CmmToAsm/Wasm/Types.hs
- compiler/GHC/CmmToAsm/X86/CodeGen.hs


The diff was not included because it is too large.


View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/3b26aa6d337b541ac23d9dc6c92f0c4bbca9af23...b1d77716e8588c88168a63fee48da190337943a2

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/3b26aa6d337b541ac23d9dc6c92f0c4bbca9af23...b1d77716e8588c88168a63fee48da190337943a2
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240602/6405eb45/attachment-0001.html>


More information about the ghc-commits mailing list