[Pkg-haskell-commits] darcs: policy: First bits of content

[Ian Lynagh]

Sun Jul 25 02:35:07 UTC 2004  Ian Lynagh <igloo at earth.li>
  * First bits of content

    M ./haskell-policy.sgml -3 +86

Sun Jul 25 02:35:07 UTC 2004  Ian Lynagh <igloo at earth.li>
  * First bits of content
diff -rN -u old-policy/haskell-policy.sgml new-policy/haskell-policy.sgml
--- old-policy/haskell-policy.sgml	2010-11-05 15:02:09.771866282 +0000
+++ new-policy/haskell-policy.sgml	2010-11-05 15:02:09.787867128 +0000
@@ -57,10 +57,93 @@
 
     <toc detail="sect">
 
-    <chapt id="foo">
-        <heading>Foo</heading>
+    <chapt id="introduction">
+        <heading>Introduction</heading>
         <p>
-            Foo should bar <em>should</em> baz &should; quux.
+            In this manual we refer to a <em>Haskell compiler</em> when
+            we mean a program that translates Haskell code to an
+            executable program, such as <prgn>ghc</prgn> or
+            <prgn>nhc98</prgn>, and <em>Haskell interpreter</em> when we
+            mean a program that executes Haskell code itself, such as
+            <prgn>ghci</prgn> or <prgn>hugs</prgn>. To refer
+            to something that may be either a Haskell compiler or a
+            Haskell interpreter we use the phrase <em>Haskell
+            implementation</em>.
+        </p>
+
+        <p>
+            We use &may;, &should; and &must; as defined in
+            <prgn>RFC 2119</prgn>.
+        </p>
+    </chapt>
+
+    <chapt id="compilers_and_interpreters">
+        <heading>Compilers and Interpreters</heading>
+        <p>
+            XXX update-alternatives
+            XXX make this a sect
+            All Haskell compilers &should; provide a
+            /usr/bin/haskell-compiler that:
+            <enumlist>
+                <item>
+                    If given an argument <var>x</var><tt>.hs</tt> or
+                    <var>x</var>.lhs is given then that argument is
+                    treated as a Haskell input file to be compiled.
+                </item>
+                <item>
+                    If given an argument <var>x</var><tt>.o</tt> then that
+                    argument is treated as an object file and linked
+                    into the executable.
+                </item>
+                <item>
+                    If given an argument <tt>-c</tt> than the Haskell
+                    input file will be compiled to an object file for
+                    use in a larger program or library. Behaviour is
+                    undefined if fewer or more than one Haskell input
+                    file, or any object files, are given as arguments.
+                </item>
+                <item>
+                    If given an argument <tt>-o</tt> followed by another
+                    argument <var>x</var> will create the output
+                    program, or object file if <tt>-c</tt> has also been
+                    given, to the filename <var>x</var>.
+                </item>
+                <item>
+                    The arguments <tt>-O0</tt>, <tt>-O1</tt>,
+                    <tt>-O2</tt>, <tt>-O3</tt>, <tt>-O4</tt>,
+                    <tt>-O</tt> and <tt>-Os</tt> will not change the
+                    behaviour other than to potentially affect the
+                    performance of the resulting code.
+                </item>
+                <item>
+                    The argument <tt>-Wall</tt> will not change the
+                    behaviour other than to potentially alter what
+                    warnings are given by the compiler during
+                    compilation.
+                </item>
+            </enumlist>
+            Behaviour is additionally undefined if:
+            <enumlist>
+                <item>
+                    Any other arguments are given.
+                </item>
+                <item>
+                    No Haskell source files or object files are given as
+                    arguments.
+                </item>
+            </enumlist>
+        </p>
+
+        <p>
+            Register with haskell-utils XXX
+        </p>
+    </chapt>
+
+    <chapt id="libraries">
+        <heading>Haskell Libraries</heading>
+        <p>
+            Names. Compiler deps. Mention alternate (install time
+            compilation) possibility.
         </p>
     </chapt>
 </book>