summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Eisenberg <rae@richarde.dev>2019-07-18 13:51:57 -0400
committerMarge Bot <ben+marge-bot@smart-cactus.org>2019-07-19 18:10:06 -0400
commitff996555b97f18d27f82a53c0a9bb32203cb8819 (patch)
tree7d50508e5b2ca396483bc7e88796471c1d79b8ee
parent257d1fd86e6e5e7d145d71707904d8fe54024041 (diff)
downloadhaskell-ff996555b97f18d27f82a53c0a9bb32203cb8819.tar.gz
Add module doc for Plugins.
This was requested in #15650.
-rw-r--r--compiler/main/Plugins.hs5
1 files changed, 5 insertions, 0 deletions
diff --git a/compiler/main/Plugins.hs b/compiler/main/Plugins.hs
index 26bd41fd08..c787960dd6 100644
--- a/compiler/main/Plugins.hs
+++ b/compiler/main/Plugins.hs
@@ -1,5 +1,10 @@
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE CPP #-}
+
+-- | Definitions for writing /plugins/ for GHC. Plugins can hook into
+-- several areas of the compiler. See the 'Plugin' type. These plugins
+-- include type-checker plugins, source plugins, and core-to-core plugins.
+
module Plugins (
-- * Plugins
Plugin(..)