From: simonmar <unknown>
Date: Thu, 12 Jan 2006 10:04:36 +0000 (+0000)
Subject: [project @ 2006-01-12 10:04:36 by simonmar]
X-Git-Tag: final_switch_to_darcs,_this_repo_is_now_live~32
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=c6b2930d3f7d91217a634bd592d184e383598e67;p=ghc-hetmet.git

[project @ 2006-01-12 10:04:36 by simonmar]
Document that source files are ASCII or UTF-8
---

diff --git a/ghc/docs/users_guide/separate_compilation.xml b/ghc/docs/users_guide/separate_compilation.xml
index 21490b1..c33ff21 100644
--- a/ghc/docs/users_guide/separate_compilation.xml
+++ b/ghc/docs/users_guide/separate_compilation.xml
@@ -30,16 +30,30 @@
     <sect2 id="source-files">
       <title>Haskell source files</title>
 
+      <indexterm><primary>filenames</primary></indexterm>
+
       <para>Each Haskell source module should be placed in a file on
       its own.</para>
 
-      <para>The file should usually be named after the module name, by
+      <para>Usually, the file should be named after the module name,
       replacing dots in the module name by directory separators.  For
       example, on a Unix system, the module <literal>A.B.C</literal>
       should be placed in the file <literal>A/B/C.hs</literal>,
-      relative to some base directory.  GHC's behaviour if this rule
-      is not followed is fully defined by the following section (<xref
-      linkend="output-files"/>).</para>
+      relative to some base directory.  If the module is not going to
+      be imported by another module (<literal>Main</literal>, for
+      example), then you are free to use any filename for it.</para>
+
+      <indexterm><primary>unicode</primary></indexterm>
+
+      <para> GHC assumes that source files are
+      ASCII<indexterm><primary>ASCII</primary></indexterm> or
+      UTF-8<indexterm><primary>UTF-8</primary></indexterm> only, other
+      encodings<indexterm><primary>encoding</primary></indexterm> are
+      not recognised.  However, invalid UTF-8 sequences will be
+      ignored in comments, so it is possible to use other encodings
+      such as
+      Latin-1<indexterm><primary>Latin-1</primary></indexterm>, as
+      long as the non-comment source code is ASCII only.</para>
     </sect2>
 
     <sect2 id="output-files">
diff --git a/ghc/docs/users_guide/using.xml b/ghc/docs/users_guide/using.xml
index 32c194a..8cbcd35 100644
--- a/ghc/docs/users_guide/using.xml
+++ b/ghc/docs/users_guide/using.xml
@@ -153,19 +153,19 @@ module X where
     <variablelist>
 
       <varlistentry>
-	<term>
-          <filename>.lhs</filename>
-          <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
-	</term>
+	<term><filename>.hs</filename></term>
 	<listitem>
-	  <para>A &ldquo;literate Haskell&rdquo; module.</para>
+	  <para>A Haskell module.</para>
 	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term><filename>.hs</filename></term>
+	<term>
+          <filename>.lhs</filename>
+          <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
+	</term>
 	<listitem>
-	  <para>A not-so-literate Haskell module.</para>
+	  <para>A &ldquo;literate Haskell&rdquo; module.</para>
 	</listitem>
       </varlistentry>
 
@@ -368,7 +368,7 @@ ghc &ndash;&ndash;make Main.hs
 	  file.</para>
 	</listitem>
 	<listitem>
-	  <para>You don't have to write a<literal>Makefile</literal>.</para>
+	  <para>You don't have to write a <literal>Makefile</literal>.</para>
           <indexterm><primary><literal>Makefile</literal>s</primary><secondary>avoiding</secondary></indexterm>
 	</listitem>
 	<listitem>