X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=978ddf7464aeb50c19129741eb57978f575f4309;hp=e6e22fe3e79f0b3cca36f86bfe4c4533fec9b604;hb=432b9c9322181a3644083e3c19b7e240d90659e7;hpb=70dd3e6b74d368f2df585c18d86426373e7e89e5 diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml index e6e22fe..978ddf7 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 - @@ -226,7 +254,7 @@ dir - set output directory + set directory for object files dynamic - @@ -248,6 +276,12 @@ dynamic - + + dir + set output directory + dynamic + - + @@ -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,44 @@ 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 + - + + + + Turn off + implicit qualified import of everything in GHCi + dynamic + - + + @@ -487,9 +558,15 @@ + P + Compile to be part of package P + dynamic + - + + P Expose package P - dynamic + static/:set - @@ -501,25 +578,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 - @@ -530,7 +607,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 @@ -544,61 +623,69 @@ - - Enable overlapping instances + + Enable most language extensions dynamic - + - - Enable undecidable instances + + Enable overlapping instances dynamic - + - - Enable incoherent instances. - Implies + + Enable incoherent instances. + Implies dynamic - + - - Enable arrow notation extension + + Enable undecidable instances dynamic - + - n - set the limit for context reduction - static - + n + set the limit for context reduction. Default is 20. + dynamic + - or - Enable foreign function interface (implied by - ) + + Enable arrow + notation extension dynamic - + - - Enable generics + + Enable record + field disambiguation dynamic - + - - 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,30 +694,285 @@ - + Don't implicitly import Prelude dynamic - + + + + + Disable the monomorphism restriction + dynamic + - - Disable the monomorphism restriction + + Make pattern bindings polymorphic dynamic - + - - Enable lexically-scoped type variables. + + 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. + + 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 new + qualified operator syntax + 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 (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 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 + @@ -640,7 +982,7 @@ Warnings - ( + @@ -667,7 +1009,7 @@ - enable all warnings + enable almost all warnings (details in ) dynamic @@ -675,14 +1017,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 are deprecated + + warn about uses of functions & types that have warnings or deprecated pragmas dynamic - + + + + + + warn about uses of commandline flags that are deprecated + dynamic + @@ -700,6 +1062,13 @@ + + + warn when the Prelude is implicitly imported + dynamic + + + warn when a pattern match could fail @@ -715,13 +1084,6 @@ - - enable miscellaneous warnings - dynamic - - - - warn when fields of a record are uninitialised dynamic @@ -750,9 +1112,9 @@ - - warn when the module contains "orphan" instance declarations - or rewrite rules + + warn when the module contains orphan instance declarations + or rewrite rules dynamic @@ -772,6 +1134,13 @@ + + warn if there are tabs in the source file + dynamic + + + + warn when defaulting happens dynamic @@ -779,6 +1148,13 @@ + + warn when the Monomorphism Restriction is applied + dynamic + + + + warn about bindings that are unused dynamic @@ -855,7 +1231,7 @@ - Enable case-merging + Enable case-merging. Implied by . dynamic @@ -868,8 +1244,15 @@ + + Share specialisations of overloaded functions (default) + dynamic + + + + - Enable eta-reduction + Enable eta-reduction. Implied by . dynamic @@ -889,14 +1272,6 @@ - - Switch off all rewrite rules (including rules - generated by automatic specialisation of overloaded functions) - static - - - - Ignore assertions in the source dynamic @@ -911,13 +1286,6 @@ - - Tweak the liberate-case optimisation (default: 10) - static - - - - Don't generate interface pragmas dynamic @@ -933,6 +1301,14 @@ + + Set the number of phases for the simplifier (default 2). + Ignored with . + dynamic + - + + + Set the max iterations for the simplifier dynamic @@ -948,31 +1324,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 - - + - - 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 + @@ -1004,17 +1426,24 @@ - + Tweak unfolding settings static - + - - Tweak unfolding settings + + Turn off pre-inlining static - + - + + + + + Turn on eager blackholing + dynamic + - @@ -1041,26 +1470,20 @@ Auto-add _scc_s to all exported functions - static + dynamic Auto-add _scc_s to all top-level functions - static + dynamic - - Auto-add _scc_s to all dictionaries - static - - - Auto-add _scc_s to all CAFs - static + dynamic @@ -1081,9 +1504,9 @@ - Parallelism options - - + Program coverage options + + @@ -1097,21 +1520,45 @@ - - Enable GRANSIM + + Turn on Haskell program coverage instrumentation static - - + - - 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 - @@ -1223,7 +1670,19 @@ Omit code generation - mode + dynamic + - + + + + Generate byte-code + dynamic + - + + + + Generate object code + dynamic - @@ -1248,6 +1707,12 @@ + + Generate position-independent code (where available) + static + - + + Use dynamic Haskell libraries (if available) static @@ -1283,7 +1748,7 @@ - Set main function + Set main module and function dynamic - @@ -1306,12 +1771,6 @@ - - name - Link in package name - dynamic - - - - Split objects (for libraries) dynamic @@ -1335,6 +1794,18 @@ static - + + + Do not generate a manifest file (Windows only) + dynamic + - + + + + Do not embed the manifest in the executable (Windows only) + dynamic + - + @@ -1376,6 +1847,18 @@ - + cmd + Use cmd as the mangler + dynamic + - + + + cmd + Use cmd as the splitter + dynamic + - + + cmd Use cmd as the assembler dynamic @@ -1394,18 +1877,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 + - + @@ -1415,7 +1899,6 @@ - @@ -1463,6 +1946,12 @@ - + option + pass option to the mangler + dynamic + - + + option pass option to the assembler dynamic @@ -1481,8 +1970,8 @@ - - option - pass option to the dependency generator + option + pass option to windres. dynamic - @@ -1508,13 +1997,7 @@ - - (SPARC only) enable version 8 support - static - - - - - + (x86 only) give some registers back to the C compiler dynamic - @@ -1576,12 +2059,6 @@ - - - Dump abstract C - dynamic - - - - Dump assembly dynamic @@ -1594,6 +2071,12 @@ - + + Dump C-- output + dynamic + - + + Dump output from CPR analysis dynamic @@ -1630,6 +2113,12 @@ - + + Dump after instrumentation for program coverage + dynamic + - + + Dump inlining info dynamic @@ -1642,14 +2131,20 @@ - + + Dump the results of C-- to C-- optimising passes + dynamic + - + + Dump parse tree dynamic - - - Dump “real” C + + Dump prepared core dynamic - @@ -1666,14 +2161,14 @@ - - - Dump saturated output + + Dump final simplifier output dynamic - - - Dump final simplifier output + + Dump output from each simplifier phase dynamic - @@ -1690,6 +2185,12 @@ - + + Dump TH spliced expressions, and what they evaluate to + dynamic + - + + Dump final STG dynamic @@ -1714,14 +2215,20 @@ - - - Dump UsageSP analysis output + + Dump worker-wrapper output dynamic - - - Dump worker-wrapper output + + Trace interface files + dynamic + - + + + + Trace typechecker dynamic - @@ -1738,15 +2245,15 @@ - - - Native code generator intermediate form + + Dump simplifier stats dynamic - - - Dump simplifier stats - dynamic + + Suppress unsolicited debugging output + static - @@ -1756,6 +2263,12 @@ - + + Suppress the printing of uniques in debug output (easier to use diff. + static + - + + Don't output pragma info in dumps static @@ -1774,20 +2287,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 - @@ -1804,9 +2317,15 @@ - - - Enable unregisterised compilation - static + + Print out each pass name as it happens + dynamic + - + + + + Show statistics for fast string usage when finished + dynamic - @@ -1829,12 +2348,6 @@ - - ??? - static - - - - Don't complain about .hi file mismatches static @@ -1847,12 +2360,6 @@ - - - Don't share specialisations of overloaded functions - static - - - - Set simplification history size static