X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=docs%2Fusers_guide%2Fflags.xml;h=71790b05a98974f7608b8ec3bb427f1b596afe4d;hp=19e3c3d1be889afe8961de74fcb84c2ae623ba15;hb=febf1ced754a3996ac1a5877dcded87828560d1c;hpb=0f8ecdcd05627848c9eaea6c9d5e88e10e7ec78d diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml index 19e3c3d..71790b0 100644 --- a/docs/users_guide/flags.xml +++ b/docs/users_guide/flags.xml @@ -60,8 +60,8 @@ - - - display the supported language extensions + or + display the supported languages and language extensions mode - @@ -90,12 +90,6 @@ - - - display GHC documentation directory - mode - - - - output full span in error messages static @@ -260,7 +254,7 @@ dir - set output directory + set directory for object files dynamic - @@ -282,6 +276,12 @@ dynamic - + + dir + set output directory + dynamic + - + @@ -311,16 +311,16 @@ - - or - - retain intermediate .s files + or + + retain intermediate LLVM .ll files dynamic - - or - - retain intermediate .raw_s files + or + + retain intermediate .s files dynamic - @@ -434,11 +434,7 @@ file - Read the interface in - file and dump it as text to - stdout. - mode - - + See . @@ -474,7 +470,7 @@ - + Interactive-mode options @@ -503,23 +499,43 @@ - - - Generate bytecode enabled for debugging + + Break on any exception thrown dynamic - - + - - Do not include debugging information in bytecodes + + 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 results in GHCi + + + + Turn off printing of binding contents in GHCi dynamic - + + + Turn off + implicit qualified import of everything in GHCi + dynamic + - + + @@ -544,7 +560,7 @@ P Compile to be part of package P - dynamic + static - @@ -583,6 +599,12 @@ static - + + + Don't automatically link in the haskell98 package. + dynamic + - + @@ -591,7 +613,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 @@ -643,11 +667,11 @@ - + Enable record field disambiguation dynamic - + @@ -682,19 +706,31 @@ + + 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 @@ -720,6 +756,13 @@ + + Enable generalised algebraic data type syntax. + + dynamic + + + Enable type families. dynamic @@ -733,6 +776,13 @@ + + Enable do not generalise local bindings. + + dynamic + + + Enable Template Haskell. No longer implied by . @@ -740,7 +790,13 @@ - + + Enable quasiquotation. + dynamic + + + + Enable bang patterns. dynamic @@ -758,24 +814,61 @@ + + Enable view patterns. + dynamic + + + - Enable unicode syntax. + Enable unicode syntax. dynamic - Enable the “magic hash”. + Allow "#" as a postfix modifier on identifiers. dynamic + + Enable explicit universal quantification. + Implied by , + , + , + , + , + + + dynamic + + + - Enable polymorphic components. + 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 @@ -783,17 +876,11 @@ - Enable kind signatures. + Enable kind signatures. dynamic - - Enable pattern type signatures. - dynamic - - - Enable empty data declarations. dynamic @@ -806,28 +893,28 @@ - - Enable unlifted FFI types. + + Enable generalised list comprehensions. dynamic - + - - - Enable partially applied type synonyms. + + + Enable monad comprehensions. dynamic - + - - Enable rank-2 types. + + Enable unlifted FFI types. dynamic - + - - Enable rank-N types. + + Enable liberalised type synonyms. dynamic - + @@ -836,8 +923,14 @@ + + Enable recursive do notation. + dynamic + + + - Enable recursive do (mdo) notation. + Enable recursive do (mdo) notation. This is deprecated; please use recursive do notation instead. dynamic @@ -849,19 +942,19 @@ - Enable record wildcards. + Enable record wildcards. dynamic - - Enable record puns. + + Enable record puns. dynamic - + - Enable the disambiguate fields. exception + Enable record field disambiguation. dynamic @@ -873,37 +966,44 @@ - Enable standalone deriving. + Enable standalone deriving. dynamic - Enable deriving for the Data and Typeable classes. + Enable deriving for the Data and Typeable classes. dynamic + + Enable newtype deriving. + dynamic + + + - Enable type synonyms. + Enable type synonyms in instance heads. dynamic - Enable flexible contexts. + Enable flexible contexts. dynamic - Enable flexible instances. - dynamic + Enable flexible instances. + Implies + dynamic - Enable constrained class methods. + Enable constrained class methods. dynamic @@ -920,10 +1020,10 @@ - - Enable newtype deriving. + + Enable package-qualified imports. dynamic - + @@ -978,10 +1078,24 @@ - - warn about uses of functions & types that are deprecated + + 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 commandline flags that are deprecated dynamic - + @@ -1000,6 +1114,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 @@ -1014,6 +1136,13 @@ + + warn when a pattern match in a lambda expression or pattern binding could fail + dynamic + + + + warn when a record update could fail dynamic @@ -1021,6 +1150,13 @@ + + warn when a pattern binding looks lazy but must be strict + dynamic + + + + warn when fields of a record are uninitialised dynamic @@ -1028,6 +1164,14 @@ + + warn when an import declaration does not explicitly + list all the names brought into scope + dynamic + + + + warn when class methods are undefined dynamic @@ -1042,6 +1186,13 @@ + + warn about polymorphic local bindings without signatures + dynamic + + + + warn when names are shadowed dynamic @@ -1050,8 +1201,8 @@ - warn when the module contains "orphan" instance declarations - or rewrite rules + warn when the module contains orphan instance declarations + or rewrite rules dynamic @@ -1064,13 +1215,6 @@ - - warn about lambda-patterns that can fail - dynamic - - - - warn if there are tabs in the source file dynamic @@ -1112,6 +1256,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 + + + @@ -1181,6 +1339,13 @@ + + Share specialisations of overloaded functions (default) + dynamic + + + + Enable eta-reduction. Implied by . dynamic @@ -1231,6 +1396,14 @@ + + Set the number of phases for the simplifier (default 2). + Ignored with . + dynamic + - + + + Set the max iterations for the simplifier dynamic @@ -1253,6 +1426,13 @@ + + Turn on specialisation of overloaded functions. Implied by . + dynamic + -fno-specialise + + + Turn on full laziness (floating bindings outwards). Implied by . dynamic @@ -1260,12 +1440,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 - + @@ -1275,6 +1462,14 @@ -fno-strictness + + =n + Run an additional strictness analysis before simplifier +phase n + dynamic + - + + Turn on the SpecConstr transformation. Implied by . @@ -1283,6 +1478,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 @@ -1290,11 +1501,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 - + @@ -1326,13 +1543,6 @@ - - Tweak unfolding settings - static - - - - Tweak unfolding settings static @@ -1345,6 +1555,20 @@ static - + + + + Turn off the coercion optimiser + static + - + + + + + Turn on eager blackholing + dynamic + - + @@ -1369,21 +1593,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 @@ -1394,7 +1618,7 @@ - Turn on ticky-ticky profiling + Turn on ticky-ticky profiling static - @@ -1427,7 +1651,7 @@ - Directory to deposit .mix files during compilation + Directory to deposit .mix files during compilation (default is .hpc) dynamic @@ -1513,33 +1737,6 @@ - C compiler options - - - - - - - Flag - Description - Static/Dynamic - Reverse - - - - - file - Include file when - compiling the .hc file - dynamic - - - - - - - - - Code generation options @@ -1559,11 +1756,11 @@ Use the native code generator dynamic - -fvia-C + -fllvm - - Compile via C + + Compile via LLVM dynamic -fasm @@ -1607,6 +1804,12 @@ + + Generate a shared library (as opposed to an executable) + dynamic + - + + Generate position-independent code (where available) static @@ -1619,6 +1822,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. @@ -1665,6 +1875,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 @@ -1695,6 +1920,12 @@ - + + Enable runtime event tracing + static + - + + Do not generate a manifest file (Windows only) dynamic @@ -1706,6 +1937,21 @@ 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 + - + @@ -1745,13 +1991,19 @@ Use cmd as the C compiler dynamic - + + cmd + Use cmd as the LLVM optimiser + dynamic + - - cmd - Use cmd as the mangler + cmd + Use cmd as the LLVM compiler dynamic - + cmd Use cmd as the splitter @@ -1796,6 +2048,8 @@ + + @@ -1846,6 +2100,18 @@ - + option + pass option to the LLVM optimiser + dynamic + - + + + option + pass option to the LLVM compiler + dynamic + - + + option pass option to the mangler dynamic @@ -1870,12 +2136,6 @@ - - option - pass option to the dependency generator - dynamic - - - - option pass option to windres. dynamic @@ -1901,6 +2161,14 @@ Reverse + + + + (x86 only) Use SSE2 for floating point + dynamic + - + + @@ -1933,7 +2201,7 @@ Generate .hcr external Core files - static + dynamic - @@ -1965,6 +2233,12 @@ - + + Dump to files instead of stdout + dynamic + - + + Dump assembly dynamic @@ -1983,6 +2257,13 @@ - + + Print a one-line summary of the size of the Core program + at the end of the optimisation pipeline + dynamic + - + + Dump output from CPR analysis dynamic @@ -2020,7 +2301,7 @@ - Dump after intrumentation for program coverage + Dump after instrumentation for program coverage dynamic - @@ -2031,6 +2312,12 @@ - + + Dump LLVM intermediate code + dynamic + - + + Dump occurrence analysis output dynamic @@ -2061,11 +2348,29 @@ - - - Dump rules + + Dump rule firing info + dynamic + - + + + + Dump detailed rule firing info dynamic - + + + Dump rules + dynamic + - + + + + Dump vectoriser input and output + dynamic + - + Dump final simplifier output @@ -2073,6 +2378,12 @@ - + + Dump output from each simplifier phase + dynamic + - + + Dump output from each simplifier iteration dynamic @@ -2086,7 +2397,7 @@ - Dump TH splided expressions, and what they evaluate to + Dump TH spliced expressions, and what they evaluate to dynamic - @@ -2126,12 +2437,18 @@ dynamic - - - - Trace typechecker - dynamic - - - + + + Trace typechecker + dynamic + - + + + + Trace vectoriser + dynamic + - + Trace renamer @@ -2151,6 +2468,12 @@ - + + Suppress unsolicited debugging output + static + - + + Turn on debug printing (more verbose) static @@ -2169,6 +2492,60 @@ - + + Set the width of debugging output. For example + static + - + + + + Print single alternative case expressions as strict lets. + static + - + + + + In core dumps, suppress everything that is suppressable. + static + - + + + + Suppress the printing of uniques in debug output (easier to use diff) + static + - + + + + Suppress extended information about identifiers where they are bound + static + - + + + + Suppress the printing of module qualification prefixes + static + - + + + + Suppress type signatures + static + - + + + + Suppress type applications + static + - + + + + Suppress the printing of coercions in Core dumps to make them shorter + static + - + + Dump haskell source stats dynamic @@ -2216,12 +2593,6 @@ dynamic - - - - Enable unregisterised compilation - static - - - @@ -2254,12 +2625,6 @@ - - - Don't share specialisations of overloaded functions - static - - - - Set simplification history size static @@ -2272,8 +2637,8 @@ - - - Turn off assembly mangling (use instead) + + Turn off the GHCi sandbox. Means computations are run in teh main thread, rather than a forked thread. dynamic - @@ -2295,7 +2660,6 @@ Misc: