Document the Shake Lint feature.
authorAndrey Mokhov <andrey.mokhov@gmail.com>
Thu, 10 Jan 2019 23:27:07 +0000 (23:27 +0000)
committerBen Gamari <ben@well-typed.com>
Mon, 14 Jan 2019 14:30:40 +0000 (09:30 -0500)
hadrian/README.md

index 2400699..a94a51b 100644 (file)
@@ -116,6 +116,11 @@ this flag.
 * `--verbose`: run Hadrian in verbose mode. In particular this prints diagnostic
 messages by Shake oracles.
 
+* `--lint`: run [Shake Lint](https://shakebuild.com/manual#lint) during the
+build to check that the build system is well formed. Note that the Lint check
+currently fails under certain circumstances, as discussed in
+[this ticket](https://ghc.haskell.org/trac/ghc/ticket/15971).
+
 #### User settings
 
 The Make-based build system uses `mk/build.mk` to specify user build settings.