summaryrefslogtreecommitdiff
path: root/hadrian
diff options
context:
space:
mode:
authorMatthew Pickering <matthewtpickering@gmail.com>2021-10-14 12:46:41 +0100
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-10-15 18:18:00 -0400
commitc9922a8e4d598f1c6a048305ca58d0ecf34d6776 (patch)
tree4907634d002c2baa13266e7410227b9cbc272a50 /hadrian
parentb6954f0ca8b6a4408f202405e30fea6328a68d92 (diff)
downloadhaskell-c9922a8e4d598f1c6a048305ca58d0ecf34d6776.tar.gz
hadrian: Document lint targets
Fixes #20508
Diffstat (limited to 'hadrian')
-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.