FIX #1861: floating-point constants for infinity and NaN in via-C

[ghc-hetmet.git] / docs / users_guide / using.xml

diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index c24a20c..21e5205 100644 (file)
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -73,10 +73,9 @@ module X where
       maintains internally, so you'll be desperately disappointed if
       you try to glob etc. inside <literal>OPTIONS_GHC</literal>.</para>
 
       maintains internally, so you'll be desperately disappointed if
       you try to glob etc. inside <literal>OPTIONS_GHC</literal>.</para>
 

-      <para>NOTE: the contents of OPTIONS_GHC are prepended to the
-      command-line options, so you <emphasis>do</emphasis> have the
-      ability to override OPTIONS_GHC settings via the command
-      line.</para>
+      <para>NOTE: the contents of OPTIONS_GHC are appended to the
+      command-line options, so options given in the source file
+      override those given on the command-line.</para>

 
       <para>It is not recommended to move all the contents of your
       Makefiles into your source files, but in some circumstances, the
 
       <para>It is not recommended to move all the contents of your
       Makefiles into your source files, but in some circumstances, the

@@ -343,6 +342,44 @@ module X where
       <varlistentry>
        <term>
           <cmdsynopsis>
       <varlistentry>
        <term>
           <cmdsynopsis>

+            <command>ghc --show-iface <replaceable>file</replaceable></command>
+          </cmdsynopsis>
+          <indexterm><primary><option>&ndash;&ndash;--show-iface</option></primary></indexterm>
+        </term>
+       <listitem>
+             <para>Read the interface in
+             <replaceable>file</replaceable> and dump it as text to
+             <literal>stdout</literal>. For example <literal>ghc --show-iface M.hi</literal>.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+          <cmdsynopsis>
+            <command>ghc --supported-languages</command>
+          </cmdsynopsis>
+          <indexterm><primary><option>&ndash;&ndash;supported-languages</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Print the supported language extensions.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+          <cmdsynopsis>
+            <command>ghc --info</command>
+          </cmdsynopsis>
+          <indexterm><primary><option>&ndash;&ndash;info</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Print information about the compiler.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+          <cmdsynopsis>

             <command>ghc --version</command>
             <command>ghc -V</command>
           </cmdsynopsis>
             <command>ghc --version</command>
             <command>ghc -V</command>
           </cmdsynopsis>

@@ -601,7 +638,7 @@ ghc -c Foo.hs</screen>
        <title>Overriding the default behaviour for a file</title>
 
        <para>As described above, the way in which a file is processed by GHC
        <title>Overriding the default behaviour for a file</title>
 
        <para>As described above, the way in which a file is processed by GHC

-         depends on its suffix.  This behaviour can be overriden using the
+         depends on its suffix.  This behaviour can be overridden using the

          <option>-x</option> option:</para>
 
        <variablelist>
          <option>-x</option> option:</para>
 
        <variablelist>

@@ -860,6 +897,16 @@ ghc -c Foo.hs</screen>
        </listitem>
       </varlistentry>
 
        </listitem>
       </varlistentry>
 

+      <varlistentry>
+       <term><option>-Wwarn</option>:</term>
+       <listitem>
+         <indexterm><primary><option>-Wwarn</option></primary></indexterm>
+         <para>Warnings are treated only as warnings, not as errors. This is
+           the default, but can be useful to negate a
+        <option>-Werror</option> flag.</para>
+       </listitem>
+      </varlistentry>
+

     </variablelist>
 
     <para>The full set of warning options is described below.  To turn
     </variablelist>
 
     <para>The full set of warning options is described below.  To turn

@@ -1083,7 +1130,7 @@ f foo = foo { x = 6 }
          
          <para>This option causes a warning to be emitted whenever the 
            module contains an "orphan" instance declaration or rewrite rule.
          
          <para>This option causes a warning to be emitted whenever the 
            module contains an "orphan" instance declaration or rewrite rule.

-           An instance declartion is an orphan if it appears in a module in
+           An instance declaration is an orphan if it appears in a module in

            which neither the class nor the type being instanced are declared
            in the same module.  A rule is an orphan if it is a rule for a
            function declared in another module.  A module containing any
            which neither the class nor the type being instanced are declared
            in the same module.  A rule is an orphan if it is a rule for a
            function declared in another module.  A module containing any

@@ -1475,15 +1522,31 @@ f "2"    = 2
 
        <varlistentry>
          <term>
 
        <varlistentry>
          <term>

-            <option>-fno-state-hack</option>
-            <indexterm><primary><option>-fno-state-hack</option></primary></indexterm>
+            <option>-fspec-constr</option>
+            <indexterm><primary><option>-fspec-constr</option></primary></indexterm>

           </term>
          <listitem>
           </term>
          <listitem>

-           <para>Turn off the "state hack" whereby any lambda with a
-             <literal>State#</literal> token as argument is considered to be
-             single-entry, hence it is considered OK to inline things inside
-             it.  This can improve performance of IO and ST monad code, but it
-           runs the risk of reducing sharing.</para> 
+           <para>Turn on call-pattern specialisation.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term>
+            <option>-fliberate-case</option>
+            <indexterm><primary><option>-fliberate-case</option></primary></indexterm>
+          </term>
+         <listitem>
+           <para>Turn on the liberate-case transformation.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term>
+            <option>-fstatic-argument-transformation</option>
+            <indexterm><primary><option>-fstatic-argument-transformation</option></primary></indexterm>
+          </term>
+         <listitem>
+           <para>Turn on the static argument transformation.</para>

          </listitem>
        </varlistentry>
 
          </listitem>
        </varlistentry>
 

@@ -1555,24 +1618,6 @@ f "2"    = 2
 
        <varlistentry>
          <term>
 
        <varlistentry>
          <term>

-            <option>-funfolding-update-in-place=<replaceable>n</replaceable></option>
-            <indexterm><primary><option>-funfolding-update-in-place</option></primary></indexterm>
-          </term>
-         <listitem>
-           <para>Switches on an experimental "optimisation".
-            Switching it on makes the compiler a little keener to
-            inline a function that returns a constructor, if the
-            context is that of a thunk.
-<programlisting>
-   x = plusInt a b
-</programlisting>
-            If we inlined plusInt we might get an opportunity to use
-            update-in-place for the thunk 'x'.</para>
-         </listitem>
-       </varlistentry>
-
-       <varlistentry>
-         <term>

             <option>-funfolding-creation-threshold=<replaceable>n</replaceable></option>:
            <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
            <indexterm><primary>inlining, controlling</primary></indexterm>
             <option>-funfolding-creation-threshold=<replaceable>n</replaceable></option>:
            <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
            <indexterm><primary>inlining, controlling</primary></indexterm>

@@ -1675,7 +1720,7 @@ f "2"    = 2
       is also possible to obtain performance improvements with parallelism
       on programs that do not use concurrency.  This section describes how to
       use GHC to compile and run parallel programs, in <xref
       is also possible to obtain performance improvements with parallelism
       on programs that do not use concurrency.  This section describes how to
       use GHC to compile and run parallel programs, in <xref

-       linkend="lang-parallel" /> we desribe the language features that affect
+       linkend="lang-parallel" /> we describe the language features that affect

     parallelism.</para>
     
     <sect2 id="parallel-options">
     parallelism.</para>
     
     <sect2 id="parallel-options">

@@ -1777,16 +1822,15 @@ statements or clauses.
   <indexterm><primary>intermediate code generation</primary></indexterm>
 
   <para>GHC can dump its optimized intermediate code (said to be in &ldquo;Core&rdquo; format) 
   <indexterm><primary>intermediate code generation</primary></indexterm>
 
   <para>GHC can dump its optimized intermediate code (said to be in &ldquo;Core&rdquo; format) 

-  to a file as a side-effect of compilation. Core files, which are given the suffix
-  <filename>.hcr</filename>, can be read and processed by non-GHC back-end
-  tools.  The Core format is formally described in <ulink url="http://www.haskell.org/ghc/docs/papers/core.ps.gz">
+  to a file as a side-effect of compilation. Non-GHC back-end tools can read and process Core files; these files have the suffix
+  <filename>.hcr</filename>. The Core format is described in <ulink url="http://www.haskell.org/ghc/docs/papers/core.ps.gz">

   <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>, 
   <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>, 

-  and sample tools (in Haskell)
-  for manipulating Core files are available in the GHC source distribution 
-  directory <literal>/fptools/ghc/utils/ext-core</literal>.  
+  and sample tools
+  for manipulating Core files (in Haskell) are in the GHC source distribution 
+  directory under <literal>utils/ext-core</literal>.  

   Note that the format of <literal>.hcr</literal> 
   Note that the format of <literal>.hcr</literal> 

-  files is <emphasis>different</emphasis> (though similar) to the Core output format generated 
-  for debugging purposes (<xref linkend="options-debugging"/>).</para>
+  files is <emphasis>different</emphasis> from the Core output format that GHC generates 
+  for debugging purposes (<xref linkend="options-debugging"/>), though the two formats appear somewhat similar.</para>

 
   <para>The Core format natively supports notes which you can add to
   your source code using the <literal>CORE</literal> pragma (see <xref
 
   <para>The Core format natively supports notes which you can add to
   your source code using the <literal>CORE</literal> pragma (see <xref

@@ -1806,10 +1850,8 @@ statements or clauses.
 
     </variablelist>
 
 
     </variablelist>
 

-<para>GHC can also read in External Core files as source; just give the <literal>.hcr</literal> file on
-the command line, instead of the <literal>.hs</literal> or <literal>.lhs</literal> Haskell source.
-A current infelicity is that you need to give the <literal>-fglasgow-exts</literal> flag too, because
-ordinary Haskell 98, when translated to External Core, uses things like rank-2 types.</para>
+<para>Currently (as of version 6.8.2), GHC does not have the ability to read in External Core files as source. If you would like GHC to have this ability, please <ulink url="http://hackage.haskell.org/trac/ghc/wiki/MailingListsAndIRC">make your wishes known to the GHC Team</ulink>.</para>
+

 </sect1>
 
 &debug;
 </sect1>
 
 &debug;