Update the "Special built-in functions" docs
authorIan Lynagh <ian@well-typed.com>
Tue, 13 Nov 2012 21:02:33 +0000 (21:02 +0000)
committerIan Lynagh <ian@well-typed.com>
Tue, 13 Nov 2012 21:02:33 +0000 (21:02 +0000)
In particular, avoid referring the user to GHC.Prim; they generally
ought to use GHC.Exts instead.

docs/users_guide/glasgow_exts.xml

index fa0f3aa..eeea29b 100644 (file)
@@ -9907,24 +9907,17 @@ r) ->
 
 <sect1 id="special-ids">
 <title>Special built-in functions</title>
-<para>GHC has a few built-in functions with special behaviour.  These
-are now described in the module <ulink
-url="&libraryGhcPrimLocation;/GHC-Prim.html"><literal>GHC.Prim</literal></ulink>
-in the library documentation.
+<para>GHC has a few built-in functions with special behaviour.
 In particular:
 <itemizedlist>
 <listitem><para>
-<ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3Ainline"><literal>inline</literal></ulink>
+<ulink url="&libraryGhcPrimLocation;/GHC-Exts.html#v%3Ainline"><literal>inline</literal></ulink>
 allows control over inlining on a per-call-site basis.
 </para></listitem>
 <listitem><para>
-<ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3Alazy"><literal>lazy</literal></ulink>
+<ulink url="&libraryGhcPrimLocation;/GHC-Exts.html#v%3Alazy"><literal>lazy</literal></ulink>
 restrains the strictness analyser.
 </para></listitem>
-<listitem><para>
-<ulink url="&libraryGhcPrimLocation;/GHC-Prim.html#v%3AunsafeCoerce%23"><literal>unsafeCoerce#</literal></ulink>
-allows you to fool the type checker.
-</para></listitem>
 </itemizedlist>
 </para>
 </sect1>