aboutsummaryrefslogtreecommitdiff
path: root/CHANGES.md
Commit message (Collapse)AuthorAgeFilesLines
* Tentative 2.24 releaseAlec Theriault2020-03-221-0/+7
| | | | | Adjusted changelogs and versions in `.cabal` files in preparation for the upcoming release bundled with GHC 8.10.
* Release haddock-2.23, haddock-library-1.8.0Alec Theriault2019-05-261-1/+3
| | | | | Tentatively adjust bounds and changelogs for the release to be bundled with GHC 8.8.1.
* Many LaTeX backend fixesAlec Theriault2019-03-091-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 #935, #929 (LaTeX docs for `text` build & compile) Fixes #727, #930 (I think both are really about type families...)
* Better support for default methods in classesAlec Theriault2019-03-091-0/+3
| | | | | | | | | | * 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
* Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-03-031-2/+13
|\
| * Rename 'NewOcean' theme to 'Linuwial'Alec Theriault2018-11-111-1/+1
| |
* | Use `.hie` files for the Hyperlinker backend (#977)Alec Theriault2019-01-311-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # 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 #998) * restructure temporary folder logic for `.hi`/`.hie` model
* | Merge branch 'ghc-8.6' into ghc-headAlec Theriault2018-11-101-2/+12
|\|
| * Update changelogAlec Theriault2018-11-101-1/+3
| |
| * Fix CHANGELOGAlec Theriault2018-10-211-2/+4
| |
| * Changelog entry for NewOceanalexbiehl2018-10-181-0/+2
| |
| * Release `haddock{,-api}-2.22.0`Alec Theriault2018-10-161-1/+1
| | | | | | | | This version will accompany ghc-8.6.2
| * Output pattern synonyms in Hoogle backend (#947)Alec Theriault2018-10-161-0/+2
| | | | | | | | | | | | | | | | | | | | | | * Output pattern synonyms in Hoogle backend We were previously weren't outputting _any_ pattern synonyms, bundled or not. Now, we output both. Fixes #946. * Update changelog
| * Update changelogAlec Theriault2018-10-161-0/+2
| |
* | Bump version boundsAlec Theriault2018-11-061-0/+2
|/
* Merge branch 'ghc-8.4' into ghc-8.6Alec Theriault2018-10-161-0/+4
|\
* | Bump haddock-api-2.21.0, haddock-library-1.7.0Alec Theriault2018-09-221-4/+8
| | | | | | | | | | | | * Update CHANGELOGS * Update new versions in Cabal files * Purge references to ghc-8.4/master branches in README
* | Merge branch 'ghc-head' into ghc-head-update-3Simon Jakobi2018-06-141-0/+3
|\ \
| * | Use the response file utilities defined in `base` (#821)Chaitanya Koparkar2018-05-101-0/+3
| | | | | | | | | | | | | | | | | | Summary: The response file related modules were recently copied from `haddock` into `base`. This patch removes them from `haddock`. GHC Trac Issues: #13896
* | | Use the response file utilities defined in `base` (#821)Chaitanya Koparkar2018-06-131-0/+3
| | | | | | | | | | | | | | | | | | Summary: The response file related modules were recently copied from `haddock` into `base`. This patch removes them from `haddock`. GHC Trac Issues: #13896
* | | Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-011-1/+10
|\| | | |/ |/|
| * Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-131-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
| * Update changelogAlexander Biehl2017-12-061-1/+1
| |
* | haddock-2.19.1, haddock-api-2.19.1, haddock-library-1.6.0alexbiehl2018-03-271-1/+3
| |
* | Prepare changelog for next releasealexbiehl2018-03-211-0/+4
| |
* | Update changelogs for haddock-2.19.0.1 and haddock-library-1.5.0.1alexbiehl2018-03-101-0/+6
| |
* | Add `SPDX-License-Identifier` as alised for "license" module header tokensHerbert Valerio Riedel2018-02-051-0/+3
| | | | | | | | | | | | | | | | | | | | | | 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 #743
* | Adjust changelogsAlexander Biehl2018-02-011-3/+4
| |
* | Grid Tables (#718)Oleg Grenrus2018-02-011-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Use the GHC lexer for the Hyperlinker backend (#714)Alec Theriault2018-02-011-0/+3
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-10-311-0/+3
|\
| * Correct missing title in changelogalexbiehl2017-10-311-1/+1
| |
| * Supported reexported-modules via --reexport flag.Edward Z. Yang2017-10-311-1/+4
| | | | | | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
* | Overhaul Haddock's rendering of kind signatures (#681)Ryan Scott2017-10-241-0/+3
|/ | | | | | | | | | | | | | | * 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
* Inhibit output of coverage information for hidden modules. (#687)Merijn Verstraaten2017-10-041-0/+3
| | | | | | * Inhibit output of coverage information for hidden modules. * Add changelog entry.
* Write meta.json when generating html output (#676)Alexander Biehl2017-08-301-0/+2
|
* Fix: Generate pattern signatures for constructors exported as patterns (#663)Tim Baumann2017-08-061-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | * 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 #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 #663 * Fix extractPatternSyn error message
* Fix renaming after instance signature specializing (#660)Moritz Drexl2017-08-051-0/+2
| | | | | | | | | | * rework rename * Add regression test for Bug 613 * update tests * update changelog
* Move `DocMarkup` from haddock-api to haddock-library (#659)Alexander Biehl2017-07-311-0/+2
| | | | | | | | | | * Move `DocMarkup` from haddock-api to haddock-library * Move more markup related functions * Markup module * CHANGELOG
* Bump haddock to 2.18.2, haddock-library to 1.4.5alexbiehl2017-07-271-0/+4
|
* Prepare 2.18.1 release (#657)Alexander Biehl2017-07-201-1/+1
|
* Make per-argument docs for class methods work again (#648)Alex Biehl2017-06-291-2/+4
| | | | | | * Make per-argument docs for class methods work again * Test case
* Haddock support for bundled pattern synonyms (#627)Christiaan Baaij2017-06-091-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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 #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
* Allow user defined signatures for pattern synonyms (#631)Alex Biehl2017-06-031-0/+2
|
* Bump to 2.18.0 (#605)Alex Biehl2017-04-261-1/+1
|
* Markdownify changelogalexbiehl2017-04-261-0/+766
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-20 06:59:53 +0000