[commit: ghc] wip/merge-queue: Document the Shake Lint feature. (eaa62f8)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : wip/merge-queue
Link       : http://ghc.haskell.org/trac/ghc/changeset/eaa62f8ad88737d08b07d64405a56d98340e7556/ghc

>---------------------------------------------------------------

commit eaa62f8ad88737d08b07d64405a56d98340e7556
Author: Andrey Mokhov <andrey.mokhov at gmail.com>
Date:   Thu Jan 10 23:27:07 2019 +0000

    Document the Shake Lint feature.


>---------------------------------------------------------------

eaa62f8ad88737d08b07d64405a56d98340e7556
 hadrian/README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/hadrian/README.md b/hadrian/README.md
index 2400699..a94a51b 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -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.