New syntax for GADT-style record declarations, and associated refactoring
[ghc-hetmet.git] / docs / users_guide / intro.xml
index 7216942..c9ff433 100644 (file)
   call-graph like structure.  See <xref linkend="profiling"/> for more
   details.</para>
 
-  <para>GHC comes with a large collection of libraries, with
-  everything from parser combinators to networking.  The libraries are
+  <para>GHC comes with a number of libraries. These are
   described in separate documentation.</para>
 
+  <sect1 id="getting">
+    <title>Obtaining GHC</title>
+
+    <para>Go to the <ulink url="http://www.haskell.org/ghc/">GHC home
+       page</ulink> and follow the "download" link to download GHC
+       for your platform.</para>
+
+    <para>Alternatively, if you want to build GHC yourself, head on
+      over to the
+      <ulink url="http://hackage.haskell.org/trac/ghc/wiki/Building">GHC
+        Building Guide</ulink> to find out how to get the sources, and
+        build it on your system.  Note that GHC itself is written in
+        Haskell, so you will still need to install GHC in order to
+        build it.</para>
+  </sect1>
+
   <sect1 id="mailing-lists-GHC">
     <title>Meta-information: Web sites, mailing lists, etc.</title>
 
 
     <itemizedlist>
       <listitem>
-       <para><ulink url="http://www.haskell.org/" >Haskell home
-       page</ulink></para>
-      </listitem>
-
-      <listitem>
        <para><ulink url="http://www.haskell.org/ghc/">GHC home
        page</ulink></para>
       </listitem>
 
       <listitem>
-       <para><ulink
-       url="http://www.cs.nott.ac.uk/~gmh/faq.html">comp.lang.functional
-       FAQ</ulink></para>
+       <para><ulink url="http://hackage.haskell.org/trac/ghc/">GHC
+       Developers Home</ulink> (developer documentation, wiki, and
+       bug tracker)</para>
       </listitem>
-
     </itemizedlist>
 
-    <para>We run the following mailing lists about Glasgow Haskell.
+    <para>We run the following mailing lists about GHC.
     We encourage you to join, as you feel is appropriate.</para>
 
     <variablelist>
@@ -83,7 +92,7 @@
          <para>This list is for GHC users to chat among themselves.
          If you have a specific question about GHC, please check the
          <ulink
-         url="http://hackage.haskell.org/trac/ghc/wiki/FAQ">FAQ</ulink>
+         url="http://www.haskell.org/haskellwiki/GHC/FAQ">FAQ</ulink>
          first.</para>
 
          <variablelist>
       <varlistentry>
        <term>glasgow-haskell-bugs:</term>
        <listitem>
-         <para>Send bug reports for GHC to this address!  The sad and
-          lonely people who subscribe to this list will muse upon
-          what's wrong and what you might do about it.</para>
+         <para>This list is for reporting and discussing GHC bugs.
+           However, please see <xref linkend="bug-reporting" /> before
+           posting here.</para>
 
          <variablelist>
            <varlistentry>
              <term>list archives:</term>
              <listitem>
                <para><ulink
-          url="http://www.haskell.org/pipermail/glasgow-haskell-bugs/"><literal>http://www.haskell.org/pipermail/glasgow-haskell-bugs/</literal></ulink></para>
+                         url="http://www.haskell.org/pipermail/glasgow-haskell-bugs/"><literal>http://www.haskell.org/pipermail/glasgow-haskell-bugs/</literal></ulink></para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
       </varlistentry>
-
+      
       <varlistentry>
        <term>cvs-ghc:</term>
        <listitem>
          <para>The hardcore GHC developers hang out here.  This list
-         also gets commit message from the CVS repository.  There are
-         several other similar lists for other parts of the CVS
-         repository (eg. <literal>cvs-hslibs</literal>,
-         <literal>cvs-happy</literal>, <literal>cvs-hdirect</literal>
-         etc.)</para>
+         also gets commit message from the GHC darcs repository.  There are
+         other lists for other darcs
+         repositories (most notably <literal>cvs-libraries</literal>).
+         </para>
          
          <variablelist>
            <varlistentry>
     <indexterm><primary>reporting bugs</primary>
     </indexterm>
 
-    <para>Glasgow Haskell is a changing system so there are sure to be
-    bugs in it. </para>
-
-    <para>To report a bug, either:</para>
-
-    <itemizedlist>
-      <listitem>
-       <para>Preferred: <ulink
-    url="http://hackage.haskell.org/trac/ghc/newticket?type=bug">Create
-    a new bug</ulink>, and enter your bug report.  You can also
-    search the bug database here to make sure your bug hasn't already
-    been reported (if it has, it might still help to add information
-    from your experience to the existing report).</para>
-      </listitem>
-      <listitem>
-       <para>Bug reports can also be emailed to
-    <email>glasgow-haskell-bugs@haskell.org</email>. </para>
-      </listitem>
-    </itemizedlist>
-
-    <sect2>
-      <title>How do I tell if I should report my bug?</title>
-
-      <para>Take a look at the <ulink
-      url="http://hackage.haskell.org/trac/ghc/wiki/FAQ">FAQ</ulink> and <xref
-      linkend="wrong"/>, which will give you some guidance as to
-      whether the behaviour you're seeing is really a bug or
-      not.</para>
-
-      <para>If it is a bug, then it might have been reported before:
-      try searching on the <ulink
-      url="http://hackage.haskell.org/trac/ghc">bug tracker</ulink>,
-      and failing that, try <ulink
-      url="http://www.google.com">Google</ulink>.</para>
+    <para>
+        Glasgow Haskell is a changing system so there are sure to be
+        bugs in it. If you find one, please see
+        <ulink url="http://hackage.haskell.org/trac/ghc/wiki/ReportABug">this wiki page</ulink>
+        for information on how to report it.
+    </para>
 
-      <para>If in doubt, just report it.</para>
-    </sect2>
-
-    <sect2>
-      <title>What to put in a bug report</title>
-      <indexterm><primary>bug reports</primary><secondary>contents</secondary></indexterm>
-
-      <para>The name of the bug-reporting game is: facts, facts,
-      facts.  Don't omit them because &ldquo;Oh, they won't be
-      interested&hellip;&rdquo;</para>
-
-      <orderedlist>
-       <listitem>
-         <para>What kind of machine are you running on, and exactly
-          what version of the operating system are you using?  (on a
-          Unix system, <command>uname -a</command> or <command>cat
-          /etc/motd</command> will show the desired information.)  In
-          the bug tracker, this information can be given in the
-          &ldquo;Architecture&rdquo; and &ldquo;Operating
-          system&rdquo; fields.</para>
-       </listitem>
-
-       <listitem>
-         <para>What version of GCC are you using? <command>gcc&nbsp;-v</command> will tell you.</para>
-       </listitem>
-
-       <listitem>
-         <para>Run the sequence of compiles/runs that caused the
-          offending behaviour, cut-and-paste the whole session into
-          the bug report.  We'd prefer to see the whole thing.</para>
-       </listitem>
-
-       <listitem>
-         <para>Add the -v flag when running GHC, so we can see exactly
-          what was run, what versions of things you have, etc.</para>
-       </listitem>
-
-       <listitem>
-         <para>What is the program behaviour that is wrong, in your
-         opinion?</para>
-       </listitem>
-
-       <listitem>
-         <para>If practical, please attach or send enough source
-          files for us to duplicate the problem.</para>
-       </listitem>
-
-       <listitem>
-         <para>If you are a Hero and track down the problem in the
-          compilation-system sources, please send us patches (either
-          <literal>darcs send</literal>, plain patches, or just whole
-          files if you prefer).</para>
-       </listitem>
-      </orderedlist>
-    </sect2>
   </sect1>
 
   <sect1 id="version-numbering">
   </sect1>
 
 
-&relnotes;
+&relnotes1;
 
 </chapter>