X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=27c0ddab6c05a7f1c0278004ea53ba4010f51305;hp=6b348fec7fd4b421052f9b2e40cc0b5cbe2e1b67;hb=2a4d586c8abefa2b0d2a782c421697fd6cf0c964;hpb=6da4233da131954bbc1d9922104d7bd01edc5c56
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index 6b348fe..27c0dda 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
@@ -72,12 +90,24 @@
-
+
+ display GHC documentation directory
+ mode
+ -
+
+
output full span in error messages
static
-
+ size
+ Set the minimum heap size to size
+ static
+ -
+
+
Summarise timing stats for GHC (same as +RTS -tstderr)
static
@@ -157,25 +187,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 +304,22 @@
-
+ or
+
retain intermediate .hc files
dynamic
-
-
+ or
+
retain intermediate .s files
dynamic
-
-
+ or
+
retain intermediate .raw_s files
dynamic
-
@@ -346,13 +383,13 @@
dir1:dir2:...
add dir,
dir2, etc. to import path
- dynamic
+ static/:set
-
Empty the import directory list
- dynamic
+ static/:set
-
@@ -397,11 +434,7 @@
file
- Read the interface in
- file and dump it as text to
- stdout.
- mode
- -
+ See .
@@ -426,18 +459,18 @@
-
+
Turn off recompilation checking; implied by any
option
dynamic
-
+
-
+
Interactive-mode options
@@ -465,6 +498,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 +551,15 @@
+ P
+ Compile to be part of package P
+ dynamic
+ -
+
+
P
Expose package P
- dynamic
+ static/:set
-
@@ -501,25 +571,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 +614,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 +685,260 @@
-
+
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 bang patterns.
+ dynamic
+
+
+
+
+ Enable the C preprocessor.
+ dynamic
+
+
+
+
+ Enable pattern guards.
+ dynamic
+
+
+
+
+ Enable view patterns.
+ dynamic
+
+
+
+
+ Enable unicode syntax.
+ dynamic
+
-
- Enable bang patterns.
+
+ Enable the “magic hash”.
dynamic
-
+
+
+
+
+ Enable polymorphic components.
+ 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 unlifted FFI types.
+ dynamic
+
+
+
+
+ Enable liberalised type synonyms.
+ dynamic
+
+
+
+
+ Enable rank-2 types.
+ dynamic
+
+
+
+
+ Enable rank-N types.
+ dynamic
+
+
+
+
+ Enable type operators.
+ dynamic
+
+
+
+
+ Enable recursive do (mdo) notation.
+ dynamic
+
+
+
+
+ Enable parallel arrays.
+ dynamic
+
+
+
+
+ Enable record wildcards.
+ dynamic
+
+
+
+
+ Enable record puns.
+ dynamic
+
+
+
+
+ Enable the disambiguate fields. exception
+ 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.
+ 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 +975,7 @@
- enable all warnings
+ enable almost all warnings (details in )
dynamic
@@ -694,7 +983,13 @@
make warnings fatal
dynamic
-
+ -Wwarn
+
+
+
+ make warnings non-fatal
+ dynamic
+ -Werror
@@ -719,6 +1014,13 @@
+
+
+ warn when the Prelude is implicitly imported
+ dynamic
+
+
+
warn when a pattern match could fail
@@ -734,13 +1036,6 @@
-
- enable miscellaneous warnings
- dynamic
-
-
-
-
warn when fields of a record are uninitialised
dynamic
@@ -769,9 +1064,9 @@
-
- warn when the module contains "orphan" instance declarations
- or rewrite rules
+
+ warn when the module contains orphan instance declarations
+ or rewrite rules
dynamic
@@ -791,6 +1086,13 @@
+
+ warn if there are tabs in the source file
+ dynamic
+
+
+
+
warn when defaulting happens
dynamic
@@ -798,6 +1100,13 @@
+
+ warn when the Monomorphism Restriction is applied
+ dynamic
+
+
+
+
warn about bindings that are unused
dynamic
@@ -874,7 +1183,7 @@
- Enable case-merging
+ Enable case-merging. Implied by .
dynamic
@@ -888,7 +1197,7 @@
- Enable eta-reduction
+ Enable eta-reduction. Implied by .
dynamic
@@ -908,14 +1217,6 @@
-
- Switch off all rewrite rules (including rules
- generated by automatic specialisation of overloaded functions)
- static
-
-
-
-
Ignore assertions in the source
dynamic
@@ -930,13 +1231,6 @@
-
- Tweak the liberate-case optimisation (default: 10)
- static
-
-
-
-
Don't generate interface pragmas
dynamic
@@ -967,31 +1261,55 @@
-
- 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
- static
- -
+
+ Switch on all rewrite rules (including rules
+ generated by automatic specialisation of overloaded functions).
+ Implied by .
+ dynamic
+
-
- Turn off strictness analysis
+
+ Turn on strictness analysis. Implied by .
dynamic
- -
+ -fno-strictness
+
+
+
+
+ Turn on the SpecConstr transformation. Implied by .
+ dynamic
+ -fno-spec-constr
+
+
+
+
+ Turn on the liberate-case transformation. Implied by .
+ dynamic
+ -fno-liberate-case
+
+
+
+ =n
+ Set the size threshold for function specialisation to n, for both
+ the liberate-case and SpecConstr transformations (default: 200)
+ static
+
@@ -1035,6 +1353,13 @@
static
+
+
+
+ Turn off pre-inlining
+ static
+ -
+
@@ -1071,12 +1396,6 @@
-
- Auto-add _scc_s to all dictionaries
- static
-
-
-
Auto-add _scc_s to all CAFs
static
@@ -1100,6 +1419,69 @@
+ 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
+
+
+
+
+
+
+
+ Flag
+ Description
+ Static/Dynamic
+ Reverse
+
+
+
+
+
+
+ Enable the use of a pre-processor
+ (set with )
+
+ dynamic
+ -
+
+
+
+
+
+
+
C pre-processor options
@@ -1203,7 +1585,19 @@
Omit code generation
- mode
+ dynamic
+ -
+
+
+
+ Generate byte-code
+ dynamic
+ -
+
+
+
+ Generate object code
+ dynamic
-
@@ -1228,6 +1622,12 @@
+
+ Generate position-independent code (where available)
+ static
+ -
+
+
Use dynamic Haskell libraries (if available)
static
@@ -1263,7 +1663,7 @@
- Set main function
+ Set main module and function
dynamic
-
@@ -1309,6 +1709,18 @@
static
-
+
+
+ Do not generate a manifest file (Windows only)
+ dynamic
+ -
+
+
+
+ Do not embed the manifest in the executable (Windows only)
+ dynamic
+ -
+
@@ -1350,6 +1762,18 @@
-
+ cmd
+ Use cmd as the mangler
+ dynamic
+ -
+
+
+ cmd
+ Use cmd as the splitter
+ dynamic
+ -
+
+
cmd
Use cmd as the assembler
dynamic
@@ -1368,18 +1792,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
+ -
+
@@ -1389,7 +1814,6 @@
-
@@ -1437,6 +1861,12 @@
-
+ option
+ pass option to the mangler
+ dynamic
+ -
+
+
option
pass option to the assembler
dynamic
@@ -1460,6 +1890,12 @@
dynamic
-
+
+ option
+ pass option to windres.
+ dynamic
+ -
+
@@ -1482,13 +1918,7 @@
-
- (SPARC only) enable version 8 support
- static
- -
-
-
-
+
(x86 only) give some registers back to the C compiler
dynamic
-
@@ -1550,12 +1980,6 @@
-
-
- Dump abstract C
- dynamic
- -
-
-
Dump assembly
dynamic
@@ -1568,6 +1992,12 @@
-
+
+ Dump C-- output
+ dynamic
+ -
+
+
Dump output from CPR analysis
dynamic
@@ -1604,6 +2034,12 @@
-
+
+ Dump after instrumentation for program coverage
+ dynamic
+ -
+
+
Dump inlining info
dynamic
@@ -1616,14 +2052,20 @@
-
+
+ Dump the results of C-- to C-- optimising passes
+ dynamic
+ -
+
+
Dump parse tree
dynamic
-
-
- Dump “real” C
+
+ Dump prepared core
dynamic
-
@@ -1640,12 +2082,6 @@
-
-
- Dump saturated output
- dynamic
- -
-
-
Dump final simplifier output
dynamic
@@ -1664,6 +2100,12 @@
-
+
+ Dump TH spliced expressions, and what they evaluate to
+ dynamic
+ -
+
+
Dump final STG
dynamic
@@ -1688,32 +2130,32 @@
-
-
- Dump UsageSP analysis output
+
+ Dump worker-wrapper output
dynamic
-
-
- Dump worker-wrapper output
+
+ Trace interface files
dynamic
-
-
- Trace renamer
+
+ Trace typechecker
dynamic
-
-
- Renamer stats
+
+ Trace renamer
dynamic
-
-
- Native code generator intermediate form
+
+ Renamer stats
dynamic
-
@@ -1748,20 +2190,20 @@
-
-
- STG pass sanity checking
+
+ C-- pass sanity checking
dynamic
-
-
- Dump STG stats
+
+ STG pass sanity checking
dynamic
-
-
- UsageSP sanity checker
+
+ Dump STG stats
dynamic
-
@@ -1778,9 +2220,15 @@
-
-
- Enable unregisterised compilation
- static
+
+ Print out each pass name as it happens
+ dynamic
+ -
+
+
+
+ Show statistics for fast string usage when finished
+ dynamic
-
@@ -1803,12 +2251,6 @@
-
- ???
- static
- -
-
-
Don't complain about .hi file mismatches
static