aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/haddock-api.cabal
Commit message (Collapse)AuthorAgeFilesLines
* Use `.hie` files for the Hyperlinker backend (#977)Alec Theriault2019-01-311-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # 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-6/+8
|\
| * Fix issues around plus/minusAlec Theriault2018-11-071-3/+0
| | | | | | | | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
| * Fix copy-pasta error in data-filesAlec Theriault2018-10-241-5/+5
| |
| * Update 'data-files' to include NewOcean stuffAlec Theriault2018-10-211-0/+5
| |
| * Release `haddock{,-api}-2.22.0`Alec Theriault2018-10-161-1/+1
| | | | | | | | This version will accompany ghc-8.6.2
* | Merge branch 'ghc-8.6' into ghc-headAlec Theriault2018-10-161-6/+6
|\|
| * Bump haddock-library to 1.7.0Alec Theriault2018-10-161-2/+2
| | | | | | | | | | | | 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).
| * Turn haddock-library into a minor releaseAlec Theriault2018-09-221-2/+2
| | | | | | | | Fix some version bounds in haddock-library too.
| * Bump haddock-api-2.21.0, haddock-library-1.7.0Alec Theriault2018-09-221-6/+6
| | | | | | | | | | | | * Update CHANGELOGS * Update new versions in Cabal files * Purge references to ghc-8.4/master branches in README
| * Revert "Revert "Bump GHC version to 8.6""Simon Jakobi2018-07-201-2/+2
| | | | | | | | | | | | That commit didn't belong onto the ghc-8.6 branch. This reverts commit acbaef3b9daf1d2dea10017964bf886e77a8e967.
| * Update the ghc-8.6 branch (#889)Simon Jakobi2018-07-201-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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 #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 #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 #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 #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)
* | Bump GHC version to 8.7Ben Gamari2018-06-201-2/+2
| |
* | Revert "Bump GHC version to 8.6"Herbert Valerio Riedel2018-06-201-2/+2
|/ | | | | | | | 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.
* Bump GHC version to 8.6Ben Gamari2018-06-191-2/+2
|
* Bump ghc bound for haddock-api spec test-suiteSimon Jakobi2018-06-141-1/+1
|
* Bump bounds on CabalSimon Jakobi2018-06-131-2/+2
|
* Bump a few dependency bounds (#845)Simon Jakobi2018-06-131-3/+3
|
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-011-2/+2
|\
| * Bump upper bound on base to < 4.13Ryan Scott2018-04-191-1/+1
| | | | | | | | See https://ghc.haskell.org/trac/ghc/ticket/15018.
* | Travis: Build with ghc-8.4.2 (#793)Alexander Biehl2018-04-031-1/+1
| |
* | Bump haddock and haddock-api to 2.20.0alexbiehl2018-03-281-1/+1
| |
* | haddock-2.19.1, haddock-api-2.19.1, haddock-library-1.6.0alexbiehl2018-03-271-2/+2
| |
* | Bump lower bound for haddock-libraryalexbiehl2018-03-101-1/+1
| |
* | Update to QC 2.11Herbert Valerio Riedel2018-03-101-1/+1
| |
* | Bump haddock-2.19.0.1, haddock-api-2.19.0.1, haddock-library-1.5.0.1alexbiehl2018-03-101-3/+3
| |
* | hadock-2.19.0 / haddock-api-2.19.0 / haddock-library-1.5.0Alexander Biehl2018-02-011-3/+3
| |
* | Use the GHC lexer for the Hyperlinker backend (#714)Alec Theriault2018-02-011-9/+53
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | haddock-api: bump ghc to ^>= 8.4alexbiehl2018-01-201-2/+2
|/
* Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-10-311-1/+1
|\
| * Add QuickJump version to meta.json (#696)Alexander Biehl2017-10-301-1/+1
| |
* | Merge remote-tracking branch 'origin/ghc-head' into HEADalexbiehl2017-10-081-3/+3
|\ \ | |/ |/|
| * Make compatible with Prelude.<> export in GHC 8.4/base-4.11Herbert Valerio Riedel2017-09-211-1/+1
| |
| * Bump ghc version for haddock-api testsalexbiehl2017-08-221-1/+1
| |
| * Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-08-211-26/+49
| |\
| * | haddock-api: Bump bound on GHCBen Gamari2017-03-231-1/+1
| | |
| * | Merge commit '240bc38b94ed2d0af27333b23392d03eeb615e82' into HEADBen Gamari2017-03-231-2/+1
| |\ \
* | | | Add compile step that bundles and compresses JS files (#684)Tim Baumann2017-09-231-4/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | | | Add missing js files to data-files (#677)Alexander Biehl2017-09-011-0/+3
| | | |
* | | | Write meta.json when generating html output (#676)Alexander Biehl2017-08-301-0/+1
| | | |
* | | | Generate an index for package content search (#662)Florian Eggenhofer2017-08-271-0/+1
| |_|/ |/| | | | | Generate an index for package content search
* | | Provide --show-interface option to dump interfaces (#645)Alexander Biehl2017-08-061-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* | | Bump haddock-library in haddock-apiAlexander Biehl2017-08-061-1/+1
| | |
* | | Move `DocMarkup` from haddock-api to haddock-library (#659)Alexander Biehl2017-07-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-1/+1
| | |
* | | Drop obsolete/misleading `stability: experimental`Herbert Valerio Riedel2017-07-201-1/+0
| | | | | | | | | | | | This .cabal property has long been considered obsolete
* | | haddock-api: add changelog pointing to haddock's changelogHerbert Valerio Riedel2017-07-201-0/+3
| | | | | | | | | | | | | | | This addresses https://github.com/haskell/haddock/issues/638#issuecomment-309283297
* | | Tweak haddock-api.cabal for pending releaseHerbert Valerio Riedel2017-07-201-10/+23
| | |
* | | Prepare 2.18.1 release (#657)Alexander Biehl2017-07-201-1/+1
| | |
* | | Avoid missing home module warning (#652)Alex Biehl2017-07-081-0/+2
| | | | | | | | | | | | | | | | | | * Avoid missing home module warning * Update haddock-library.cabal