X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=47b51a8298a7c8ecd61256d5fbc6ca4bd93e03e9;hb=a3532ac90945bf7c540619f790649ddfbaaf6b2c;hp=1fd054c332ed2a6ec99ddb3e0cfdfc2ac6b630d0;hpb=2ab65c00417e668f8a2a3f98fde51448dda83d6e;p=ghc-hetmet.git
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index 1fd054c..47b51a8 100644
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -36,6 +36,12 @@
-
+
+ do a dry run
+ dynamic
+ -
+
+
verbose mode (equivalent to )
dynamic
@@ -54,6 +60,18 @@
-
+
+ display the supported language extensions
+ mode
+ -
+
+
+
+ display information about the compiler
+ mode
+ -
+
+
display GHC version
mode
@@ -78,6 +96,12 @@
-
+ size
+ Set the minimum heap size to size
+ static
+ -
+
+
Summarise timing stats for GHC (same as +RTS -tstderr)
static
@@ -157,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
-
@@ -270,19 +298,22 @@
-
+ or
+
retain intermediate .hc files
dynamic
-
-
+ or
+
retain intermediate .s files
dynamic
-
-
+ or
+
retain intermediate .raw_s files
dynamic
-
@@ -346,13 +377,13 @@
dir1:dir2:...
add dir,
dir2, etc. to import path
- dynamic
+ static/:set
-
Empty the import directory list
- dynamic
+ static/:set
-
@@ -397,11 +428,7 @@
file
- Read the interface in
- file and dump it as text to
- stdout.
- mode
- -
+ See .
@@ -437,7 +464,7 @@
-
+
Interactive-mode options
@@ -465,6 +492,37 @@
static
-
+
+
+ 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
+ -
+
+
@@ -487,9 +545,15 @@
+ P
+ Compile to be part of package P
+ dynamic
+ -
+
+
P
Expose package P
- dynamic
+ static/:set
-
@@ -501,25 +565,25 @@
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.
- dynamic
+ static
-
@@ -544,62 +608,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
-
+
@@ -608,48 +679,278 @@
-
+
Don't implicitly import Prelude
dynamic
-
+
-
+
Disable the monomorphism restriction
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 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
+
+
+
+
+ Enable the “magic hash”.
+ 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 pattern type signatures.
+ dynamic
+
+
+
+
+ Enable empty data declarations.
+ dynamic
+
+
+
+
+ Enable parallel list comprehensions.
+ dynamic
+
+
+
+
+ Enable transform list comprehensions.
+ dynamic
+
+
+
+
+ Enable unlifted FFI types.
+ dynamic
+
+
+
+
+ Enable liberalised type synonyms.
+ dynamic
+
+
+
+
+ Enable type operators.
+ dynamic
+
+
+
+
+ Enable recursive do (mdo) notation.
+ 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 bang patterns.
+
+ Enable deriving for the Data and Typeable classes.
dynamic
-
+
+
+
+
+ Enable newtype deriving.
+ dynamic
+
+
+
+
+ Enable type synonyms.
+ dynamic
+
+
+
+
+ Enable flexible contexts.
+ dynamic
+
+
+
+
+ Enable flexible instances.
+ dynamic
+
+
+
+
+ Enable constrained class methods.
+ dynamic
+
+
+
+
+ Enable multi parameter type classes.
+ dynamic
+
+
+
+
+ Enable functional dependencies.
+ dynamic
+
@@ -686,7 +987,7 @@
- enable all warnings
+ enable almost all warnings (details in )
dynamic
@@ -694,7 +995,13 @@
make warnings fatal
dynamic
-
+ -Wwarn
+
+
+
+ make warnings non-fatal
+ dynamic
+ -Werror
@@ -719,6 +1026,13 @@
+
+
+ warn when the Prelude is implicitly imported
+ dynamic
+
+
+
warn when a pattern match could fail
@@ -763,8 +1077,8 @@
- warn when the module contains "orphan" instance declarations
- or rewrite rules
+ warn when the module contains orphan instance declarations
+ or rewrite rules
dynamic
@@ -784,6 +1098,13 @@
+
+ warn if there are tabs in the source file
+ dynamic
+
+
+
+
warn when defaulting happens
dynamic
@@ -791,6 +1112,13 @@
+
+ warn when the Monomorphism Restriction is applied
+ dynamic
+
+
+
+
warn about bindings that are unused
dynamic
@@ -867,7 +1195,7 @@
- Enable case-merging
+ Enable case-merging. Implied by .
dynamic
@@ -881,7 +1209,7 @@
- Enable eta-reduction
+ Enable eta-reduction. Implied by .
dynamic
@@ -901,14 +1229,6 @@
-
- Switch off all rewrite rules (including rules
- generated by automatic specialisation of overloaded functions)
- static
-
-
-
-
Ignore assertions in the source
dynamic
@@ -923,13 +1243,6 @@
-
- Tweak the liberate-case optimisation (default: 10)
- static
-
-
-
-
Don't generate interface pragmas
dynamic
@@ -945,6 +1258,14 @@
+
+ Set the number of phases for the simplifier (default 2).
+ Ignored with .
+ dynamic
+ -
+
+
+
Set the max iterations for the simplifier
dynamic
@@ -960,31 +1281,77 @@
-
- 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 full laziness (floating bindings outwards). Implied by .
dynamic
- -ffull-laziness
+ -fno-full-laziness
-
- Turn off pre-inlining
+
+ 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
+
+
+
+
+ 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
- -
+
+
+
+
+ =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 off strictness analysis
+
+ 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
+
@@ -1016,17 +1383,17 @@
-
+
Tweak unfolding settings
static
-
+
-
- Tweak unfolding settings
+
+ Turn off pre-inlining
static
-
+ -
@@ -1087,6 +1454,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
@@ -1220,7 +1620,19 @@
Omit code generation
- mode
+ dynamic
+ -
+
+
+
+ Generate byte-code
+ dynamic
+ -
+
+
+
+ Generate object code
+ dynamic
-
@@ -1245,6 +1657,12 @@
+
+ Generate position-independent code (where available)
+ static
+ -
+
+
Use dynamic Haskell libraries (if available)
static
@@ -1280,7 +1698,7 @@
- Set main function
+ Set main module and function
dynamic
-
@@ -1326,6 +1744,18 @@
static
-
+
+
+ Do not generate a manifest file (Windows only)
+ dynamic
+ -
+
+
+
+ Do not embed the manifest in the executable (Windows only)
+ dynamic
+ -
+
@@ -1367,6 +1797,18 @@
-
+ cmd
+ Use cmd as the mangler
+ dynamic
+ -
+
+
+ cmd
+ Use cmd as the splitter
+ dynamic
+ -
+
+
cmd
Use cmd as the assembler
dynamic
@@ -1385,18 +1827,19 @@
-
- cmd
- Use cmd as the dependency generator
- dyanmic
- -
-
-
cmd
Use cmd as the pre-processor
(with only)
dynamic
-
+
+ cmd
+ Use cmd as the program for
+ embedding manifests on Windows.
+ dynamic
+ -
+
@@ -1406,7 +1849,6 @@
-
@@ -1454,6 +1896,12 @@
-
+ option
+ pass option to the mangler
+ dynamic
+ -
+
+
option
pass option to the assembler
dynamic
@@ -1477,6 +1925,12 @@
dynamic
-
+
+ option
+ pass option to windres.
+ dynamic
+ -
+
@@ -1573,6 +2027,12 @@
-
+
+ Dump C-- output
+ dynamic
+ -
+
+
Dump output from CPR analysis
dynamic
@@ -1609,6 +2069,12 @@
-
+
+ Dump after instrumentation for program coverage
+ dynamic
+ -
+
+
Dump inlining info
dynamic
@@ -1621,12 +2087,24 @@
-
+
+ Dump the results of C-- to C-- optimising passes
+ dynamic
+ -
+
+
Dump parse tree
dynamic
-
+
+ Dump prepared core
+ dynamic
+ -
+
+
Dump renamer output
dynamic
@@ -1645,6 +2123,12 @@
-
+
+ Dump output from each simplifier phase
+ dynamic
+ -
+
+
Dump output from each simplifier iteration
dynamic
@@ -1657,6 +2141,12 @@
-
+
+ Dump TH spliced expressions, and what they evaluate to
+ dynamic
+ -
+
+
Dump final STG
dynamic
@@ -1687,6 +2177,18 @@
-
+
+ Trace interface files
+ dynamic
+ -
+
+
+
+ Trace typechecker
+ dynamic
+ -
+
+
Trace renamer
dynamic
@@ -1729,6 +2231,12 @@
-
+
+ C-- pass sanity checking
+ dynamic
+ -
+
+
STG pass sanity checking
dynamic
@@ -1753,9 +2261,15 @@
-
-
- Enable unregisterised compilation
- static
+
+ Print out each pass name as it happens
+ dynamic
+ -
+
+
+
+ Show statistics for fast string usage when finished
+ dynamic
-
@@ -1813,12 +2327,6 @@
dynamic
-
-
-
- Turn off printing of binding results in GHCi
- dynamic
- -
-