Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

117 lines (82 loc) · 2.94 KB
Raw

Contributing

Building, testing, benchmarking

Building the library:

cabal build

Running the testsuite:

cabal test

Viewing the test options:

cabal run tests -- --help

Running a specific property test with an increased number of test cases (default: 100 cases):

cabal run tests -- -p '/All.Properties.Data.HashSet.basic interface.member/' --quickcheck-tests 100_000

Running the benchmarks:

cabal bench

Viewing the benchmark options:

cabal run benches -- --help

Running a specific benchmark with a reduced target standard deviation (default: 5%):

cabal run benches -- -p /All.HashMap.lookup-miss.ByteString/ --stdev 1

To include comparison benchmarks for containers and hashmap uncomment the cpp-options in the benchmark section of unordered-containers.cabal:

cpp-options: -DBENCH_containers_Map -DBENCH_containers_IntMap -DBENCH_hashmap_Map

References

Inspecting the generated code

The library section in unordered-containers.cabal contains a commented-out set of ghc-options for dumping Core and other forms of generated code. To dump this code, uncomment these options and run

cabal clean
cabal build

You can find the resulting .dump-* files in dist-newstyle/build/**/unordered-containers-*/build/, e.g.

$ tree dist-newstyle/build/x86_64-linux/ghc-9.2.2/unordered-containers-0.2.16.0/build/
dist-newstyle/build/x86_64-linux/ghc-9.2.2/unordered-containers-0.2.16.0/build/
├── Data
│   ├── HashMap
│   │   ├── Internal
│   │   │   ├── Array.dump-asm
│   │   │   ├── Array.dump-cmm
│   │   │   ├── Array.dump-simpl
│   │   │   ├── Array.dump-stg-final
...

To visually compare the generated code from two different states of the source tree, you can copy the dist-newstyle/build/**/unordered-containers-*/build/ directory from each state to two directories a and b and then use a diff tool like Meld to compare them:

meld a/ b/

References

Code style

This package uses stylish-haskell to format language pragmas and import sections. To format a specific file, run

stylish-haskell -i FILENAME

To format all the Haskell files under a specific directory, run

stylish-haskell -ir DIRNAME