summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Pickering <matthewtpickering@gmail.com>2021-10-14 12:46:41 +0100
committerMatthew Pickering <matthewtpickering@gmail.com>2021-10-14 12:47:34 +0100
commit3e8c37d2ecf3b1843bc320c092b9cdf643da8903 (patch)
tree3d81caf0d76cb8e4f54d46580030fc794b95536e
parent19cd403bced51bc27a11f0257c25497154e86889 (diff)
downloadhaskell-wip/hadrian-lint-docs.tar.gz
hadrian: Document lint targetswip/hadrian-lint-docs
Fixes #20508
-rw-r--r--hadrian/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/hadrian/README.md b/hadrian/README.md
index 4d772891be..20020c3b92 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -208,6 +208,20 @@ system offers.
`build selftest` runs tests of the build system. The current test coverage
is close to zero (see [#197][test-issue]).
+#### Running linters
+
+There are two targets which runs the lint commands used by CI:
+
+* `lint:base`, runs hlint on the `base` library.
+* `lint:compiler`, runs hlint on the `ghc` library.
+
+It's useful to know that you can combine multiple targets in build command. For example,
+you can tell hadrian to build the compiler and also run the linters:
+
+```
+./hadrian/build stage2:exe:ghc-bin lint:compiler
+```
+
#### Clean and full rebuild
* `build clean` removes all build artefacts.