Sync the UG entries for -Wall, -w etc with reality
[ghc-hetmet.git] / docs / users_guide / using.xml
index f81b1c8..eedc9e1 100644 (file)
@@ -14,7 +14,7 @@
     Options can be specified in three ways:</para>
 
     <sect2>
-      <title>command-line arguments</title>
+      <title>Command-line arguments</title>
       
       <indexterm><primary>structure, command-line</primary></indexterm>
       <indexterm><primary>command-line</primary><secondary>arguments</secondary></indexterm>
@@ -26,9 +26,9 @@
 ghc [argument...]
 </screen>
 
-      <para>command-line arguments are either options or file names.</para>
+      <para>Command-line arguments are either options or file names.</para>
 
-      <para>command-line options begin with <literal>-</literal>.
+      <para>Command-line options begin with <literal>-</literal>.
       They may <emphasis>not</emphasis> be grouped:
       <option>-vO</option> is different from <option>-v -O</option>.
       Options need not precede filenames: e.g., <literal>ghc *.o -o
@@ -40,7 +40,7 @@ ghc [argument...]
     </sect2>
 
     <sect2 id="source-file-options">
-      <title>command line options in source files</title>
+      <title>Command line options in source files</title>
     
       <indexterm><primary>source-file options</primary></indexterm>
 
@@ -81,7 +81,7 @@ module X where
       <para>It is not recommended to move all the contents of your
       Makefiles into your source files, but in some circumstances, the
       <literal>OPTIONS_GHC</literal> pragma is the Right Thing. (If you
-      use <option>-keep-hc-file-too</option> and have OPTION flags in
+      use <option>-keep-hc-file</option> and have OPTION flags in
       your module, the OPTIONS_GHC will get put into the generated .hc
       file).</para>
     </sect2>
@@ -104,8 +104,8 @@ module X where
     <indexterm><primary>mode</primary><secondary>options</secondary>
     </indexterm>
 
-    <para>Each of GHC's command line options is classified as either
-    <firstterm>static</firstterm> or <firstterm>dynamic</firstterm> or
+    <para>Each of GHC's command line options is classified as
+    <firstterm>static</firstterm>, <firstterm>dynamic</firstterm> or
       <firstterm>mode</firstterm>:</para>
 
     <variablelist>
@@ -113,7 +113,7 @@ module X where
        <term>Mode flags</term>
        <listitem>
          <para>For example, <option>--make</option> or <option>-E</option>.
-           There may be only a single mode flag on the command line.  The
+           There may only be a single mode flag on the command line.  The
            available modes are listed in <xref linkend="modes"/>.</para>
        </listitem>
       </varlistentry>
@@ -379,9 +379,9 @@ module X where
          interfaces, and include files (usually something like
          <literal>/usr/local/lib/ghc-5.04</literal> on Unix).  This
          is the value of
-         <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary>
-         </indexterm>in the package configuration file (see <xref
-         linkend="packages"/>).</para>
+         <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary></indexterm>
+      in the package configuration file
+      (see <xref linkend="packages"/>).</para>
        </listitem>
       </varlistentry>
 
@@ -394,7 +394,7 @@ module X where
       
       <para>When given the <option>&ndash;&ndash;make</option> option,
       GHC will build a multi-module Haskell program by following
-      dependencies from a single root module (usually
+      dependencies from one or more root modules (usually just
       <literal>Main</literal>).  For example, if your
       <literal>Main</literal> module is in a file called
       <filename>Main.hs</filename>, you could compile and link the
@@ -408,7 +408,7 @@ ghc &ndash;&ndash;make Main.hs
       names or module names; GHC will figure out all the modules in
       the program by following the imports from these initial modules.
       It will then attempt to compile each module which is out of
-      date, and finally if there is a <literal>Main</literal> module,
+      date, and finally, if there is a <literal>Main</literal> module,
       the program will also be linked into an executable.</para>
 
       <para>The main advantages to using <literal>ghc
@@ -503,7 +503,7 @@ olleh
       
       <para>The first phase to run is determined by each input-file
       suffix, and the last phase is determined by a flag.  If no
-      relevant flag is present, then go all the way through linking.
+      relevant flag is present, then go all the way through to linking.
       This table summarises:</para>
       
       <informaltable>
@@ -595,9 +595,7 @@ ghc -c Foo.hs</screen>
       
       <para>Note: The option <option>-E</option><indexterm><primary>-E
       option</primary></indexterm> runs just the pre-processing passes
-      of the compiler, dumping the result in a file.  Note that this
-      differs from the previous behaviour of dumping the file to
-      standard output.</para>
+      of the compiler, dumping the result in a file.</para>
 
       <sect3 id="overriding-suffixes">
        <title>Overriding the default behaviour for a file</title>
@@ -821,6 +819,7 @@ ghc -c Foo.hs</screen>
          <indexterm><primary>-W option</primary></indexterm>
          <para>Provides the standard warnings plus
          <option>-fwarn-incomplete-patterns</option>,
+         <option>-fwarn-dodgy-imports</option>,
          <option>-fwarn-unused-matches</option>,
          <option>-fwarn-unused-imports</option>, and
          <option>-fwarn-unused-binds</option>.</para>
@@ -828,28 +827,27 @@ ghc -c Foo.hs</screen>
       </varlistentry>
 
       <varlistentry>
-       <term><option>-w</option>:</term>
-       <listitem>
-         <indexterm><primary><option>-w</option></primary></indexterm>
-         <para>Turns off all warnings, including the standard ones.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
        <term><option>-Wall</option>:</term>
        <listitem>
          <indexterm><primary><option>-Wall</option></primary></indexterm>
          <para>Turns on all warning options that indicate potentially
          suspicious code.  The warnings that are
          <emphasis>not</emphasis> enabled by <option>-Wall</option>
-         are:</para>
-          <itemizedlist>
-            <listitem><option>-fwarn-simple-patterns</option></listitem>
-            <listitem><option>-fwarn-tabs</option></listitem>
-            <listitem><option>-fwarn-incomplete-record-updates</option></listitem>
-            <listitem><option>-fwarn-monomorphism-restriction</option></listitem>
-            <listitem><option>-fwarn-implicit-prelude</option></listitem>
-          </itemizedlist>
+         are
+            <option>-fwarn-simple-patterns</option>,
+            <option>-fwarn-tabs</option>,
+            <option>-fwarn-incomplete-record-updates</option>,
+            <option>-fwarn-monomorphism-restriction</option>, and
+            <option>-fwarn-implicit-prelude</option>.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-w</option>:</term>
+       <listitem>
+         <indexterm><primary><option>-w</option></primary></indexterm>
+         <para>Turns off all warnings, including the standard ones and
+      those that <literal>-Wall</literal> doesn't enable.</para>
        </listitem>
       </varlistentry>
 
@@ -1276,7 +1274,7 @@ f "2"    = 2
       <para>Note that higher optimisation levels cause more
       cross-module optimisation to be performed, which can have an
       impact on how much of your program needs to be recompiled when
-      you change something.  This is one reaosn to stick to
+      you change something.  This is one reason to stick to
       no-optimisation when developing code.</para>
 
       <variablelist>