X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fusing.xml;h=eb032df28336bcf7b1d3498fc357cd810ed3ecda;hb=194e778d542875df662986c48a0e8832be880247;hp=c09fa357fedefe8c3a07ccd19d4d96a4d1e206a9;hpb=6e2021202c3eec0c95a9d0b7c355559f2630d380;p=ghc-hetmet.git
diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index c09fa35..eb032df 100644
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -14,7 +14,7 @@
Options can be specified in three ways:
- command-line arguments
+ Command-line argumentsstructure, command-linecommand-linearguments
@@ -26,9 +26,9 @@
ghc [argument...]
- command-line arguments are either options or file names.
+ Command-line arguments are either options or file names.
- command-line options begin with -.
+ Command-line options begin with -.
They may not be grouped:
is different from .
Options need not precede filenames: e.g., ghc *.o -o
@@ -40,7 +40,7 @@ ghc [argument...]
- command line options in source files
+ Command line options in source filessource-file options
@@ -81,7 +81,7 @@ module X where
It is not recommended to move all the contents of your
Makefiles into your source files, but in some circumstances, the
OPTIONS_GHC pragma is the Right Thing. (If you
- use and have OPTION flags in
+ use and have OPTION flags in
your module, the OPTIONS_GHC will get put into the generated .hc
file).
@@ -104,8 +104,8 @@ module X where
modeoptions
- Each of GHC's command line options is classified as either
- static or dynamic or
+ Each of GHC's command line options is classified as
+ static, dynamic or
mode:
@@ -113,7 +113,7 @@ module X where
Mode flagsFor example, or .
- There may be only a single mode flag on the command line. The
+ There may only be a single mode flag on the command line. The
available modes are listed in .
@@ -138,6 +138,11 @@ module X where
The flag reference tables () lists the status of each flag.
+
+ There are a few flags that are static except that they can
+ also be used with GHCi's :set command; these
+ are listed as “static/:set” in the
+ table.
@@ -305,7 +310,7 @@ module X where
Dependency-generation mode. In this mode, GHC can be
used to generate dependency information suitable for use in
a Makefile. See .
+ linkend="makefile-dependencies"/>.
@@ -338,10 +343,11 @@ module X where
- ghc --versionghc -V
+ ghc --version
+ ghc -V
+
-
Print a one-line string including GHC's version number.
@@ -351,9 +357,9 @@ module X where
- ghc --numeric-version
+ ghc --numeric-version
+
-
Print GHC's numeric version number only.
@@ -363,9 +369,9 @@ module X where
- ghc --print-libdir
+ ghc --print-libdir
+
-
Print the path to GHC's library directory. This is
@@ -373,9 +379,9 @@ module X where
interfaces, and include files (usually something like
/usr/local/lib/ghc-5.04 on Unix). This
is the value of
- $libdirlibdir
- in the package configuration file (see ).
+ $libdirlibdir
+ in the package configuration file
+ (see ).
@@ -388,7 +394,7 @@ module X where
When given the option,
GHC will build a multi-module Haskell program by following
- dependencies from a single root module (usually
+ dependencies from one or more root modules (usually just
Main). For example, if your
Main module is in a file called
Main.hs, you could compile and link the
@@ -402,7 +408,7 @@ ghc ––make Main.hs
names or module names; GHC will figure out all the modules in
the program by following the imports from these initial modules.
It will then attempt to compile each module which is out of
- date, and finally if there is a Main module,
+ date, and finally, if there is a Main module,
the program will also be linked into an executable.The main advantages to using ghc
@@ -497,7 +503,7 @@ olleh
The first phase to run is determined by each input-file
suffix, and the last phase is determined by a flag. If no
- relevant flag is present, then go all the way through linking.
+ relevant flag is present, then go all the way through to linking.
This table summarises:
@@ -625,8 +631,8 @@ ghc -c Foo.hs
help optionsverbosity options
- See also the , , ,
- and modes in .
+ See also the , , ,
+ and modes in .
@@ -833,7 +839,17 @@ ghc -c Foo.hs
:
- Turns on all warning options.
+ Turns on all warning options that indicate potentially
+ suspicious code. The warnings that are
+ not enabled by
+ are:
+
+
+
+
+
+
+
@@ -899,6 +915,31 @@ ghc -c Foo.hs
+ :
+
+
+ implicit prelude, warning
+ Have the compiler warn if the Prelude is implicitly
+ imported. This happens unless either the Prelude module is
+ explicitly imported with an import ... Prelude ...
+ line, or this implicit import is disabled (either by
+ or a
+ LANGUAGE NoImplicitPrelude pragma).
+
+ Note that no warning is given for syntax that implicitly
+ refers to the Prelude, even if
+ would change whether it refers to the Prelude.
+ For example, no warning is given when
+ 368 means
+ Prelude.fromInteger (368::Prelude.Integer)
+ (where Prelude refers to the actual Prelude module,
+ regardless of the imports of the module being compiled).
+
+ This warning is off by default.
+
+
+
+ :
@@ -1000,7 +1041,8 @@ f foo = foo { x = 6 }
If you would like GHC to check that every top-level
function/value has a type signature, use the
- option. This
+ option. As part of
+ the warning GHC also reports the inferred type. The
option is off by default.
@@ -1018,7 +1060,7 @@ f foo = foo { x = 6 }
in the inadvertent cyclic definition let x = ... x
... in.
- Consequently, this option does
+ Consequently, this option
will complain about cyclic recursive
definitions.
@@ -1129,6 +1171,20 @@ f "2" = 2
+ :
+
+
+ monomorphism restriction, warning
+ Have the compiler warn/inform you where in your source
+ the Haskell Monomorphism Restriction is applied. If applied silently
+ the MR can give rise to unexpected behaviour, so it can be helpful
+ to have an explicit warning that it is being applied.
+
+ This warning is off by default.
+
+
+
+ :
@@ -1220,7 +1276,7 @@ f "2" = 2
Note that higher optimisation levels cause more
cross-module optimisation to be performed, which can have an
impact on how much of your program needs to be recompiled when
- you change something. This is one reaosn to stick to
+ you change something. This is one reason to stick to
no-optimisation when developing code.
@@ -1362,7 +1418,7 @@ f "2" = 2
Exception.assert in source code (in
other words, rewriting Exception.assert p
e to e (see ). This flag is turned on by
+ linkend="assertions"/>). This flag is turned on by
.
@@ -1429,6 +1485,50 @@ f "2" = 2
+
+
+
+
+ Turn off the "state hack" whereby any lambda with a
+ State# token as argument is considered to be
+ single-entry, hence it is considered OK to inline things inside
+ it. This can improve performance of IO and ST monad code, but it
+ runs the risk of reducing sharing.
+
+
+
+
+
+
+
+
+
+ Tells GHC to omit all inessential information from the interface file
+ generated for the module being compiled (say M). This means that a module
+ importing M will see only the types of the functions that M exports, but not
+ their unfoldings, strictness info, etc. Hence, for example,
+ no function exported by M will be inlined
+ into an importing module. The benefit is that modules that import M will
+ need to be recompiled less often (only when M's exports change their type,
+ not when they change their implementation).
+
+
+
+
+
+
+
+
+
+
+ Tells GHC to ignore all inessential information when reading interface files.
+ That is, even if M.hi contains unfolding or strictness information
+ for a function, GHC will ignore that information.
+
+
+
+
+
:
strict constructor fields
@@ -1451,7 +1551,7 @@ f "2" = 2
-
+
@@ -1469,7 +1569,7 @@ f "2" = 2
- :
+ :
inlining, controllingunfolding, controlling
@@ -1495,7 +1595,7 @@ f "2" = 2
- :
+ inlining, controlling
@@ -1517,7 +1617,7 @@ f "2" = 2
&phases;
-
+ Using Concurrent HaskellConcurrent Haskellusing
@@ -1547,7 +1647,7 @@ f "2" = 2
-
+ Using SMP parallelismparallelism