From: simonmar Date: Thu, 22 Mar 2001 12:12:23 +0000 (+0000) Subject: [project @ 2001-03-22 12:12:23 by simonmar] X-Git-Tag: Approximately_9120_patches~2341 X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=2947e534cfb45e3eff9f06e8f60d19117da3ac63;p=ghc-hetmet.git [project @ 2001-03-22 12:12:23 by simonmar] Move the bug reporting section earlier, and mention the SourceForge bug tracker. Update the release notes. I think I'm just about done in here... --- diff --git a/ghc/docs/users_guide/5-00-notes.sgml b/ghc/docs/users_guide/5-00-notes.sgml index 2e20572..b1377c3 100644 --- a/ghc/docs/users_guide/5-00-notes.sgml +++ b/ghc/docs/users_guide/5-00-notes.sgml @@ -5,19 +5,103 @@ User-visible compiler changes - GHCi added + GHCi, the new interactive environment on top of GHC, has + been added (). - flag added + New flag added (). - dynamic vs. static options + The native code generator now supports Sparc in addition + to x86. - NCG support for Sparc + We now make it clear which options can be placed in an + OPTIONS pragma. See . - hsc2hs added + no longer implies + . + + + is no more. + + + and are no more. + + + The concept of “packages” has been + generalised and extended. Packages may be installed or + removed from an existing GHC installation using the new + ghc-pkg tool. See . + + + Initial unicode support: the Char + type is now 31 bits. We don't yet have support for unicode + I/O. + + + now takes an optional numeric + argument indicating the level of verbosity (). has + been removed. + + + Parallel list comprehensions added. + + + Profiling: please use + {-# SCC ".." #-} + rather than _scc_ "...". The latter + will be phased out in due course. + + + A new experimental optimisation, SpecConstr, is turned + on with -O2. + + + Please report bugs using the SourceForge bug + tracker instead of + glasgow-haskell-bugs@haskell.org if + possible. + + + Documentation changes: there's now a useful Flag + Reference section, see . + + + Many, many, bugfixes. + + + + + + New experimental features + + + + A “front panel” for GHC-compiled programs + displays real-time graphs of memory behaviour in a GTK+ + window. You need to recompile the RTS with front panel + support to use this. + + + + + + FFI changes + + + hsc2hs added (). + + + FFI libraries have been updated to the latest proposal + from the FFI task force. Too many changes to list here, see + the docs: . @@ -26,7 +110,43 @@ User-visible library changes - FFI libraries enhanced, lots of deprecations. + putMVar now blocks if the + MVar is already full. The + PutFullMVar exception no longer exists. A + non-blocking version of putMVar, + tryPutMVar, has been added (). + + + The Integer type now has an instance + of Bits (). + + + Package hssource has been added. It + contains a Haskell 98 abstract syntax, parser, lexer and pretty + printer. No documentation yet. + + + + + + Build system changes + + + + The WithGhcHc setting in + build.mk has been replaced by the + --with-ghc=ghc + option to configure. The new option + must be used if you intend to use + anything except “ghc” to + bootstrap GHC, in order that the build system can figure out + what version of GHC you're using. + + + Source distributions are now made by doing make + distclean in a build tree, instead of requiring a + linked build tree. @@ -35,10 +155,18 @@ Internal changes + Many internal compiler changes: too many to list + here. + + The old perl driver has been removed and replaced by a driver in the compiler proper. + We now use GMP 3 instead of GMP 2 for + arbitrary-precision integer support. + + Several libraries rewritten to use the FFI. diff --git a/ghc/docs/users_guide/gone_wrong.sgml b/ghc/docs/users_guide/gone_wrong.sgml index 11cb66a..e36d13c 100644 --- a/ghc/docs/users_guide/gone_wrong.sgml +++ b/ghc/docs/users_guide/gone_wrong.sgml @@ -8,9 +8,10 @@ If you still have a problem after consulting this section, then you -may have found a bug—please report it! See for a -list of things we'd like to know about your bug. If in doubt, send a -report—we love mail from irate users :-! +may have found a bug—please report it! See + for details on how to report a bug and +a list of things we'd like to know about your bug. If in doubt, send +a report—we love mail from irate users :-! @@ -153,28 +154,7 @@ proper dependency order. - -“What's a `consistency error'?” - - -(These are reported just after linking your program.) - - -You tried to link incompatible object files, e.g., normal ones -(registerised, Appel garbage-collector) with profiling ones (two-space -collector). Or those compiled by a previous version of GHC -with an incompatible newer version. - - - -If you run nm -o *.o | egrep 't (cc|hsc)\.' (or, on -unregisterised files: what *.o), you'll see all the consistency -tags/strings in your object files. They must all be the same! -(ToDo: tell you what they mean…) - - - “Is this line number right?” @@ -286,7 +266,8 @@ GHC-compiled program, please see . “My program entered an `absent' argument.” -This is definitely caused by a bug in GHC. Please report it. +This is definitely caused by a bug in GHC. Please report it (see ). @@ -307,96 +288,6 @@ exception (please report it if it does). - -How to report a bug in the GHC system - - - -bug reports - - - -Glasgow Haskell is a changing system so there are sure to be bugs in -it. Please report them to -glasgow-haskell-bugs@haskell.org! (However, please -check the earlier part of this section to be sure it's not a known -not-really-a problem.) - - - -The name of the bug-reporting game is: facts, facts, facts. -Don't omit them because “Oh, they won't be interested…” - - - - - - - - -What kind of machine are you running on, and exactly what version of -the operating system are you using? (uname -a or -cat /etc/motd will show the desired information.) - - - - - - - What version of GCC are you using? gcc -v will tell you. - - - - - - - Run the sequence of compiles/runs that caused the offending -behaviour, capturing all the input/output in a “script” (a UNIX -command) or in an Emacs shell window. We'd prefer to see the whole -thing. - - - - - - - Be sure any Haskell compilations are run with a (verbose) -flag, so we can see exactly what was run, what versions of things you -have, etc. - - - - - - - What is the program behaviour that is wrong, in your opinion? - - - - - - - If practical, please send enough source files for us to duplicate the - problem. - - - - - - - If you are a Hero and track down the problem in the -compilation-system sources, please send us patches relative to a known -released version of GHC, or whole files if you prefer. - - - - - - - - - - Hard-core debugging of GHC-compiled programs @@ -407,7 +298,7 @@ released version of GHC, or whole files if you prefer. If your program is crashing, you should almost surely file a bug -report, as outlined in previous sections. +report, as outlined in . diff --git a/ghc/docs/users_guide/intro.sgml b/ghc/docs/users_guide/intro.sgml index 175a5e9..0162421 100644 --- a/ghc/docs/users_guide/intro.sgml +++ b/ghc/docs/users_guide/intro.sgml @@ -212,6 +212,87 @@ + + Reporting bugs in GHC + bugsreporting + + reporting bugs + + + Glasgow Haskell is a changing system so there are sure to be + bugs in it. + + To repot a bug, either: + + + + Go to the SoureForge GHC + page, go to the bugs section, click on + submit, and enter your bug report. You can also + check the outstanding bugs here to make sure it hasn't already + been reported. Or: + + + Email your bug report to + glasgow-haskell-bugs@haskell.org. + + + + + What to put in a bug report + bug reportscontents + + The name of the bug-reporting game is: facts, facts, + facts. Don't omit them because “Oh, they won't be + interested…” + + + + What kind of machine are you running on, and exactly + what version of the operating system are you using? + (on a Unix system, uname -a or cat + /etc/motd will show the desired information.) + + + + What version of GCC are you using? gcc + -v will tell you. + + + + Run the sequence of compiles/runs that caused the + offending behaviour, capturing all the input/output in a + “script” (a UNIX command) or in an Emacs shell + window. We'd prefer to see the whole thing. + + + + Be sure any Haskell compilations are run with a + (verbose) flag, so we can see exactly + what was run, what versions of things you have, etc. + + + + What is the program behaviour that is wrong, in your + opinion? + + + + If practical, please send enough source files for us + to duplicate the problem. + + + + If you are a Hero and track down the problem in the + compilation-system sources, please send us patches relative + to a known released version of GHC, or whole files if you + prefer. + + + + + GHC version numbering policy version, of ghc diff --git a/ghc/docs/users_guide/using.sgml b/ghc/docs/users_guide/using.sgml index e28ae9c..3989d72 100644 --- a/ghc/docs/users_guide/using.sgml +++ b/ghc/docs/users_guide/using.sgml @@ -1542,10 +1542,10 @@ which you can then display. For example, to run your program - ./a.out +RTS -qP -qp8 - grs2gr *.???.gr > temp.gr # combine the 8 .gr files into one - gr2ps -O temp.gr # cvt to .ps; output in temp.ps - ghostview -seascape temp.ps # look at it! +$ ./a.out +RTS -qP -qp8 +$ grs2gr *.???.gr > temp.gr # combine the 8 .gr files into one +$ gr2ps -O temp.gr # cvt to .ps; output in temp.ps +$ ghostview -seascape temp.ps # look at it! @@ -1654,7 +1654,7 @@ translates to 4K bytes, and for 64-bit machines, 8K bytes.) -