[project @ 2001-03-29 00:01:18 by qrczak]

[ghc-hetmet.git] / ghc / docs / users_guide / utils.sgml

diff --git a/ghc/docs/users_guide/utils.sgml b/ghc/docs/users_guide/utils.sgml
index fa4491d..ae50391 100644 (file)
--- a/ghc/docs/users_guide/utils.sgml
+++ b/ghc/docs/users_guide/utils.sgml
@@ -201,21 +201,21 @@ tags:
       </variablelist>
 
       <para>The input file should end with .hsc. Output files get
-      names with the <literal>.hsc</literal> suffix replaced:</para>
+      names with the <literal>*.hsc</literal> pattern replaced:</para>
 
       <informaltable>
        <tgroup cols=2>
          <tbody>
            <row>
-             <entry><literal>.hs</literal></entry>
+             <entry><literal>*.hs</literal></entry>
              <entry>Haskell file</entry>
            </row>
            <row>
-             <entry><literal>.hs.h</literal></entry>
+             <entry><literal>Hs*.h</literal></entry>
              <entry>C header</entry>
            </row>
            <row>
-             <entry><literal>.hs.c</literal></entry>
+             <entry><literal>Hs*.c</literal></entry>
              <entry>C file</entry>
            </row>
          </tbody>
@@ -229,21 +229,28 @@ tags:
     </sect2>
     <sect2><title>Input syntax</title>
 
-      <para>All special processing is triggered by the
-      <literal>#</literal> character placed outside Haskell comments
-      and string literals. To output a literal <literal>#</literal>,
-      write it twice: <literal>##</literal>.</para>
-
-      <para>Otherwise <literal>#</literal> is followed by optional
-      spaces and tabs, an alphanumeric key that describes the
-      kind of processing, and its arguments. Arguments look
-      like C expressions separated by commas and extend up to the
-      nearest unmatched <literal>)</literal>, <literal>]</literal>,
-      or <literal>}</literal>, or to the end of line outside any
-      <literal>() [] {} '' "" /* */</literal>. Any character may be
-      preceded by a backslash and will not be treated specially.</para>
-
-      <para>Meanings of specific keys:</para>
+      <para>All special processing is triggered by
+      the <literal>#</literal> operator. To output
+      a literal <literal>#</literal>, write it twice:
+      <literal>##</literal>. Inside string literals and comments
+      <literal>#</literal> characters are not processed.</para>
+
+      <para>A <literal>#</literal> is followed by optional
+      spaces and tabs, an alphanumeric keyword that describes
+      the kind of processing, and its arguments. Arguments look
+      like C expressions separated by commas (they are not
+      written inside parens).  They extend up to the nearest
+      unmatched <literal>)</literal>, <literal>]</literal> or
+      <literal>}</literal>, or to the end of line if it occurs outside
+      any <literal>() [] {} '' "" /**/</literal> and is not preceded
+      by a backslash. Backslash-newline pairs are stripped.</para>
+
+      <para>In addition <literal>#{stuff}</literal> is equivalent
+      to <literal>#stuff</literal> except that it's self-delimited
+      and thus needs not to be placed at the end of line or in some
+      brackets.</para>
+
+      <para>Meanings of specific keywords:</para>
 
       <variablelist>
 
@@ -311,6 +318,7 @@ tags:
          <term><literal>#else</literal></term>
          <term><literal>#endif</literal></term>
          <term><literal>#error message</literal></term>
+         <term><literal>#warning message</literal></term>
          <listitem>
            <para>Conditional compilation directives are passed
             unmodified to the C program, C file, and C header. Putting
@@ -396,7 +404,7 @@ tags:
            or be empty) applied to the appropriate integer value. You can
            have multiple <literal>#enum</literal> definitions with the same
            <literal>type</literal>; this construct does not emit the type
-           definition itself.
+           definition itself.</para>
          </listitem>
        </varlistentry>
       </variablelist>
@@ -425,7 +433,7 @@ tags:
       macro whose expansion uses other <literal>#let</literal> macros.
       Plain <literal>#let</literal> prepends <literal>hsc_</literal>
       to the macro name and wraps the defininition in a
-      <literal>printf</literal> call.
+      <literal>printf</literal> call.</para>
 
     </sect2>