[project @ 2001-03-06 07:58:43 by simonpj]
[ghc-hetmet.git] / ghc / docs / users_guide / gone_wrong.sgml
index b5910c9..11cb66a 100644 (file)
@@ -220,11 +220,12 @@ please see <XRef LinkEnd="sooner-faster-quicker">).
 </Para>
 
 <Para>
-If your program has no <Function>&lowbar;ccall&lowbar;</Function>s/<Function>&lowbar;casm&lowbar;</Function>s in it, then a crash is
-always a BUG in the GHC system, except in one case: If your program is
-made of several modules, each module must have been compiled after any
-modules on which it depends (unless you use <Filename>.hi-boot</Filename> files, in which
-case these <Emphasis>must</Emphasis> be correct with respect to the module source). 
+If your program has no foreign calls in it, then a crash is always a BUG in
+the GHC system, except in one case: If your program is made of several
+modules, each module must have been compiled after any modules on which it
+depends (unless you use <Filename>.hi-boot</Filename> files, in which case
+these <Emphasis>must</Emphasis> be correct with respect to the module
+source).
 </Para>
 
 <Para>
@@ -247,9 +248,10 @@ changed interface file, before and after, when applicable.
 </Para>
 
 <Para>
-If you are using <Command>make</Command>, a useful tool to make sure that every module
-<Emphasis>is</Emphasis> up-to-date with respect to its imported interfaces is
-<Command>mkdependHS</Command> (which comes with GHC).  Please see <XRef LinkEnd="mkdependHS">.
+If you are using <Command>make</Command>, GHC can automatically
+generate the dependencies required in order to make sure that every
+module <Emphasis>is</Emphasis> up-to-date with respect to its imported
+interfaces.  Please see <XRef LinkEnd="sec-makefile-dependencies">.
 </Para>
 
 <Para>
@@ -270,7 +272,7 @@ So, before you report a bug because of a core dump, you should probably:
 </Para>
 
 <Para>
-Of course, if you have <Function>&lowbar;ccall&lowbar;</Function>s/<Function>&lowbar;casm&lowbar;</Function>s in your program then all
+Of course, if you have foreign calls in your program then all
 bets are off, because you can trash the heap, the stack, or whatever.
 </Para>
 
@@ -315,7 +317,8 @@ exception (please report it if it does).
 
 <Para>
 Glasgow Haskell is a changing system so there are sure to be bugs in
-it.  Please report them to <Email>glasgow-haskell-bugs@haskell.org</Email>!  (However, please
+it.  Please report them to
+<Email>glasgow-haskell-bugs@haskell.org</Email>!  (However, please
 check the earlier part of this section to be sure it's not a known
 not-really-a problem.)
 </Para>
@@ -331,9 +334,9 @@ Don't omit them because &ldquo;Oh, they won't be interested&hellip;&rdquo;
 <ListItem>
 
 <Para>
- What kind of machine are you running on, and exactly what
-version of the operating system are you using? (<Command>uname -a</Command> or <Command>cat
-/etc/motd</Command> will show the desired information.)
+What kind of machine are you running on, and exactly what version of
+the operating system are you using? (<Command>uname -a</Command> or
+<Command>cat /etc/motd</Command> will show the desired information.)
 
 </Para>
 </ListItem>
@@ -373,8 +376,8 @@ have, etc.
 <ListItem>
 
 <Para>
- If practical, please send enough source files/interface files
-for us to duplicate the problem.
+ If practical, please send enough source files for us to duplicate the
+ problem.
 
 </Para>
 </ListItem>
@@ -434,9 +437,9 @@ it <Emphasis>probably is</Emphasis> a GC bug.
 <ListItem>
 
 <Para>
-If it crashes with the normal
-collector, but not when you force two-space collection (<Option>-F2s</Option>
-runtime flag), then it <Emphasis>probably is</Emphasis> a GC bug.
+If it crashes with the normal collector, but not when you force
+two-space collection (<Option>-G1</Option> runtime flag), then it
+<Emphasis>probably is</Emphasis> a GC bug.
 </Para>
 </ListItem>
 
@@ -445,9 +448,9 @@ runtime flag), then it <Emphasis>probably is</Emphasis> a GC bug.
 </Para>
 
 <Para>
-If it <Emphasis>is</Emphasis> a GC bug, you may be able to avoid it by using a
-particular heap size or by using a <Option>-F2s</Option> runtime flag.  (But don't
-forget to report the bug!!!)
+If it <Emphasis>is</Emphasis> a GC bug, you may be able to avoid it by
+using a particular heap size or by using a <Option>-G1</Option>
+runtime flag.  (But don't forget to report the bug!!!)
 </Para>
 
 <Para>
@@ -457,3 +460,10 @@ ToDo: more here?
 </Sect1>
 
 </Chapter>
+
+<!-- Emacs stuff:
+     ;;; Local Variables: ***
+     ;;; mode: sgml ***
+     ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter") ***
+     ;;; End: ***
+ -->