Changes between Version 17 and Version 18 of HIEFiles


Ignore:
Timestamp:
Aug 13, 2018 1:04:15 PM (16 months ago)
Author:
wz1000
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HIEFiles

    v17 v18  
    111111To handle this case, we must store the Span of the instance/class definition along with the names.
    112112
     113== Validation of AST
     114
     115There are a few simple validation tests enabled by `-fvalidate-hie`
     116
     117* The shape invariants of the AST are checked(parent node spans completely contain children node spans which are arranged in left to right order without any overlaps)
     118* Scope information collected is validated(by checking all symbol occurrences are in the calculated scope)
     119* The AST is round-tripped through the binary serialization and checked for consistency
     120
    113121== Use cases
    114122
     
    129137== Modifications to GHC
    130138
    131 * HIE file generation will be controlled by a GHC flag(--enable-ide-info?)
     139* HIE file generation will be controlled by a GHC flag(-fenable-ide-info)
    132140* The file will be generated as soon as GHC is done typechecking a file(maybe in [https://www.stackage.org/haddock/nightly-2018-05-04/ghc-8.4.2/src/HscMain.html#hscIncrementalCompile hscIncrementalCompile]?)
    133141* Need to coordinate with the Hi Haddock project(Including docstrings in .hi files) as that may push the burden of resolving Names/Symbols in haddock comments onto GHC.