aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Interface/Create.hs
Commit message (Collapse)AuthorAgeFilesLines
* Fix partial record selector warningBen Gamari2021-02-061-3/+3
|
* Merge remote-tracking branch 'origin/ghc-head' into wip/ghc-head-mergeBen Gamari2021-02-061-248/+348
|\
| * Merge pull request #1273 from hsyl20/wip/hsyl20/arrowsHécate Moonlight2021-01-141-1/+1
| |\ | | | | | | Fix after binder collect changes
| | * Fix after binder collect changesSylvain Henry2020-12-211-1/+1
| | |
| * | Abstract Monad for interface creationAlex Biehl2021-01-091-198/+137
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * | Prepare Haddock for being a GHC PluginAlex Biehl2021-01-091-32/+215
| | |
* | | Merge remote-tracking branch 'origin/ghc-9.0' into ghc-headBen Gamari2021-01-131-61/+109
|\ \ \ | |/ / |/| |
| * | Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-051-67/+113
| |\ \
| | * | Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)Xia Li-yao2020-12-081-9/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix multiple typos and inconsistencies in doc/markup.rst Note: I noticed some overlap with #1112 from @wygulmage and #1081 from @parsonsmatt after creating these proposed changes - mea culpa for not looking at the open PRs sooner. * Fix #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@mattaudesse.com> Co-authored-by: Mike Pilgrem <mpilgrem@users.noreply.github.com> Co-authored-by: Guillaume Bouchard <guillaume.bouchard@tweag.io> Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
| | * | Fallback to `hiDecl` when `extractDecl` failsAlec Theriault2020-04-211-45/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 #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`.
| | * | Don't warn about missing links in miminal sigsAlec Theriault2020-04-151-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 #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 #1070.
| | * | Prune docstrings that are never renderedAlec Theriault2020-04-151-2/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 #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.
| | * | Use `unLoc`/`noLoc` from GHC instead of `unL`/`reL`Alec Theriault2020-03-281-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * `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 #978
| | * | Clean up warningsAlec Theriault2020-03-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | * unused imports * imports of `Data.List` without import lists * missing `CompatPrelude` file in `.cabal`
| | * | Merge branch 'ghc-8.8' into ghc-8.10Alec Theriault2020-03-201-6/+7
| | |\ \
| | | * | Fix the ignore-exports option (#1082)Alexis King2019-09-301-4/+5
| | | | | | | | | | | | | | | The `ignore-exports` option has been broken since #688, as mentioned in https://github.com/haskell/haddock/pull/766#issue-172505043. This PR fixes it.
| | | * | Matching changes in GHC for #16236Alan Zimmerman2019-03-291-3/+3
| | | | | | | | | | | | | | | | | | | | (cherry picked from commit 3ee6526d4ae7bf4deb7cd1caf24b3d7355573576)
| | | * | Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-03-031-2/+2
| | | |\ \
| | | | * | Fix standalone deriving docsAlec Theriault2019-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Docs on standalone deriving decls for classes with associated types should be associated with the class instance, not the associated type instance. Fixes #1033
| * | | | | Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaledAlan Zimmerman2020-10-211-5/+4
| | | | | | | | | | | | | | | | | | | | | | | | (cherry picked from commit a7d1d8e034d25612d5d08ed8fdbf6f472aded4a1)
* | | | | | Adapt to changes to GlobalRdrElt and AvailInfoAdam Gundry2020-12-231-10/+2
| |_|_|_|/ |/| | | | | | | | | | | | | | Needed for ghc/ghc!4467
* | | | | DynFlags's unit fields moved to HscEnvSylvain Henry2020-11-301-4/+5
| | | | |
* | | | | Add type arguments to PrefixConCale Gibbard2020-11-251-1/+1
| | | | |
* | | | | Adapt to HsOuterTyVarBndrsRyan Scott2020-10-301-10/+7
| | | | | | | | | | | | | | | | | | | | | | | | | These changes accompany ghc/ghc!4107, which aims to be a fix for #16762.
* | | | | Adapt to HsConDecl{H98,GADT}Details splitRyan Scott2020-10-301-7/+11
| | | | | | | | | | | | | | | | | | | | Needed for GHC#18844.
* | | | | GHC.Driver.Types refactoring (#1242)Sylvain Henry2020-10-261-2/+6
| | | | |
* | | | | Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaledAlan Zimmerman2020-10-191-2/+3
| | | | |
* | | | | Fix after Outputable refactoringSylvain Henry2020-08-051-3/+5
| | | | |
* | | | | Update for modular ping pongZubin Duggal2020-07-231-6/+2
|/ / / /
* | | | Use functions exported from HsToCoreZubin Duggal2020-06-211-183/+1
| | | |
* | | | Adapt Haddock to LinearTypesKrzysztof Gogolewski2020-06-171-9/+12
| | | | | | | | | | | | | | | | See ghc/ghc!852.
* | | | Use HsForAllTelescope (GHC#18235)Ryan Scott2020-06-131-1/+1
| | | |
* | | | Fix after unit refactoringSylvain Henry2020-06-081-12/+11
| | | |
* | | | Fix for GHC.Unit.* modulesSylvain Henry2020-04-271-2/+2
| | | |
* | | | UnitId has been renamed into UnitSylvain Henry2020-04-271-6/+6
| | | |
* | | | Module structureSylvain Henry2020-04-241-4/+3
| | | |
* | | | Module renaming: amend previous patchSylvain Henry2020-04-051-1/+1
| | | |
* | | | Modules: type checkerSylvain Henry2020-03-301-1/+1
| | | |
* | | | Merge commit '3c2944c037263b426c4fe60a3424c27b852ea71c' into HEADBen Gamari2020-03-231-2/+2
|\ \ \ \ | | | | | | | | | | | | | | | More changes from the GHC types module refactoring.
| * | | | Modules: TypesSylvain Henry2020-03-201-10/+10
| | | | |
* | | | | Modules: TypesSylvain Henry2020-03-181-10/+10
|/ / / /
* | | | Merge pull request #1130 from hsyl20/wip/hsyl20-modules-core2Ben Gamari2020-03-161-1/+1
|\ \ \ \ | | | | | | | | | | Modules: Core (#13009)
| * | | | Modules: Core (#13009)Sylvain Henry2020-03-021-1/+1
| | | | |
* | | | | Changes in GHC's !1913.Richard Eisenberg2020-03-091-2/+2
|/ / / /
* | | | Ignore the BufLoc/BufSpan added in GHC's !2516Vladislav Zavialov2020-02-281-2/+2
| | | |
* | | | Use RealSrcSpan in InstMapVladislav Zavialov2020-02-221-18/+12
| | | |
* | | | Modules: Driver (#13009)Sylvain Henry2020-02-191-2/+2
| | | |
* | | | Changes for GHC#17608Ryan Scott2020-01-081-3/+4
| | | | | | | | | | | | | | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2372
* | | | Remove HasSrcSpan (#17494)Vladislav Zavialov2019-11-281-7/+7
|/ / /
* | | Changes for #15247Ryan Scott2019-07-031-34/+34
| | |
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-22 07:24:53 +0000