diff options
| author | Alan Zimmerman <alan.zimm@gmail.com> | 2015-11-01 10:18:25 +0100 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2015-11-01 10:18:37 +0100 |
| commit | c3b02150b516963422ed4b9b200a38814a35b535 (patch) | |
| tree | 769cc5b7982ab077bf580a5db8e29acb80300df4 /compiler | |
| parent | 31bcf9b62ceaed98bdd3b7605e68d315bcff0c8a (diff) | |
| download | haskell-c3b02150b516963422ed4b9b200a38814a35b535.tar.gz | |
Provide a utility to check API Annotations docs
A utility to check API Annotations was provided in
https://git.haskell.org/ghc.git/commitdiff/43751b2436f370d956d8021b3cdd3
eb77801470b
This commit had poor documentation.
This patch improves the output generated by the utility as well as
supplying better documentation
Test Plan: ./validate
Reviewers: simonpj, austin, bgamari
Reviewed By: austin, bgamari
Subscribers: thomie, mpickering
Differential Revision: https://phabricator.haskell.org/D1397
GHC Trac Issues: #10917
Diffstat (limited to 'compiler')
| -rw-r--r-- | compiler/parser/Parser.y | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/compiler/parser/Parser.y b/compiler/parser/Parser.y index d9da3c8a90..67d2adeb64 100644 --- a/compiler/parser/Parser.y +++ b/compiler/parser/Parser.y @@ -312,6 +312,11 @@ See https://ghc.haskell.org/trac/ghc/wiki/GhcAstAnnotations for some background. +If you modify the parser and want to ensure that the API annotations are processed +correctly, see the README in (REPO)/utils/check-api-annotations for details on +how to set up a test using the check-api-annotations utility, and interpret the +output it generates. + -- ----------------------------------------------------------------------------- -} |