X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=23576735c0df02513ac4ed4b10cabeebd616f339;hb=a0f6d307b097bd788e181434a4d9b7fdd56a6c6b;hp=ba6e895a586370b996788edbe0c10b38c707ca43;hpb=2eb04ca0f8d0ec72b417cddc60672c696b4a3daa;p=ghc-hetmet.git
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index ba6e895..2357673 100644
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -60,6 +60,18 @@
-
+ or
+ display the supported languages and language extensions
+ mode
+ -
+
+
+
+ display information about the compiler
+ mode
+ -
+
+
display GHC version
mode
@@ -242,7 +254,7 @@
dir
- set output directory
+ set directory for object files
dynamic
-
@@ -264,6 +276,12 @@
dynamic
-
+
+ dir
+ set output directory
+ dynamic
+ -
+
@@ -286,19 +304,29 @@
-
+ or
+
retain intermediate .hc files
dynamic
-
-
+ or
+
+ retain intermediate LLVM .ll files
+ dynamic
+ -
+
+
+ or
+
retain intermediate .s files
dynamic
-
-
+ or
+
retain intermediate .raw_s files
dynamic
-
@@ -413,11 +441,7 @@
file
- Read the interface in
- file and dump it as text to
- stdout.
- mode
- -
+ See .
@@ -453,7 +477,7 @@
-
+
Interactive-mode options
@@ -482,35 +506,43 @@
-
-
- Display a one-line banner at GHCi startup
+
+ Break on any exception thrown
dynamic
- -
+
-
- Display a full banner at GHCi startup
+
+ Break on uncaught exceptions and errors
dynamic
- -
+
-
- Generate bytecode enabled for debugging
+
+ Enable usage of Show instances in :print
dynamic
- -
+
+
+
+
+ Turn on printing of binding results in GHCi
+ dynamic
+
-
- Do not include debugging information in bytecodes
+
+ Turn off printing of binding contents in GHCi
dynamic
-
-
- Turn off printing of binding results in GHCi
+
+ Turn off
+ implicit qualified import of everything in GHCi
dynamic
-
+
@@ -574,6 +606,12 @@
static
-
+
+
+ Don't automatically link in the haskell98 package.
+ dynamic
+ -
+
@@ -582,7 +620,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
@@ -602,63 +642,63 @@
-
+
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
-
+
-
+
Enable record
field disambiguation
dynamic
-
+
- or
+
Enable foreign function interface (implied by
)
dynamic
-
+
-
+
Enable generic classes
dynamic
-
+
-
+
Enable Implicit Parameters.
Implied by .
dynamic
-
+
@@ -667,74 +707,324 @@
-
+
Don't implicitly import Prelude
dynamic
-
+
-
+
+ Employ rebindable syntax
+ 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.
+
+ Enable generalised algebraic data types.
dynamic
-
+
-
+
+ Enable generalised algebraic data type syntax.
+
+ dynamic
+
+
+
+
Enable type families.
dynamic
-
+
-
+
Enable lexically-scoped type variables.
Implied by .
dynamic
-
+
+
+
+
+ Enable do not generalise local bindings.
+
+ dynamic
+
- or
+
Enable Template Haskell.
No longer implied by .
dynamic
-
+
+
+
+
+ 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 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.
+ Implies
+ dynamic
+
+
+
+
+ Enable constrained class methods.
+ dynamic
+
+
+
+
+ Enable multi parameter type classes.
+ dynamic
+
+
+
+
+ Enable functional dependencies.
+ dynamic
+
+
+
+
+ Enable package-qualified imports.
+ dynamic
+
@@ -779,14 +1069,34 @@
make warnings fatal
dynamic
-
+ -Wwarn
+
+
+
+ make warnings non-fatal
+ dynamic
+ -Werror
+
+
+
+
+ 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 functions & types that are deprecated
+
+ warn about uses of commandline flags that are deprecated
dynamic
-
+
@@ -805,6 +1115,14 @@
+
+ warn about uses of Prelude numeric conversions that are probably
+ the identity (and hence could be omitted)
+ dynamic
+
+
+
+
warn when the Prelude is implicitly imported
dynamic
@@ -819,6 +1137,13 @@
+
+ warn when a pattern match in a lambda expression or pattern binding could fail
+ dynamic
+
+
+
+
warn when a record update could fail
dynamic
@@ -826,6 +1151,13 @@
+
+ warn when a pattern binding looks lazy but must be strict
+ dynamic
+
+
+
+
warn when fields of a record are uninitialised
dynamic
@@ -833,6 +1165,14 @@
+
+ warn when an import declaration does not explicitly
+ list all the names brought into scope
+ dynamic
+
+
+
+
warn when class methods are undefined
dynamic
@@ -855,8 +1195,8 @@
- warn when the module contains "orphan" instance declarations
- or rewrite rules
+ warn when the module contains orphan instance declarations
+ or rewrite rules
dynamic
@@ -869,13 +1209,6 @@
-
- warn about lambda-patterns that can fail
- dynamic
-
-
-
-
warn if there are tabs in the source file
dynamic
@@ -917,6 +1250,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
+
+
+
@@ -986,6 +1333,13 @@
+
+ Share specialisations of overloaded functions (default)
+ dynamic
+
+
+
+
Enable eta-reduction. Implied by .
dynamic
@@ -1036,6 +1390,14 @@
+
+ Set the number of phases for the simplifier (default 2).
+ Ignored with .
+ dynamic
+ -
+
+
+
Set the max iterations for the simplifier
dynamic
@@ -1058,6 +1420,13 @@
+
+ Turn on specialisation of overloaded functions. Implied by .
+ dynamic
+ -fno-specialise
+
+
+
Turn on full laziness (floating bindings outwards). Implied by .
dynamic
@@ -1065,12 +1434,19 @@
-
+
+ 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
-
+
@@ -1080,6 +1456,14 @@
-fno-strictness
+
+ =n
+ Run an additional strictness analysis before simplifier
+phase n
+ dynamic
+ -
+
+
Turn on the SpecConstr transformation. Implied by .
@@ -1088,6 +1472,22 @@
+ =n
+ Set the size threshold for the SpecConstr transformation to n (default: 200)
+ static
+
+
+
+
+ =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
@@ -1095,11 +1495,17 @@
- =n
- Set the size threshold for function specialisation to n, for both
- the liberate-case and SpecConstr transformations (default: 200)
+
+ 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
-
+
@@ -1131,13 +1537,6 @@
-
- Tweak unfolding settings
- static
-
-
-
-
Tweak unfolding settings
static
@@ -1150,6 +1549,13 @@
static
-
+
+
+
+ Turn on eager blackholing
+ dynamic
+ -
+
@@ -1174,21 +1580,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
@@ -1199,7 +1605,7 @@
- Turn on ticky-ticky profiling
+ Turn on ticky-ticky profiling
static
-
@@ -1232,7 +1638,7 @@
- Directory to deposit .mix files during compilation
+ Directory to deposit .mix files during compilation (default is .hpc)
dynamic
@@ -1318,33 +1724,6 @@
- C compiler options
-
-
-
-
-
-
- Flag
- Description
- Static/Dynamic
- Reverse
-
-
-
-
- file
- Include file when
- compiling the .hc file
- dynamic
- -
-
-
-
-
-
-
-
Code generation options
@@ -1373,6 +1752,12 @@
-fasm
+
+ Compile via LLVM
+ dynamic
+ -fasm
+
+
Omit code generation
dynamic
@@ -1412,6 +1797,12 @@
+
+ Generate a shared library (as opposed to an executable)
+ dynamic
+ -
+
+
Generate position-independent code (where available)
static
@@ -1424,6 +1815,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.
@@ -1470,6 +1868,21 @@
-
+ ,
+ Control whether the RTS behaviour can be tweaked via command-line
+ flags and the GHCRTS environment
+ variable. Using none means no RTS flags can be given; some means only a minimum of safe options can be given (the default), and all (or no argument at all) means that all RTS flags are permitted.
+ dynamic
+ -
+
+
+
+ Set the default RTS options to
+ opts.
+ dynamic
+ -
+
+
Omit linking
dynamic
@@ -1499,6 +1912,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
+ -
+
@@ -1538,6 +1984,18 @@
Use cmd as the C compiler
dynamic
-
+
+ cmd
+ Use cmd as the LLVM optimiser
+ dynamic
+ -
+
+
+ cmd
+ Use cmd as the LLVM compiler
+ dynamic
+ -
+
cmd
@@ -1576,12 +2034,21 @@
dynamic
-
+
+ cmd
+ Use cmd as the program for
+ embedding manifests on Windows.
+ dynamic
+ -
+
+
+
@@ -1632,6 +2099,18 @@
-
+ option
+ pass option to the LLVM optimiser
+ dynamic
+ -
+
+
+ option
+ pass option to the LLVM compiler
+ dynamic
+ -
+
+
option
pass option to the mangler
dynamic
@@ -1656,8 +2135,8 @@
-
- option
- pass option to the dependency generator
+ option
+ pass option to windres.
dynamic
-
@@ -1681,6 +2160,14 @@
Reverse
+
+
+
+ (x86 only) Use SSE2 for floating point
+ dynamic
+ -
+
+
@@ -1713,7 +2200,7 @@
Generate .hcr external Core files
- static
+ dynamic
-
@@ -1800,7 +2287,7 @@
- Dump after intrumentation for program coverage
+ Dump after instrumentation for program coverage
dynamic
-
@@ -1811,6 +2298,12 @@
-
+
+ Dump LLVM intermediate code
+ dynamic
+ -
+
+
Dump occurrence analysis output
dynamic
@@ -1841,6 +2334,18 @@
-
+
+ Dump rule firing info
+ dynamic
+ -
+
+
+
+ Dump detailed rule firing info
+ dynamic
+ -
+
+
Dump rules
dynamic
@@ -1853,6 +2358,12 @@
-
+
+ Dump output from each simplifier phase
+ dynamic
+ -
+
+
Dump output from each simplifier iteration
dynamic
@@ -1866,7 +2377,7 @@
- Dump TH splided expressions, and what they evaluate to
+ Dump TH spliced expressions, and what they evaluate to
dynamic
-
@@ -1931,12 +2442,36 @@
-
+
+ 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
+ -
+
+
+
+ Suppress the printing of module qualification prefixes in Core dumps to make them easier to read.
+ static
+ -
+
+
Don't output pragma info in dumps
static
@@ -1996,12 +2531,6 @@
dynamic
-
-
-
- Enable unregisterised compilation
- static
- -
-
@@ -2034,12 +2563,6 @@
-
-
- Don't share specialisations of overloaded functions
- static
- -
-
-
Set simplification history size
static
@@ -2057,6 +2580,12 @@
dynamic
-
+
+
+ Turn off the GHCi sandbox. Means computations are run in teh main thread, rather than a forked thread.
+ dynamic
+ -
+
@@ -2075,7 +2604,6 @@ Misc: