Forked from Glasgow Haskell Compiler / GHC

10769 commits behind the upstream repository.

template-haskell: Add putDoc, getDoc, withDecDoc and friends

Luke Lau authored 4 years ago

This adds two new methods to the Quasi class, putDoc and getDoc. They
allow Haddock documentation to be added to declarations, module headers,
function arguments and class/type family instances, as well as looked
up.

It works by building up a map of names to attach pieces of
documentation to, which are then added in the extractDocs function in
GHC.HsToCore.Docs. However because these template haskell names need to
be resolved to GHC names at the time they are added, putDoc cannot
directly add documentation to declarations that are currently being
spliced. To remedy this, withDecDoc/withDecsDoc wraps the operation with
addModFinalizer, and provides a more ergonomic interface for doing so.
Similarly, the funD_doc, dataD_doc etc. combinators provide a more
ergonomic interface for documenting functions and their arguments
simultaneously.

This also changes ArgDocMap to use an IntMap rather than an Map Int, for
efficiency.

Part of the work towards #5467

8a59f49a

History

8a59f49a 4 years ago

History

Name	Last commit	Last update
..
config
driver
mk
tests
timeout
.gitignore
LICENSE
LICENSE.GPL
Makefile
README.md

README.md

GHC Testsuite Readme

For the full testsuite documentation, please see here.

Quick Guide

Commands to run testsuite:

Full testsuite: make
Using more threads: make THREADS=12
Reduced (fast) testsuite: make fast
Run a specific test: make TEST=tc054
Test a specific 'way': make WAY=optllvm
Keeping the run directory after test run: make CLEANUP=0. You will find a directory {test_name}.run in the test's source directory.
Test a specific stage of GHC: make stage=1
Skip performance tests: make SKIP_PERF_TESTS=YES
Set verbosity: make VERBOSE=n where n=0: No per-test output, n=1: Only failures, n=2: Progress output, n=3: Include commands called (default), n=4: Include perf test results unconditionally, n=5: Echo commands in subsidiary make invocations
Pass in extra GHC options: make EXTRA_HC_OPTS=-fvectorize

You can also change directory to a specific test folder to run that individual test or group of tests. For example:

$ cd tests/array
$ make

Testsuite Ways

The testsuite can be run in a variety of 'ways'. This concept refers to different ways that GHC can compile the code. For example, using the native code generator (-fasm) is one way, while using the LLVM code generator (-fllvm) is another way.

The various ways that GHC supports are defined in config/ghc

Adding Tests

Please see the more extensive documentation here.