X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fusers_guide%2Fghci.xml;h=bde1648d1d1090c1615c125ca7a0e5f8234341e3;hb=e6b66d7de77488cbd1852a86cfe135a07e80616f;hp=7d07f9b4c499b12938587858ef607a70c9a826d7;hpb=9fa5ced11b0955f69773b2bd616441c69c7d1068;p=ghc-hetmet.git

diff --git a/docs/users_guide/ghci.xml b/docs/users_guide/ghci.xml
index 7d07f9b..bde1648 100644
--- a/docs/users_guide/ghci.xml
+++ b/docs/users_guide/ghci.xml
@@ -1017,7 +1017,7 @@ right :: [a]
       <para>The execution continued at the point it previously stopped, and has
         now stopped at the breakpoint for a second time.</para>
 
-      <sect3 id="setting-breakpoings">
+      <sect3 id="setting-breakpoints">
         <title>Setting breakpoints</title>
 
         <para>Breakpoints can be set in various ways.  Perhaps the easiest way to
@@ -1704,16 +1704,6 @@ $ ghci -lm
 
       <varlistentry>
 	<term>
-          <literal>:continue</literal> 
-          <indexterm><primary><literal>:continue</literal></primary></indexterm>
-        </term>
-	<listitem><para>Continue the current evaluation, when stopped at a
-            breakpoint.</para>
-	</listitem>
-      </varlistentry>
-
-      <varlistentry>
-	<term>
           <literal>:cmd</literal> <replaceable>expr</replaceable>
           <indexterm><primary><literal>:cmd</literal></primary></indexterm>
         </term>
@@ -1728,6 +1718,16 @@ $ ghci -lm
 
       <varlistentry>
 	<term>
+          <literal>:continue</literal> 
+          <indexterm><primary><literal>:continue</literal></primary></indexterm>
+        </term>
+	<listitem><para>Continue the current evaluation, when stopped at a
+            breakpoint.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term>
 	  <literal>:ctags</literal> <optional><replaceable>filename</replaceable></optional>
 	  <literal>:etags</literal> <optional><replaceable>filename</replaceable></optional>
 	  <indexterm><primary><literal>:etags</literal></primary>
@@ -1737,7 +1737,8 @@ $ ghci -lm
 	</term>
 	<listitem>
 	  <para>Generates a &ldquo;tags&rdquo; file for Vi-style editors
-	    (<literal>:ctags</literal>) or Emacs-style editors (<literal>etags</literal>).  If
+	    (<literal>:ctags</literal>) or
+        Emacs-style editors (<literal>:etags</literal>).  If
 	    no filename is specified, the defaulit <filename>tags</filename> or
 	    <filename>TAGS</filename> is
 	    used, respectively.  Tags for all the functions, constructors and
@@ -1845,6 +1846,15 @@ Prelude> :. cmds.ghci
 
       <varlistentry>
 	<term>
+          <literal>:etags</literal> 
+        </term>
+	<listitem>
+	  <para>See <literal>:ctags</literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term>
           <literal>:force <replaceable>identifier</replaceable> ...</literal>
           <indexterm><primary><literal>:force</literal></primary></indexterm>
         </term>
@@ -1913,6 +1923,12 @@ Prelude> :. cmds.ghci
 	  will be printed.  If <replaceable>name</replaceable> has
 	  been loaded from a source file, then GHCi will also display
 	  the location of its definition in the source.</para>
+	  <para>For types and classes, GHCi also summarises instances that
+	  mention them.  To avoid showing irrelevant information, an instance
+	  is shown only if (a) its head mentions <replaceable>name</replaceable>, 
+	  and (b) all the other things mentioned in the instance
+	  are in scope (either qualified or otherwise) as a result of 
+	  a <literal>:load</literal> or <literal>:module</literal> commands. </para>
 	</listitem>
       </varlistentry>
 
@@ -1981,7 +1997,7 @@ Prelude> :. cmds.ghci
             However, we cannot simply pass the arguments to the
             <literal>main</literal> function while we are testing in ghci,
             as the <literal>main</literal> function doesn't take its
-            directly.
+            arguments directly.
           </para>
 
           <para>
@@ -2026,7 +2042,7 @@ Prelude> :main foo bar
 	<listitem>
 	  <para>Prints a value without forcing its evaluation.
             <literal>:print</literal> may be used on values whose types are
-            unkonwn or partially known, which might be the case for local
+            unknown or partially known, which might be the case for local
             variables with polymorphic types at a breakpoint.  While inspecting
             the runtime value, <literal>:print</literal> attempts to
             reconstruct the type of the value, and will elaborate the type in
@@ -2046,7 +2062,7 @@ Prelude> :main foo bar
           <indexterm><primary><literal>:quit</literal></primary></indexterm>
         </term>
 	<listitem>
-	  <para>Quits GHCi.  You can also quit by typing a control-D
+	  <para>Quits GHCi.  You can also quit by typing control-D
 	  at the prompt.</para>
 	</listitem>
       </varlistentry>
@@ -2191,7 +2207,7 @@ Prelude> :main foo bar
           <indexterm><primary><literal>:show modules</literal></primary></indexterm>
         </term>
 	<listitem>
-	  <para>Show the list of modules currently load.</para>
+	  <para>Show the list of modules currently loaded.</para>
 	</listitem>
       </varlistentry>
 
@@ -2302,7 +2318,7 @@ Prelude> :main foo bar
 
     <para>The <literal>:set</literal> command sets two types of
     options: GHCi options, which begin with
-    &lsquo;<literal>+</literal>&rdquo; and &ldquo;command-line&rdquo;
+    &lsquo;<literal>+</literal>&rsquo;, and &ldquo;command-line&rdquo;
     options, which begin with &lsquo;-&rsquo;.  </para>
 
     <para>NOTE: at the moment, the <literal>:set</literal> command
@@ -2414,9 +2430,10 @@ Prelude> :set -fno-glasgow-exts
     <indexterm><primary>startup</primary><secondary>files, GHCi</secondary>
     </indexterm>
 
-    <para>When it starts, GHCi always reads and executes commands from
-    <filename>$HOME/.ghci</filename>, followed by
-    <filename>./.ghci</filename>.</para>
+    <para>When it starts, unless the <literal>-ignore-dot-ghci</literal>
+    flag is given, GHCi reads and executes commands from
+    <filename>./.ghci</filename>, followed by
+    <filename>$HOME/.ghci</filename>.</para>
 
     <para>The <filename>.ghci</filename> in your home directory is
     most useful for turning on favourite options (eg. <literal>:set
@@ -2425,7 +2442,7 @@ Prelude> :set -fno-glasgow-exts
     project is a useful way to set certain project-wide options so you
     don't have to type them everytime you start GHCi: eg. if your
     project uses GHC extensions and CPP, and has source files in three
-    subdirectories A B and C, you might put the following lines in
+    subdirectories A, B and C, you might put the following lines in
     <filename>.ghci</filename>:</para>
 
 <screen>
@@ -2573,7 +2590,19 @@ Prelude> :set -fno-glasgow-exts
 	<term>I can't use Control-C to interrupt computations in
           GHCi on Windows.</term>
         <listitem>
-          <para>See <xref linkend="ghci-windows"/></para>
+          <para>See <xref linkend="ghci-windows"/>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term>The default buffering mode is different in GHCi to GHC.</term>
+        <listitem>
+          <para>
+            In GHC, the stdout handle is line-buffered by default.
+            However, in GHCi we turn off the buffering on stdout,
+            because this is normally what you want in an interpreter:
+            output appears as it is generated.
+          </para>
         </listitem>
       </varlistentry>
     </variablelist>