sheaf authored 1 year ago and Zubin committed 1 year ago

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!

(cherry picked from commit b96241ba)

Reduce memory usage

Removes a potential retainer of `ModSummary`s

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

- 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

- 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

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

- ghc-debug dependency and instrumentation
- cabal.project custom with-compiler
- hie.yaml files
- traces and such

- 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

The footnote is invalid with GHC 9.2.4 (and possibly earlier): the described behaviour in the main text works fine.

Simon Peyton Jones authored 2 years ago and Simon Peyton Jones committed 2 years ago

See #21623 and !8750

John Ericson authored 3 years ago and sheaf committed 2 years ago

Spooky, but I guess that is intended?

Sphinx was complaining about too-short title underlines.

Merge GHC 9.4 into `main`