From: Ian Lynagh Date: Mon, 25 Sep 2006 23:18:55 +0000 (+0000) Subject: Various documentation improvements suggested by Bulat Ziganshin X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=bebf54b1fefef0c337955ec1e653b44f4ec63d10 Various documentation improvements suggested by Bulat Ziganshin --- diff --git a/docs/users_guide/6.6-notes.xml b/docs/users_guide/6.6-notes.xml index 0e7b12b..6b6df22 100644 --- a/docs/users_guide/6.6-notes.xml +++ b/docs/users_guide/6.6-notes.xml @@ -17,14 +17,6 @@ - GHC's modules are now also bundled into a - ghc package, allowing programs to make use - of GHC as a library. The interface has not yet been properly - designed, so is subject to change. - - - - GHC now handles impredicative polymorphism and there are changes to the way scoped type variables work; see Simon's e-mail @@ -297,10 +289,21 @@ - It is now possible, with the -I RTS flag, - to control the amount of idle time that happens before a major - GC is performed. There is more detail in - . + If the program is idle for a certain amount of time then GHC + will now take the opportunity to do a major garbage collection. + The amount of idle time that is required before that happens + is controlled by the new -I RTS flag. + There is more detail in . + + + + + It is now possible to control the frequency that the RTS clock + ticks at with the new -V RTS flag. This is + normally handled automatically by other flags, but this flag + is needed if you want to increase the resolution of the time + profiler. + For more details see . @@ -311,8 +314,9 @@ - The flag, which makes libraries - smaller, can now be used with and hence + The flag, which when used to compile + libraries means executables using the library will be smaller, + can now be used with and hence can be used by cabal. See for more information. @@ -486,6 +490,7 @@ inline which, provided the RHS is visible to the compiler, forcibly inlines its argument. Otherwise, it acts like id. + For more details, see . @@ -493,6 +498,7 @@ GHC.Exts now provides a function lazy which forces GHC to think that its argument is lazy in its first argument. + For more details, see . @@ -1613,6 +1619,24 @@ + GHC As A Library + + Version number 6.6. + + + The internal modules of GHC are now available as a library, package + name ghc. + The interface has not been designed with use by other programs + in mind, so expect the API to vary radically in future + releases. + + + An introduction to using the library can be found + on the wiki. + + + + Internal changes diff --git a/docs/users_guide/glasgow_exts.xml b/docs/users_guide/glasgow_exts.xml index f8ea3c7..09fd3f5 100644 --- a/docs/users_guide/glasgow_exts.xml +++ b/docs/users_guide/glasgow_exts.xml @@ -3778,9 +3778,9 @@ pattern binding must have the same context. For example, this is fine: -Generalised Algebraic Data Types +Generalised Algebraic Data Types (GADTs) -Generalised Algebraic Data Types (GADTs) generalise ordinary algebraic data types by allowing you +Generalised Algebraic Data Types generalise ordinary algebraic data types by allowing you to give the type signatures of constructors explicitly. For example: data Term a where @@ -3801,7 +3801,12 @@ for these Terms: eval (If b e1 e2) = if eval b then eval e1 else eval e2 eval (Pair e1 e2) = (eval e1, eval e2) -These and many other examples are given in papers by Hongwei Xi, and Tim Sheard. +These and many other examples are given in papers by Hongwei Xi, and +Tim Sheard. There is a longer introduction +on the wiki, +and Ralf Hinze's +Fun with phantom types also has a number of examples. Note that papers +may use different notation to that implemented in GHC. The rest of this section outlines the extensions to GHC that support GADTs. diff --git a/docs/users_guide/phases.xml b/docs/users_guide/phases.xml index 35e74c3..cc9fbfb 100644 --- a/docs/users_guide/phases.xml +++ b/docs/users_guide/phases.xml @@ -725,7 +725,12 @@ $ cat foo.hspp Tell the linker to split the single object file that would normally be generated into multiple object files, one per top-level Haskell function or type in the module. - We use this feature for building GHC's libraries libraries + This only makes sense for libraries, where it means that + executables linked against the library are smaller as they only + link against the object files that they need. However, assembling + all the sections separately is expensive, so this is slower than + compiling normally. + We use this feature for building GHC's libraries (warning: don't use it unless you know what you're doing!).