X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=389a4454be8539cf644372c68f2843a3fe5bba94;hb=2ee130cd71d175dfad4120e8ddf2db0588043696;hp=eeb4f5dd4792ac3f53b6dad5d371de5dc6993c2e;hpb=f94f26a7cb7bb7005b88f50c4383a761fc18718d;p=ghc-hetmet.git
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index eeb4f5d..389a445 100644
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -60,6 +60,18 @@
-
+
+ display the supported language extensions
+ mode
+ -
+
+
+
+ display information about the compiler
+ mode
+ -
+
+
display GHC version
mode
@@ -169,25 +181,29 @@
- Interactive mode - normally used by just running ghci
+ Interactive mode - normally used by just running ghci;
+ see for details.
mode
-
- Build a multi-module Haskell program, automatically figuring out dependencies. Likely to be much easier, and faster, than using make.
+ Build a multi-module Haskell program, automatically figuring out dependencies. Likely to be much easier, and faster, than using make;
+ see for details..
mode
-
- Evaluate expr
+ Evaluate expr;
+ see for details.
mode
-
- Generate dependency information suitable for use in a Makefile.
+ Generate dependency information suitable for use in a Makefile;
+ see for details.
mode
-
@@ -238,7 +254,7 @@
dir
- set output directory
+ set directory for object files
dynamic
-
@@ -260,6 +276,12 @@
dynamic
-
+
+ dir
+ set output directory
+ dynamic
+ -
+
@@ -282,19 +304,22 @@
-
+ or
+
retain intermediate .hc files
dynamic
-
-
+ or
+
retain intermediate .s files
dynamic
-
-
+ or
+
retain intermediate .raw_s files
dynamic
-
@@ -358,13 +383,13 @@
dir1:dir2:...
add dir,
dir2, etc. to import path
- dynamic
+ static/:set
-
Empty the import directory list
- dynamic
+ static/:set
-
@@ -409,11 +434,7 @@
file
- Read the interface in
- file and dump it as text to
- stdout.
- mode
- -
+ See .
@@ -449,7 +470,7 @@
-
+
Interactive-mode options
@@ -478,17 +499,43 @@
-
-
- Generate bytecode enabled for debugging
+
+ Break on any exception thrown
+ dynamic
+
+
+
+
+ Break on uncaught exceptions and errors
+ dynamic
+
+
+
+
+ Enable usage of Show instances in :print
+ dynamic
+
+
+
+
+ Turn on printing of binding results in GHCi
+ dynamic
+
+
+
+
+ Turn off printing of binding contents in GHCi
dynamic
-
-
- Do not include debugging information in bytecodes
+
+ Turn off
+ implicit qualified import of everything in GHCi
dynamic
-
+
@@ -519,7 +566,7 @@
P
Expose package P
- dynamic
+ static/:set
-
@@ -531,24 +578,30 @@
name
Hide package P
- dynamic
+ static/:set
-
name
Ignore package P
- dynamic
+ static/:set
-
file
Load more packages from file
- dynamic
+ static
-
Don't load the user's package config file.
+ static
+ -
+
+
+
+ Don't automatically link in the haskell98 package.
dynamic
-
@@ -560,7 +613,9 @@
Language options
-
+ Language options can be enabled either by a command-line option
+ , or by a {-# LANGUAGE blah #-}
+ pragma in the file itself. See
@@ -574,62 +629,69 @@
-
+
+ Enable most language extensions
+ dynamic
+
+
+
+
Enable overlapping instances
dynamic
-
+
-
+
Enable incoherent instances.
- Implies
+ Implies
dynamic
-
+
-
+
Enable undecidable instances
dynamic
-
+
n
- set the limit for context reduction
+ set the limit for context reduction. Default is 20.
dynamic
-
+
-
+
Enable arrow
notation extension
dynamic
-
+
- or
- Enable foreign function interface (implied by
- )
+
+ Enable record
+ field disambiguation
dynamic
-
+
-
- Enable generic classes
+
+ Enable foreign function interface (implied by
+ )
dynamic
-
+
-
- Enable most language extensions
+
+ Enable generic classes
dynamic
-
+
-
+
Enable Implicit Parameters.
Implied by .
dynamic
-
+
@@ -638,55 +700,317 @@
-
+
Don't implicitly import Prelude
dynamic
-
+
-
+
Disable the monomorphism restriction
dynamic
-
+
-
+
+ Disable support for n+k patterns
+ dynamic
+
+
+
+
Make pattern bindings polymorphic
dynamic
-
+
+
+
+
+ Relaxed checking for mutually-recursive polymorphic functions
+ dynamic
+
-
+
Use GHCi's extended default rules in a normal module
dynamic
-
+
-
+
Enable overloaded string literals.
dynamic
-
+
-
+
+ Enable generalised algebraic data types.
+
+ dynamic
+
+
+
+
+ Enable type families.
+ dynamic
+
+
+
+
Enable lexically-scoped type variables.
Implied by .
dynamic
-
+
-
+
+ Enable do not generalise local bindings.
+
+ dynamic
+
+
+
+
Enable Template Haskell.
No longer implied by .
dynamic
-
+
-
- Enable bang patterns.
+
+ Enable quasiquotation.
dynamic
-
+
+
+
+
+ Enable bang patterns.
+ dynamic
+
+
+
+
+ Enable the C preprocessor.
+ dynamic
+
+
+
+
+ Enable pattern guards.
+ dynamic
+
+
+
+
+ Enable view patterns.
+ dynamic
+
+
+
+
+ Enable unicode syntax.
+ dynamic
+
+
+
+
+ Allow "#" as a postfix modifier on identifiers.
+ dynamic
+
+
+
+
+ Enable new
+ qualified operator syntax
+ dynamic
+
+
+
+
+ Enable explicit universal quantification.
+ Implied by ,
+ ,
+ ,
+ ,
+ ,
+
+
+ dynamic
+
+
+
+
+ Enable polymorphic components for data constructors.
+ dynamic
+
+
+
+
+ Enable rank-2 types.
+ dynamic
+
+
+
+
+ Enable rank-N types.
+ dynamic
+
+
+
+
+ Enable impredicative types.
+ dynamic
+
+
+
+
+ Enable existential quantification.
+ dynamic
+
+
+
+
+ Enable kind signatures.
+ dynamic
+
+
+
+
+ Enable empty data declarations.
+ dynamic
+
+
+
+
+ Enable parallel list comprehensions.
+ dynamic
+
+
+
+
+ Enable generalised list comprehensions.
+ dynamic
+
+
+
+
+ Enable unlifted FFI types.
+ dynamic
+
+
+
+
+ Enable liberalised type synonyms.
+ dynamic
+
+
+
+
+ Enable type operators.
+ dynamic
+
+
+
+
+ Enable recursive do notation.
+ dynamic
+
+
+
+
+ Enable recursive do (mdo) notation. This is deprecated; please use recursive do notation instead.
+ dynamic
+
+
+
+
+ Enable parallel arrays.
+ dynamic
+
+
+
+
+ Enable record wildcards.
+ dynamic
+
+
+
+
+ Enable record puns.
+ dynamic
+
+
+
+
+ Enable record field disambiguation.
+ dynamic
+
+
+
+
+ Enable unboxed tuples.
+ dynamic
+
+
+
+
+ Enable standalone deriving.
+ dynamic
+
+
+
+
+ Enable deriving for the Data and Typeable classes.
+ dynamic
+
+
+
+
+ Enable newtype deriving.
+ dynamic
+
+
+
+
+ Enable type synonyms in instance heads.
+ dynamic
+
+
+
+
+ Enable flexible contexts.
+ dynamic
+
+
+
+
+ Enable flexible instances.
+ dynamic
+
+
+
+
+ Enable constrained class methods.
+ dynamic
+
+
+
+
+ Enable multi parameter type classes.
+ dynamic
+
+
+
+
+ Enable functional dependencies.
+ dynamic
+
+
+
+
+ Enable package-qualified imports.
+ dynamic
+
@@ -723,7 +1047,7 @@
- enable all warnings
+ enable almost all warnings (details in )
dynamic
@@ -731,14 +1055,34 @@
make warnings fatal
dynamic
-
+ -Wwarn
+
+
+
+ make warnings non-fatal
+ dynamic
+ -Werror
-
- warn about uses of functions & types that are deprecated
+
+ warn about uses of pragmas that GHC doesn't recognise
dynamic
-
+
+
+
+
+
+ warn about uses of functions & types that have warnings or deprecated pragmas
+ dynamic
+
+
+
+
+
+ warn about uses of commandline flags that are deprecated
+ dynamic
+
@@ -756,6 +1100,13 @@
+
+
+ warn when the Prelude is implicitly imported
+ dynamic
+
+
+
warn when a pattern match could fail
@@ -778,6 +1129,13 @@
+
+ warn when explicit imports lack an import list
+ dynamic
+
+
+
+
warn when class methods are undefined
dynamic
@@ -800,8 +1158,8 @@
- warn when the module contains "orphan" instance declarations
- or rewrite rules
+ warn when the module contains orphan instance declarations
+ or rewrite rules
dynamic
@@ -835,6 +1193,13 @@
+
+ warn when the Monomorphism Restriction is applied
+ dynamic
+
+
+
+
warn about bindings that are unused
dynamic
@@ -855,6 +1220,20 @@
+
+
+ warn about do bindings that appear to throw away values of types other than ()
+ dynamic
+
+
+
+
+
+ warn about do bindings that appear to throw away monadic values that you should have bound instead
+ dynamic
+
+
+
@@ -911,7 +1290,7 @@
- Enable case-merging
+ Enable case-merging. Implied by .
dynamic
@@ -924,8 +1303,15 @@
+
+ Share specialisations of overloaded functions (default)
+ dynamic
+
+
+
+
- Enable eta-reduction
+ Enable eta-reduction. Implied by .
dynamic
@@ -945,14 +1331,6 @@
-
- Switch off all rewrite rules (including rules
- generated by automatic specialisation of overloaded functions)
- static
-
-
-
-
Ignore assertions in the source
dynamic
@@ -967,13 +1345,6 @@
-
- Tweak the liberate-case optimisation (default: 10)
- static
-
-
-
-
Don't generate interface pragmas
dynamic
@@ -989,6 +1360,14 @@
+
+ Set the number of phases for the simplifier (default 2).
+ Ignored with .
+ dynamic
+ -
+
+
+
Set the max iterations for the simplifier
dynamic
@@ -1004,31 +1383,99 @@
-
- Turn off common sub-expression
+
+ Turn on common sub-expression elimination. Implied by .
dynamic
- -
+ -fno-cse
-
- Turn off full laziness (floating bindings outwards).
+
+ Turn on specialisation of overloaded functions. Implied by .
dynamic
- -ffull-laziness
+ -fno-specialise
-
- Turn off pre-inlining
+
+ Turn on full laziness (floating bindings outwards). Implied by .
+ dynamic
+ -fno-full-laziness
+
+
+
+
+ Turn on the float-in transformation. Implied by .
+ dynamic
+ -fno-float-in
+
+
+
+
+ Switch on all rewrite rules (including rules
+ generated by automatic specialisation of overloaded functions).
+ Implied by .
+ dynamic
+
+
+
+
+
+ Turn on strictness analysis. Implied by .
+ dynamic
+ -fno-strictness
+
+
+
+ =n
+ Run an additional strictness analysis before simplifier
+phase n
+ dynamic
+ -
+
+
+
+
+ Turn on the SpecConstr transformation. Implied by .
+ dynamic
+ -fno-spec-constr
+
+
+
+ =n
+ Set the size threshold for the SpecConstr transformation to n (default: 200)
static
- -
+
-
- Turn off strictness analysis
+ =n
+ Set to n (default: 3) the maximum number of
+ specialisations that will be created for any one function
+ by the SpecConstr transformation
+ static
+
+
+
+
+
+ Turn on the liberate-case transformation. Implied by .
dynamic
- -
+ -fno-liberate-case
+
+
+
+
+ Turn on the static argument transformation. Implied by .
+ dynamic
+ -fno-static-argument-transformation
+
+
+
+ =n
+ Set the size threshold for the liberate-case transformation to n (default: 200)
+ static
+
@@ -1060,17 +1507,24 @@
-
+
Tweak unfolding settings
static
-
+
-
- Tweak unfolding settings
+
+ Turn off pre-inlining
static
-
+ -
+
+
+
+
+ Turn on eager blackholing
+ dynamic
+ -
@@ -1096,21 +1550,21 @@
Auto-add _scc_s to all
- exported functions
- static
+ exported functions not marked INLINE
+ dynamic
Auto-add _scc_s to all
- top-level functions
- static
+ top-level functions not marked INLINE
+ dynamic
Auto-add _scc_s to all CAFs
- static
+ dynamic
@@ -1121,7 +1575,7 @@
- Turn on ticky-ticky profiling
+ Turn on ticky-ticky profiling
static
-
@@ -1131,6 +1585,39 @@
+ Program coverage options
+
+
+
+
+
+
+
+ Flag
+ Description
+ Static/Dynamic
+ Reverse
+
+
+
+
+
+ Turn on Haskell program coverage instrumentation
+ static
+
+
+
+
+ Directory to deposit .mix files during compilation (default is .hpc)
+ dynamic
+
+
+
+
+
+
+
+
Haskell pre-processor options
@@ -1207,33 +1694,6 @@
- C compiler options
-
-
-
-
-
-
- Flag
- Description
- Static/Dynamic
- Reverse
-
-
-
-
- file
- Include file when
- compiling the .hc file
- dynamic
- -
-
-
-
-
-
-
-
Code generation options
@@ -1264,7 +1724,19 @@
Omit code generation
- mode
+ dynamic
+ -
+
+
+
+ Generate byte-code
+ dynamic
+ -
+
+
+
+ Generate object code
+ dynamic
-
@@ -1289,6 +1761,12 @@
+
+ Generate a shared library (as opposed to an executable)
+ dynamic
+ -
+
+
Generate position-independent code (where available)
static
@@ -1301,6 +1779,13 @@
-
+
+ Selects one of a number of modes for finding shared
+ libraries at runtime.
+ static
+ -
+
+
name
On Darwin/MacOS X only, link in the framework name.
This option corresponds to the option for Apple's Linker.
@@ -1330,7 +1815,7 @@
- Set main function
+ Set main module and function
dynamic
-
@@ -1347,6 +1832,21 @@
-
+
+ Allow the RTS behaviour to be tweaked via command-line
+ flags and the GHCRTS environment
+ variable.
+ dynamic
+ -
+
+
+
+ Set the default RTS options to
+ opts.
+ dynamic
+ -
+
+
Omit linking
dynamic
@@ -1376,6 +1876,39 @@
static
-
+
+
+ Enable runtime event tracing
+ static
+ -
+
+
+
+ Do not generate a manifest file (Windows only)
+ dynamic
+ -
+
+
+
+ Do not embed the manifest in the executable (Windows only)
+ dynamic
+ -
+
+
+
+ Don't generate an import library for a DLL (Windows only)
+ dynamic
+ -
+
+
+ path
+ Set the install name (via -install_name passed to Apple's
+ linker), specifying the full install path of the library file. Any libraries
+ or executables that link with it later will pick up that path as their
+ runtime search location for it. (Darwin/MacOS X only)
+ dynamic
+ -
+
@@ -1453,6 +1986,13 @@
dynamic
-
+
+ cmd
+ Use cmd as the program for
+ embedding manifests on Windows.
+ dynamic
+ -
+
@@ -1533,8 +2073,8 @@
-
- option
- pass option to the dependency generator
+ option
+ pass option to windres.
dynamic
-
@@ -1558,6 +2098,14 @@
Reverse
+
+
+
+ (x86 only) Use SSE2 for floating point
+ dynamic
+ -
+
+
@@ -1590,7 +2138,7 @@
Generate .hcr external Core files
- static
+ dynamic
-
@@ -1676,6 +2224,12 @@
-
+
+ Dump after instrumentation for program coverage
+ dynamic
+ -
+
+
Dump inlining info
dynamic
@@ -1724,6 +2278,12 @@
-
+
+ Dump output from each simplifier phase
+ dynamic
+ -
+
+
Dump output from each simplifier iteration
dynamic
@@ -1737,7 +2297,7 @@
- Dump TH splided expressions, and what they evaluate to
+ Dump TH spliced expressions, and what they evaluate to
dynamic
-
@@ -1802,12 +2362,30 @@
-
+
+ Suppress unsolicited debugging output
+ static
+ -
+
+
Turn on debug printing (more verbose)
static
-
+
+ Suppress the printing of uniques in debug output (easier to use diff.
+ static
+ -
+
+
+
+ Suppress the printing of coercions in Core dumps to make them shorter.
+ static
+ -
+
+
Don't output pragma info in dumps
static
@@ -1867,12 +2445,6 @@
dynamic
-
-
-
- Enable unregisterised compilation
- static
- -
-
@@ -1905,12 +2477,6 @@
-
-
- Don't share specialisations of overloaded functions
- static
- -
-
-
Set simplification history size
static
@@ -1928,12 +2494,6 @@
dynamic
-
-
-
- Turn off printing of binding results in GHCi
- dynamic
- -
-