From: panne Date: Sun, 15 Aug 2004 20:38:45 +0000 (+0000) Subject: [project @ 2004-08-15 20:37:22 by panne] X-Git-Tag: Initial_conversion_from_CVS_complete~1737 X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=b9de29ac3fbf5192049a0bcaf1ab0c8bbbd57a83;p=ghc-hetmet.git [project @ 2004-08-15 20:37:22 by panne] Started to convert the users guide to DocBook XML. Not yet finished, there are still *tons* of misplaced indexterms, but some sensible documentation can already be generated. --- diff --git a/ghc/docs/users_guide/5-00-notes.sgml b/ghc/docs/users_guide/5-00-notes.xml similarity index 97% rename from ghc/docs/users_guide/5-00-notes.sgml rename to ghc/docs/users_guide/5-00-notes.xml index a2f1210..2871247 100644 --- a/ghc/docs/users_guide/5-00-notes.sgml +++ b/ghc/docs/users_guide/5-00-notes.xml @@ -1,3 +1,4 @@ + Release notes for version 5.00 (April 2001) @@ -200,7 +201,7 @@ diff --git a/ghc/docs/users_guide/5-02-notes.sgml b/ghc/docs/users_guide/5-02-notes.xml similarity index 86% rename from ghc/docs/users_guide/5-02-notes.sgml rename to ghc/docs/users_guide/5-02-notes.xml index d577841..a8bc83a 100644 --- a/ghc/docs/users_guide/5-02-notes.sgml +++ b/ghc/docs/users_guide/5-02-notes.xml @@ -1,3 +1,4 @@ + Release notes for version 5.04 @@ -50,7 +51,7 @@ diff --git a/ghc/docs/users_guide/5-04-notes.sgml b/ghc/docs/users_guide/5-04-notes.xml similarity index 98% rename from ghc/docs/users_guide/5-04-notes.sgml rename to ghc/docs/users_guide/5-04-notes.xml index 8d28144..76ee728 100644 --- a/ghc/docs/users_guide/5-04-notes.sgml +++ b/ghc/docs/users_guide/5-04-notes.xml @@ -1,3 +1,4 @@ + Release notes for version 5.04 @@ -281,7 +282,7 @@ diff --git a/ghc/docs/users_guide/6.0-notes.sgml b/ghc/docs/users_guide/6.0-notes.xml similarity index 98% rename from ghc/docs/users_guide/6.0-notes.sgml rename to ghc/docs/users_guide/6.0-notes.xml index 1973bfc..341d32f 100644 --- a/ghc/docs/users_guide/6.0-notes.sgml +++ b/ghc/docs/users_guide/6.0-notes.xml @@ -1,3 +1,4 @@ + Release notes for version 6.0 @@ -312,7 +313,7 @@ diff --git a/ghc/docs/users_guide/Makefile b/ghc/docs/users_guide/Makefile index 81b4412..f0a31fb 100644 --- a/ghc/docs/users_guide/Makefile +++ b/ghc/docs/users_guide/Makefile @@ -1,33 +1,7 @@ TOP = ../.. include $(TOP)/mk/boilerplate.mk -SGML_DOC = users_guide -INSTALL_SGML_DOC = users_guide - -# Generating index is semi-automatic, you need to: -# -# make users_guide.dvi ; make index ; make users_guide.dvi -# -# To work, it depends on you tweaking -# -# lib/sgml-tools/dist/sgmltool/latex2e/mapping -# -# to instead of saying -# -# + "\\end{document}" + -# -# say -# -# + "\\InputIfFileExists{index}{}{}" -# "\\end{document}" + -# -# That partially works around the problem, if nothing else. -# -index : users_guide.dvi - makeindex users_guide - @$(RM) $@ - $(CP) users_guide.ind $@ - $(RM) users_guide.dvi - +XML_DOC = users_guide +INSTALL_XML_DOC = users_guide include $(TOP)/mk/target.mk diff --git a/ghc/docs/users_guide/bugs.sgml b/ghc/docs/users_guide/bugs.xml similarity index 96% rename from ghc/docs/users_guide/bugs.sgml rename to ghc/docs/users_guide/bugs.xml index 5d7c0bb..76ab87d 100644 --- a/ghc/docs/users_guide/bugs.sgml +++ b/ghc/docs/users_guide/bugs.xml @@ -1,3 +1,4 @@ + Known bugs and infelicities @@ -157,9 +158,10 @@ checking for duplicates. The reason for this is efficiency, pure and simple. - The Char type - Charsize - of + + The Char type + Charsize of + Following the ISO-10646 standard, maxBound :: Char in GHC is @@ -168,10 +170,10 @@ checking for duplicates. The reason for this is efficiency, pure and simple. - Sized integral types - Intsize of - - + + Sized integral types + Intsize of + In GHC the Int type follows the size of an address on the host architecture; in other words @@ -353,7 +355,7 @@ Loading package javavm ... linking ... WARNING: Overflown relocation field (# re diff --git a/ghc/docs/users_guide/debugging.sgml b/ghc/docs/users_guide/debugging.xml similarity index 99% rename from ghc/docs/users_guide/debugging.sgml rename to ghc/docs/users_guide/debugging.xml index 340d7d8..c5758cc 100644 --- a/ghc/docs/users_guide/debugging.sgml +++ b/ghc/docs/users_guide/debugging.xml @@ -1,3 +1,4 @@ + Debugging the compiler @@ -516,7 +517,7 @@ Main.skip2{-r1L6-} = diff --git a/ghc/docs/users_guide/faq.sgml b/ghc/docs/users_guide/faq.xml similarity index 99% rename from ghc/docs/users_guide/faq.sgml rename to ghc/docs/users_guide/faq.xml index 8618dee..2f1ba40 100644 --- a/ghc/docs/users_guide/faq.sgml +++ b/ghc/docs/users_guide/faq.xml @@ -1,3 +1,4 @@ + GHC FAQ @@ -456,7 +457,7 @@ details. diff --git a/ghc/docs/users_guide/ffi-chap.sgml b/ghc/docs/users_guide/ffi-chap.xml similarity index 99% rename from ghc/docs/users_guide/ffi-chap.sgml rename to ghc/docs/users_guide/ffi-chap.xml index 0783afd..789a6a1 100644 --- a/ghc/docs/users_guide/ffi-chap.sgml +++ b/ghc/docs/users_guide/ffi-chap.xml @@ -1,3 +1,4 @@ + @@ -393,7 +394,7 @@ to be inlined across modules, use the command-line and package-configuration diff --git a/ghc/docs/users_guide/flags.sgml b/ghc/docs/users_guide/flags.xml similarity index 99% rename from ghc/docs/users_guide/flags.sgml rename to ghc/docs/users_guide/flags.xml index 0974350..895e993 100644 --- a/ghc/docs/users_guide/flags.sgml +++ b/ghc/docs/users_guide/flags.xml @@ -1,3 +1,4 @@ + Flag reference @@ -1743,7 +1744,7 @@ Misc: diff --git a/ghc/docs/users_guide/ghci.sgml b/ghc/docs/users_guide/ghci.xml similarity index 90% rename from ghc/docs/users_guide/ghci.sgml rename to ghc/docs/users_guide/ghci.xml index cd82849..374b28c 100644 --- a/ghc/docs/users_guide/ghci.sgml +++ b/ghc/docs/users_guide/ghci.xml @@ -1,3 +1,4 @@ + Using GHCi GHCi @@ -800,9 +801,10 @@ $ ghci -lm - :add - module ... - :add + + :add module ... + :add + Add module(s) to the current target set, and perform a @@ -811,11 +813,10 @@ $ ghci -lm - :browse - *module - ... - :browse - + + :browse *module ... + :browse + Displays the identifiers defined by the module module, which must be either @@ -833,8 +834,10 @@ $ ghci -lm - :cd dir - :cd + + :cd dir + :cd + Changes the current working directory to dir. A @@ -852,8 +855,10 @@ $ ghci -lm - :def name expr - :def + + :def name expr + :def + The command :def name @@ -905,20 +910,24 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :help - :help - :? - :? + + :help + :help + + + :? + :? + Displays a list of the available commands. - :info name - ... - :info - + + :info name ... + :info + Displays information about the given name(s). For example, if name is a class, then @@ -933,9 +942,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :load - module ... - :load + + :load module ... + :load + Recursively loads the specified modules, and all the modules they @@ -971,8 +981,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :module +|- *mod1 ... *modn - :module + + :module +|- *mod1 ... *modn + :module + Sets or modifies the current context for statements typed at the prompt. See for @@ -981,8 +993,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :quit - :quit + + :quit + :quit + Quits GHCi. You can also quit by typing a control-D at the prompt. @@ -990,8 +1004,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :reload - :reload + + :reload + :reload + Attempts to reload the current target set (see :load) if any of the modules in the set, @@ -1002,8 +1018,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :set option... - :set + + :set option... + :set + Sets various options. See for a list of available options. The @@ -1013,9 +1031,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :set args - arg ... - :set + + :set args arg ... + :set + Sets the list of arguments which are returned when the program calls System.getArgsgetArgs @@ -1024,9 +1043,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :set prog - prog - :set + + :set prog prog + :set + Sets the string to be returned when the program calls System.getProgNamegetProgName @@ -1035,8 +1055,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :show bindings - :show bindings + + :show bindings + :show bindings + Show the bindings made at the prompt and their types. @@ -1044,16 +1066,20 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :show modules - :show modules + + :show modules + :show modules + Show the list of modules currently load. - :type expression - :type + + :type expression + :type + Infers and prints the type of expression, including explicit @@ -1064,8 +1090,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :kind type - :kind + + :kind type + :kind + Infers and prints the kind of type. The latter can be an arbitrary @@ -1075,8 +1103,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :undef name - :undef + + :undef name + :undef + Undefines the user-defined command name (see :def @@ -1085,8 +1115,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :unset option... - :unset + + :unset option... + :unset + Unsets certain options. See for a list of available options. @@ -1094,9 +1126,11 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - :! command... - :! - shell commandsin GHCi + + :! command... + :! + shell commandsin GHCi + Executes the shell command command. @@ -1133,10 +1167,12 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - +r - +r - CAFsin GHCi - Constant Applicative FormCAFs + + +r + +r + CAFsin GHCi + Constant Applicative FormCAFs + Normally, any evaluation of top-level expressions (otherwise known as CAFs or Constant Applicative Forms) in @@ -1153,8 +1189,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - +s - +s + + +s + +s + Display some stats after evaluating each expression, including the elapsed time and number of bytes allocated. @@ -1166,8 +1204,10 @@ Prelude> :def make (\_ -> return ":! ghc ––make Main") - +t - +t + + +t + +t + Display the type of each variable bound after a statement is entered at the prompt. If the statement is a @@ -1248,18 +1288,20 @@ Prelude> :set -fno-glasgow-exts - - - + + + + Don't read either ./.ghci or $HOME/.ghci when starting up. - - - + + + + Read .ghci and $HOME/.ghci. This is normally the @@ -1287,9 +1329,10 @@ Prelude> :set -fno-glasgow-exts - -O doesn't work with GHCi! - - + + -O doesn't work with GHCi! + + For technical reasons, the bytecode compiler doesn't interact well with one of the optimisation passes, so we @@ -1353,7 +1396,7 @@ Prelude> :set -fno-glasgow-exts diff --git a/ghc/docs/users_guide/glasgow_exts.sgml b/ghc/docs/users_guide/glasgow_exts.xml similarity index 99% rename from ghc/docs/users_guide/glasgow_exts.sgml rename to ghc/docs/users_guide/glasgow_exts.xml index 5c72af7..beec0c8 100644 --- a/ghc/docs/users_guide/glasgow_exts.sgml +++ b/ghc/docs/users_guide/glasgow_exts.xml @@ -1,3 +1,4 @@ + language, GHC extensions, GHC @@ -5343,8 +5344,8 @@ Just to finish with, here's another example I rather like: diff --git a/ghc/docs/users_guide/gone_wrong.sgml b/ghc/docs/users_guide/gone_wrong.xml similarity index 98% rename from ghc/docs/users_guide/gone_wrong.sgml rename to ghc/docs/users_guide/gone_wrong.xml index d4fc7f9..d31087c 100644 --- a/ghc/docs/users_guide/gone_wrong.sgml +++ b/ghc/docs/users_guide/gone_wrong.xml @@ -1,3 +1,4 @@ + What to do when something goes wrong @@ -206,7 +207,7 @@ diff --git a/ghc/docs/users_guide/installing.sgml b/ghc/docs/users_guide/installing.xml similarity index 99% rename from ghc/docs/users_guide/installing.sgml rename to ghc/docs/users_guide/installing.xml index 3ca76e1..b3f8169 100644 --- a/ghc/docs/users_guide/installing.sgml +++ b/ghc/docs/users_guide/installing.xml @@ -1,3 +1,4 @@ + Installing GHC binary installations @@ -887,7 +888,7 @@ with the Win32 distribution of GHC. diff --git a/ghc/docs/users_guide/intro.sgml b/ghc/docs/users_guide/intro.xml similarity index 99% rename from ghc/docs/users_guide/intro.sgml rename to ghc/docs/users_guide/intro.xml index ee8747e..831a481 100644 --- a/ghc/docs/users_guide/intro.sgml +++ b/ghc/docs/users_guide/intro.xml @@ -1,3 +1,4 @@ + Introduction to GHC @@ -401,7 +402,7 @@ diff --git a/ghc/docs/users_guide/lang.sgml b/ghc/docs/users_guide/lang.xml similarity index 56% rename from ghc/docs/users_guide/lang.sgml rename to ghc/docs/users_guide/lang.xml index 65c0a19..7e9621e 100644 --- a/ghc/docs/users_guide/lang.sgml +++ b/ghc/docs/users_guide/lang.xml @@ -1,3 +1,4 @@ + GHC Language Features @@ -8,7 +9,7 @@ diff --git a/ghc/docs/users_guide/license.sgml b/ghc/docs/users_guide/license.xml similarity index 97% rename from ghc/docs/users_guide/license.sgml rename to ghc/docs/users_guide/license.xml index 897e8d5..d954d88 100644 --- a/ghc/docs/users_guide/license.sgml +++ b/ghc/docs/users_guide/license.xml @@ -1,3 +1,4 @@ + The Glasgow Haskell Compiler License diff --git a/ghc/docs/users_guide/packages.sgml b/ghc/docs/users_guide/packages.xml similarity index 94% rename from ghc/docs/users_guide/packages.sgml rename to ghc/docs/users_guide/packages.xml index 9e8e7c9..b50e58e 100644 --- a/ghc/docs/users_guide/packages.sgml +++ b/ghc/docs/users_guide/packages.xml @@ -1,3 +1,4 @@ + Packages packages @@ -39,8 +40,10 @@ - - -package lib option + + + -package lib option + This option brings into scope all the modules from package lib (they still have to @@ -95,9 +98,10 @@ the auto packages required for linking without further assistance. - - - + + + + Read in the package configuration file file in addition to the system @@ -193,9 +197,10 @@ the auto packages required for linking without further assistance. - - -package-name - option + + + -package-nameoption + This option is added to the command line when compiling a module that is destined to be part of package @@ -237,9 +242,13 @@ the auto packages required for linking without further assistance. - - - + + + + + + + Reads package specification from the input (see below), and adds it to the database of installed packages. The @@ -249,9 +258,13 @@ the auto packages required for linking without further assistance. - - - + + + + + + + Read new package specifications from file file. If a value of @@ -263,10 +276,13 @@ the auto packages required for linking without further assistance. - - - - + + + + + + + Automatically generate the GHCi .o version of each @@ -690,7 +706,7 @@ the auto packages required for linking without further assistance. diff --git a/ghc/docs/users_guide/parallel.sgml b/ghc/docs/users_guide/parallel.xml similarity index 98% rename from ghc/docs/users_guide/parallel.sgml rename to ghc/docs/users_guide/parallel.xml index 0442a9f..11c2547 100644 --- a/ghc/docs/users_guide/parallel.sgml +++ b/ghc/docs/users_guide/parallel.xml @@ -1,3 +1,4 @@ + Concurrent and Parallel Haskell @@ -203,7 +204,7 @@ remote closure or until the thread finishes. diff --git a/ghc/docs/users_guide/phases.sgml b/ghc/docs/users_guide/phases.xml similarity index 99% rename from ghc/docs/users_guide/phases.sgml rename to ghc/docs/users_guide/phases.xml index 3fb17cf..567c4f4 100644 --- a/ghc/docs/users_guide/phases.sgml +++ b/ghc/docs/users_guide/phases.xml @@ -1,3 +1,4 @@ + Options related to a particular phase @@ -717,7 +718,7 @@ strmod = "\ diff --git a/ghc/docs/users_guide/primitives.sgml b/ghc/docs/users_guide/primitives.xml similarity index 99% rename from ghc/docs/users_guide/primitives.sgml rename to ghc/docs/users_guide/primitives.xml index 4706671..e41bb59 100644 --- a/ghc/docs/users_guide/primitives.sgml +++ b/ghc/docs/users_guide/primitives.xml @@ -1,3 +1,4 @@ + @@ -1208,7 +1209,7 @@ The libraries documentatation gives more details on all these diff --git a/ghc/docs/users_guide/profiling.sgml b/ghc/docs/users_guide/profiling.xml similarity index 99% rename from ghc/docs/users_guide/profiling.sgml rename to ghc/docs/users_guide/profiling.xml index 25ea4bc..bae780d 100644 --- a/ghc/docs/users_guide/profiling.sgml +++ b/ghc/docs/users_guide/profiling.xml @@ -1,3 +1,4 @@ + Profiling profiling @@ -1358,7 +1359,7 @@ Total bytes copied during GC: 190096 diff --git a/ghc/docs/users_guide/runtime_control.sgml b/ghc/docs/users_guide/runtime_control.xml similarity index 99% rename from ghc/docs/users_guide/runtime_control.sgml rename to ghc/docs/users_guide/runtime_control.xml index b7668a0..e05d1a6 100644 --- a/ghc/docs/users_guide/runtime_control.sgml +++ b/ghc/docs/users_guide/runtime_control.xml @@ -1,3 +1,4 @@ + Running a compiled program @@ -541,7 +542,7 @@ char *ghc_rts_opts = "-H128m -K1m"; diff --git a/ghc/docs/users_guide/separate_compilation.sgml b/ghc/docs/users_guide/separate_compilation.xml similarity index 93% rename from ghc/docs/users_guide/separate_compilation.sgml rename to ghc/docs/users_guide/separate_compilation.xml index 558fb53..bda3539 100644 --- a/ghc/docs/users_guide/separate_compilation.sgml +++ b/ghc/docs/users_guide/separate_compilation.xml @@ -1,3 +1,4 @@ + Filenames and separate compilation @@ -214,8 +215,10 @@ - file - + + file + + GHC's compiled output normally goes into a .hc, .o, etc., @@ -254,8 +257,10 @@ - dir - + + dir + + Redirects object files to directory dir. For example: @@ -282,9 +287,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - file - - + + file + + The interface output may be directed to another file bar2/Wurble.iface with the option @@ -307,9 +313,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - dir - - + + dir + + Redirects all generated interface files into dir, instead of the @@ -318,12 +325,18 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - suffix - suffix - suffix - - - + + suffix + + + + suffix + + + + suffix + + The suffix will change the @@ -372,10 +385,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - - + + + + Keep intermediate .hc files when doing .hs-to-.o @@ -387,20 +400,20 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - - + + + + Keep intermediate .s files. - - - - + + + + Keep intermediate .raw-s files. These are the direct output from the C compiler, before @@ -411,14 +424,11 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - - - - temporary files - keeping - + + + + temporary fileskeeping + Instructs the GHC driver not to delete any of its temporary files, which it normally keeps in @@ -441,8 +451,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - + + + + If you have trouble because of running out of space in /tmp (or wherever your @@ -477,18 +489,20 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - + + + + Dumps the new interface to standard output. - - - + + + + The compiler does not overwrite an existing .hi interface file if the new one is @@ -502,9 +516,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - + + + + Dump to the file "M.imports" (where M is the module being compiled) a "minimal" set of import declarations. @@ -519,10 +534,10 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - file - - + + file + + Where file is the name of an interface file, dumps the contents of that interface in @@ -539,9 +554,11 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `arch` - - - + + + + + Turn off recompilation checking (which is on by default). Recompilation checking normally stops @@ -1066,7 +1083,7 @@ GHC considers it an orphan module. diff --git a/ghc/docs/users_guide/sooner.sgml b/ghc/docs/users_guide/sooner.xml similarity index 99% rename from ghc/docs/users_guide/sooner.sgml rename to ghc/docs/users_guide/sooner.xml index 22af9a0..1aba5d1 100644 --- a/ghc/docs/users_guide/sooner.sgml +++ b/ghc/docs/users_guide/sooner.xml @@ -1,3 +1,4 @@ + Advice on: sooner, faster, smaller, thriftier @@ -595,7 +596,7 @@ be required). diff --git a/ghc/docs/users_guide/ug-book.sgml b/ghc/docs/users_guide/ug-book.xml similarity index 74% rename from ghc/docs/users_guide/ug-book.sgml rename to ghc/docs/users_guide/ug-book.xml index 90b4718..7bebe69 100644 --- a/ghc/docs/users_guide/ug-book.sgml +++ b/ghc/docs/users_guide/ug-book.xml @@ -1,5 +1,6 @@ + -The Glasgow Haskell Compiler User's Guide, Version 6.0 +The Glasgow Haskell Compiler User's Guide, Version 6.3 The GHC Team
glasgow-haskell-{bugs,users}-request@haskell.org diff --git a/ghc/docs/users_guide/ug-ent.sgml b/ghc/docs/users_guide/ug-ent.sgml deleted file mode 100644 index 358afa2..0000000 --- a/ghc/docs/users_guide/ug-ent.sgml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ghc/docs/users_guide/ug-ent.xml b/ghc/docs/users_guide/ug-ent.xml new file mode 100644 index 0000000..71cb122 --- /dev/null +++ b/ghc/docs/users_guide/ug-ent.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ghc/docs/users_guide/users_guide.sgml b/ghc/docs/users_guide/users_guide.sgml deleted file mode 100644 index ea03b9e..0000000 --- a/ghc/docs/users_guide/users_guide.sgml +++ /dev/null @@ -1,9 +0,0 @@ - -%ug-ent; - -]> - - -&ug-book; - diff --git a/ghc/docs/users_guide/users_guide.xml b/ghc/docs/users_guide/users_guide.xml new file mode 100644 index 0000000..740e729 --- /dev/null +++ b/ghc/docs/users_guide/users_guide.xml @@ -0,0 +1,11 @@ + + +%ug-ent; + +]> + + +&ug-book; + diff --git a/ghc/docs/users_guide/using.sgml b/ghc/docs/users_guide/using.xml similarity index 94% rename from ghc/docs/users_guide/using.sgml rename to ghc/docs/users_guide/using.xml index 2fbd986..ec6187b 100644 --- a/ghc/docs/users_guide/using.sgml +++ b/ghc/docs/users_guide/using.xml @@ -1,3 +1,4 @@ + Using GHC @@ -123,8 +124,10 @@ module X where - .lhs - lhs suffix + + .lhs + lhs suffix + A “literate Haskell” module. @@ -192,13 +195,13 @@ module X where - ghc + + ghc ––interactive - - interactive mode - - ghci - + + interactive mode + ghci + Interactive mode, which is also available as ghci. Interactive mode is described in @@ -207,13 +210,13 @@ module X where - ghc + + ghc ––make - - make mode - - - + + make mode + + In this mode, GHC will build a multi-module Haskell program automatically, figuring out dependencies for itself. @@ -225,11 +228,12 @@ module X where - ghc + + ghc –e expr - - eval mode - + + eval mode + Expression-evaluation mode. This is very similar to interactive mode, except that there is a single expression @@ -240,7 +244,8 @@ module X where - + + ghc -E @@ -248,11 +253,12 @@ module X where -S -c - - - - - + + + + + + This is the traditional batch-compiler mode, in which GHC can compile source files one at a time, or link objects @@ -265,10 +271,13 @@ module X where - ghc - –M - dependency-generation mode - + + + ghc + –M + + dependency-generation mode + Dependency-generation mode. In this mode, GHC can be used to generate dependency information suitable for use in @@ -278,10 +287,13 @@ module X where - ghc - ––mk-dll - dependency-generation mode - + + + ghc + ––mk-dll + + dependency-generation mode + DLL-creation mode (Windows only). See . @@ -291,11 +303,8 @@ module X where Using <command>ghc</command> <option>––make</option> - - - - separate compilation - + + separate compilation When given the option, GHC will build a multi-module Haskell program by following @@ -330,11 +339,9 @@ ghc ––make Main.hs file. - You don't have to write a - Makefile. + You don't have to write aMakefile. + Makefilesavoiding - Makefilesavoiding - GHC re-calculates the dependencies each time it is invoked, so the dependencies never get out of sync with the @@ -516,10 +523,14 @@ ghc -c Foo.hs - - - - + + + + + + + + Cause GHC to spew a long usage message to standard output and then exit. @@ -527,8 +538,10 @@ ghc -c Foo.hs - - + + + + The option makes GHC verbose: it reports its version number @@ -545,8 +558,10 @@ ghc -c Foo.hs - n - + + n + + To provide more control over the compiler's verbosity, the flag takes an optional numeric @@ -605,26 +620,34 @@ ghc -c Foo.hs - - - - + + + + + + + + Print a one-line string including GHC's version number. - - + + + + Print GHC's numeric version number only. - - + + + + Print the path to GHC's library directory. This is the top of the directory tree containing GHC's libraries, @@ -779,8 +802,10 @@ g [] = 2 - : - + + : + + Turns on warnings for various harmless but untidy things. This currently includes: importing a type with @@ -790,11 +815,13 @@ g [] = 2 - : - + + : missing fields, warning fields, missing + + This option is on by default, and warns you whenever the construction of a labelled field constructor isn't @@ -863,10 +890,12 @@ g [] = 2 - : - - overlapping patterns, warning - patterns, overlapping + + : + + overlapping patterns, warning + patterns, overlapping + By default, the compiler will warn you if a set of patterns are overlapping, i.e., @@ -1745,7 +1774,7 @@ ordinary Haskell 98, when translated to External Core, uses things like rank-2 t diff --git a/ghc/docs/users_guide/utils.sgml b/ghc/docs/users_guide/utils.xml similarity index 99% rename from ghc/docs/users_guide/utils.sgml rename to ghc/docs/users_guide/utils.xml index 14e614e..da8e184 100644 --- a/ghc/docs/users_guide/utils.sgml +++ b/ghc/docs/users_guide/utils.xml @@ -1,3 +1,4 @@ + Other Haskell utility programs utilities, Haskell @@ -557,7 +558,7 @@ tags: diff --git a/ghc/docs/users_guide/win32-dlls.sgml b/ghc/docs/users_guide/win32-dlls.xml similarity index 99% rename from ghc/docs/users_guide/win32-dlls.sgml rename to ghc/docs/users_guide/win32-dlls.xml index 0cb8b22..0b8d159 100644 --- a/ghc/docs/users_guide/win32-dlls.sgml +++ b/ghc/docs/users_guide/win32-dlls.xml @@ -1,3 +1,4 @@ + Running GHC on Win32 systems @@ -467,7 +468,7 @@ the Haskell source and build the DLL.