From: simonmar <unknown>
Date: Tue, 5 Oct 2004 13:56:32 +0000 (+0000)
Subject: [project @ 2004-10-05 13:56:31 by simonmar]
X-Git-Tag: Initial_conversion_from_CVS_complete~1530
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=beeecedc85ef566031cc49ae7a370ab44f83bbbd;p=ghc-hetmet.git

[project @ 2004-10-05 13:56:31 by simonmar]
Document -ferror-spans
---

diff --git a/ghc/docs/users_guide/flags.xml b/ghc/docs/users_guide/flags.xml
index 9c0fa29..fb215c7 100644
--- a/ghc/docs/users_guide/flags.xml
+++ b/ghc/docs/users_guide/flags.xml
@@ -69,6 +69,12 @@
 	      <entry>static</entry>
 	      <entry>-</entry>
 	    </row>
+	    <row>
+	      <entry><option>-ferror-spans</option></entry>
+	      <entry>output full span in error messages</entry>
+	      <entry>static</entry>
+	      <entry>-</entry>
+	    </row>
 	  </tbody>
 	</tgroup>
       </informaltable>
diff --git a/ghc/docs/users_guide/using.xml b/ghc/docs/users_guide/using.xml
index f9a9fce..ffe639c 100644
--- a/ghc/docs/users_guide/using.xml
+++ b/ghc/docs/users_guide/using.xml
@@ -660,6 +660,39 @@ ghc -c Foo.hs</screen>
 	</listitem>
       </varlistentry>
 
+      <varlistentry>
+	<term><option>-ferror-spans</option>
+          <indexterm><primary><option>-ferror-spans</option></primary>
+	  </indexterm>
+        </term>
+	<listitem>
+	  <para>Causes GHC to emit the full source span of the
+	  syntactic entity relating to an error message.  Normally, GHC
+	  emits the source location of the start of the syntactic
+	  entity only.</para>
+
+	  <para>For example:</para>
+
+<screen>test.hs:3:6: parse error on input `where'</screen>
+
+	  <para>becomes:</para>
+
+<screen>test296.hs:3:6-10: parse error on input `where'</screen>
+
+	  <para>And multi-line spans are possible too:</para>
+
+<screen>test.hs:(5,4)-(6,7):
+    Conflicting definitions for `a'
+    Bound at: test.hs:5:4
+              test.hs:6:7
+    In the binding group for: a, b, a</screen>
+
+	  <para>Note that line numbers start counting at one, but
+	  column numbers start at zero.  This choice was made to
+	  follow existing convention (i.e. this is how Emacs does
+	  it).</para>
+	</listitem>
+      </varlistentry>
     </variablelist>
   </sect1>
 
@@ -1790,7 +1823,7 @@ ordinary Haskell 98, when translated to External Core, uses things like rank-2 t
 
 <!-- Emacs stuff:
      ;;; Local Variables: ***
-     ;;; mode: xml ***
+     ;;; mode: sgml ***
      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***
      ;;; End: ***
  -->