X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=21807d7f6adfa902978a7553c987f3b325c12494;hb=f555abffd676544cd13d022bf1eb829e63f7aebe;hp=958fa3ce4dc1f4a5de00ef3c88d6b251dae19017;hpb=6e0c3f50e131f502577a61b09a339af295de9d23;p=ghc-hetmet.git
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index 958fa3c..21807d7 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 versionmode
@@ -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 filesdynamic-
-
+ or
+ retain intermediate .s filesdynamic-
-
+ or
+ retain intermediate .raw_s filesdynamic-
@@ -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 .
@@ -426,18 +453,18 @@
-
+ Turn off recompilation checking; implied by any
optiondynamic
-
+
-
+ 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
+ -
+
+ PExpose package P
- dynamic
+ static/:set-
@@ -501,25 +565,25 @@
nameHide package P
- dynamic
+ static/:set-nameIgnore package P
- dynamic
+ static/:set-fileLoad more packages from file
- dynamic
+ static-Don't load the user's package config file.
- dynamic
+ static-
@@ -544,61 +608,69 @@
-
- Enable overlapping instances
+
+ Enable most language extensionsdynamic
-
+
-
- Enable undecidable instances
+
+ Enable overlapping instancesdynamic
-
+
-
- Enable incoherent instances.
- Implies
+
+ Enable incoherent instances.
+ Implies dynamic
-
+
-
- Enable arrow notation extension
+
+ Enable undecidable instancesdynamic
-
+ n
- set the limit for context reduction
+ set the limit for context reduction. Default is 20.dynamic
-
+
- or
- Enable foreign function interface (implied by
- )
+
+ Enable arrow
+ notation extensiondynamic
-
+
-
- Enable generics
+
+ Enable record
+ field disambiguationdynamic
-
+
-
- Enable most language extensions
+
+ Enable foreign function interface (implied by
+ )dynamic
-
+
+
+
+
+ Enable generic classes
+ dynamic
+
-
- Enable Implicit Parameters.
+
+ Enable Implicit Parameters.
Implied by .dynamic
-
+
@@ -607,42 +679,278 @@
-
+ Don't implicitly import Preludedynamic
-
+
+
+
+
+ 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
+
-
- Disable the monomorphism restriction
+
+ Enable overloaded string literals.
+ dynamic
-
+
-
- Make pattern bindings polymorphic
+
+ Enable generalised algebraic data types.
+ dynamic
-
+
-
- Use GHCi's extended default rules in a normal module
+
+ Enable type families.dynamic
-
+
-
- Enable lexically-scoped type variables.
+
+ Enable lexically-scoped type variables.
Implied by .dynamic
-
+
-
- Enable Template Haskell.
+
+ 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 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
+
@@ -679,7 +987,7 @@
- enable all warnings
+ enable almost all warnings (details in )dynamic
@@ -687,7 +995,13 @@
make warnings fataldynamic
-
+ -Wwarn
+
+
+
+ make warnings non-fatal
+ dynamic
+ -Werror
@@ -712,6 +1026,13 @@
+
+
+ warn when the Prelude is implicitly imported
+ dynamic
+
+
+
warn when a pattern match could fail
@@ -727,13 +1048,6 @@
-
- enable miscellaneous warnings
- dynamic
-
-
-
- warn when fields of a record are uninitialiseddynamic
@@ -762,9 +1076,9 @@
-
- warn when the module contains "orphan" instance declarations
- or rewrite rules
+
+ warn when the module contains orphan instance declarations
+ or rewrite rulesdynamic
@@ -784,6 +1098,13 @@
+
+ warn if there are tabs in the source file
+ dynamic
+
+
+
+ warn when defaulting happensdynamic
@@ -791,6 +1112,13 @@
+
+ warn when the Monomorphism Restriction is applied
+ dynamic
+
+
+
+ warn about bindings that are unuseddynamic
@@ -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 sourcedynamic
@@ -923,13 +1243,6 @@
-
- Tweak the liberate-case optimisation (default: 10)
- static
-
-
-
- Don't generate interface pragmasdynamic
@@ -945,6 +1258,14 @@
+
+ Set the number of phases for the simplifier (default 2).
+ Ignored with .
+ dynamic
+ -
+
+
+ Set the max iterations for the simplifierdynamic
@@ -960,31 +1281,70 @@
-
- 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
+
+
+
+ =n
+ Set the size threshold for the liberate-case transformation to n (default: 200)
+ static
+
@@ -1016,17 +1376,17 @@
-
+ Tweak unfolding settingsstatic
-
+
-
- Tweak unfolding settings
+
+ Turn off pre-inliningstatic
-
+ -
@@ -1064,12 +1424,6 @@
-
- Auto-add _scc_s to all dictionaries
- static
-
-
- Auto-add _scc_s to all CAFsstatic
@@ -1093,9 +1447,9 @@
- Parallelism options
-
-
+ Program coverage options
+
+
@@ -1109,21 +1463,45 @@
-
- Enable GRANSIM
+
+ Turn on Haskell program coverage instrumentationstatic
- -
+
-
- Enable Parallel Haskell
- static
- -
+
+ Directory to deposit .mix files during compilation (default is .hpc)
+ dynamic
+
+
+
+
+
+
+
+ Haskell pre-processor options
+
+
+
+
+
+
-
- Enable SMP support
- static
+ Flag
+ Description
+ Static/Dynamic
+ Reverse
+
+
+
+
+
+
+ Enable the use of a pre-processor
+ (set with )
+
+ dynamic-
@@ -1235,7 +1613,19 @@
Omit code generation
- mode
+ dynamic
+ -
+
+
+
+ Generate byte-code
+ dynamic
+ -
+
+
+
+ Generate object code
+ dynamic-
@@ -1260,6 +1650,12 @@
+
+ Generate position-independent code (where available)
+ static
+ -
+
+ Use dynamic Haskell libraries (if available)static
@@ -1295,7 +1691,7 @@
- Set main function
+ Set main module and functiondynamic-
@@ -1318,12 +1714,6 @@
-
- name
- Link in package name
- dynamic
- -
-
- Split objects (for libraries)dynamic
@@ -1347,6 +1737,18 @@
static-
+
+
+ Do not generate a manifest file (Windows only)
+ dynamic
+ -
+
+
+
+ Do not embed the manifest in the executable (Windows only)
+ dynamic
+ -
+
@@ -1388,6 +1790,18 @@
-
+ cmd
+ Use cmd as the mangler
+ dynamic
+ -
+
+
+ cmd
+ Use cmd as the splitter
+ dynamic
+ -
+
+ cmdUse cmd as the assemblerdynamic
@@ -1406,18 +1820,19 @@
-
- cmd
- Use cmd as the dependency generator
- dyanmic
- -
-
- cmdUse cmd as the pre-processor
(with only)dynamic-
+
+ cmd
+ Use cmd as the program for
+ embedding manifests on Windows.
+ dynamic
+ -
+
@@ -1427,7 +1842,6 @@
-
@@ -1475,6 +1889,12 @@
-
+ option
+ pass option to the mangler
+ dynamic
+ -
+
+ optionpass option to the assemblerdynamic
@@ -1498,6 +1918,12 @@
dynamic-
+
+ option
+ pass option to windres.
+ dynamic
+ -
+
@@ -1520,13 +1946,7 @@
-
- (SPARC only) enable version 8 support
- static
- -
-
-
-
+ (x86 only) give some registers back to the C compilerdynamic-
@@ -1588,12 +2008,6 @@
-
-
- Dump abstract C
- dynamic
- -
-
- Dump assemblydynamic
@@ -1606,6 +2020,12 @@
-
+
+ Dump C-- output
+ dynamic
+ -
+
+ Dump output from CPR analysisdynamic
@@ -1642,6 +2062,12 @@
-
+
+ Dump after instrumentation for program coverage
+ dynamic
+ -
+
+ Dump inlining infodynamic
@@ -1654,14 +2080,20 @@
-
+
+ Dump the results of C-- to C-- optimising passes
+ dynamic
+ -
+
+ Dump parse treedynamic-
-
- Dump “real” C
+
+ Dump prepared coredynamic-
@@ -1678,14 +2110,14 @@
-
-
- Dump saturated output
+
+ Dump final simplifier outputdynamic-
-
- Dump final simplifier output
+
+ Dump output from each simplifier phasedynamic-
@@ -1702,6 +2134,12 @@
-
+
+ Dump TH spliced expressions, and what they evaluate to
+ dynamic
+ -
+
+ Dump final STGdynamic
@@ -1726,32 +2164,32 @@
-
-
- Dump UsageSP analysis output
+
+ Dump worker-wrapper outputdynamic-
-
- Dump worker-wrapper output
+
+ Trace interface filesdynamic-
-
- Trace renamer
+
+ Trace typecheckerdynamic-
-
- Renamer stats
+
+ Trace renamerdynamic-
-
- Native code generator intermediate form
+
+ Renamer statsdynamic-
@@ -1786,20 +2224,20 @@
-
-
- STG pass sanity checking
+
+ C-- pass sanity checkingdynamic-
-
- Dump STG stats
+
+ STG pass sanity checkingdynamic-
-
- UsageSP sanity checker
+
+ Dump STG statsdynamic-
@@ -1816,9 +2254,15 @@
-
-
- Enable unregisterised compilation
- static
+
+ Print out each pass name as it happens
+ dynamic
+ -
+
+
+
+ Show statistics for fast string usage when finished
+ dynamic-
@@ -1841,12 +2285,6 @@
-
- ???
- static
- -
-
- Don't complain about .hi file mismatchesstatic