genprimopcode: GHC.Prim is Unsafe (#9449)
authorAustin Seipp <austin@well-typed.com>
Mon, 1 Sep 2014 20:13:44 +0000 (15:13 -0500)
committerAustin Seipp <austin@well-typed.com>
Mon, 1 Sep 2014 20:13:45 +0000 (15:13 -0500)
Summary:
Make sure the documentation for `GHC.Prim` adequately
reflects the fact it is unsafe.

Also clean up some 80-column violations.

Signed-off-by: Austin Seipp <austin@well-typed.com>
Test Plan:
Build documentation, check `GHC.Prim`. It's properly marked
as `Unsafe`.

Reviewers: hvr, goldfire, ezyang

Reviewed By: ezyang

Subscribers: nomeata, simonmar, ezyang, carter

Differential Revision: https://phabricator.haskell.org/D182

GHC Trac Issues: #9449

utils/genprimopcode/Main.hs

index bb40917..67c2131 100644 (file)
@@ -227,7 +227,7 @@ gen_hs_source (Info defaults entries) =
     ++ "consumed by haddock.\n"
     ++ "-}\n"
     ++ "\n"
-        ++ "-----------------------------------------------------------------------------\n"
+        ++ (replicate 77 '-' ++ "\n") -- For 80-col cleanliness
         ++ "-- |\n"
         ++ "-- Module      :  GHC.Prim\n"
         ++ "-- \n"
@@ -238,9 +238,13 @@ gen_hs_source (Info defaults entries) =
         ++ "-- GHC\'s primitive types and operations.\n"
         ++ "-- Use GHC.Exts from the base package instead of importing this\n"
         ++ "-- module directly.\n"
-        ++ "--\n" 
-        ++ "-----------------------------------------------------------------------------\n"
-        ++ "{-# LANGUAGE MagicHash, MultiParamTypeClasses, NoImplicitPrelude, UnboxedTuples #-}\n"
+        ++ "--\n"
+        ++ (replicate 77 '-' ++ "\n") -- For 80-col cleanliness
+        ++ "{-# LANGUAGE Unsafe #-}\n"
+        ++ "{-# LANGUAGE MagicHash #-}\n"
+        ++ "{-# LANGUAGE MultiParamTypeClasses #-}\n"
+        ++ "{-# LANGUAGE NoImplicitPrelude #-}\n"
+        ++ "{-# LANGUAGE UnboxedTuples #-}\n"
         ++ "module GHC.Prim (\n"
         ++ unlines (map (("        " ++) . hdr) entries')
         ++ ") where\n"