diff options
author | Thomas Miedema <thomasmiedema@gmail.com> | 2016-06-09 13:26:35 +0200 |
---|---|---|
committer | Thomas Miedema <thomasmiedema@gmail.com> | 2016-06-09 13:33:36 +0200 |
commit | e703a232174fd6e6cc42f2b27a2d9a2a17957aa7 (patch) | |
tree | 548d9eac270bad7a85fa2bd06b6ab0ac49dcc745 /utils/mkUserGuidePart | |
parent | 9dbf354fbc35d412e442271fb1ed805f2f279b09 (diff) | |
download | haskell-e703a232174fd6e6cc42f2b27a2d9a2a17957aa7.tar.gz |
Docs: fix links to ghc-flags
Diffstat (limited to 'utils/mkUserGuidePart')
-rw-r--r-- | utils/mkUserGuidePart/Options/Language.hs | 70 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Linking.hs | 4 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Misc.hs | 2 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Optimizations.hs | 50 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Phases.hs | 2 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/RecompilationChecking.hs | 2 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Verbosity.hs | 6 | ||||
-rw-r--r-- | utils/mkUserGuidePart/Options/Warnings.hs | 28 |
8 files changed, 82 insertions, 82 deletions
diff --git a/utils/mkUserGuidePart/Options/Language.hs b/utils/mkUserGuidePart/Options/Language.hs index 7dd8429ed7..1bc0624155 100644 --- a/utils/mkUserGuidePart/Options/Language.hs +++ b/utils/mkUserGuidePart/Options/Language.hs @@ -72,7 +72,7 @@ languageOptions = "As of GHC 7.10, this option is not needed, and should not be "++ "used. Previously this would automatically :ref:`derive Typeable "++ "instances for every datatype and type class declaration "++ - "<deriving-typeable>`. Implies :ghc-flag:`XDeriveDataTypeable`." + "<deriving-typeable>`. Implies :ghc-flag:`-XDeriveDataTypeable`." , flagType = DynamicFlag , flagReverse = "-XNoAutoDeriveTypeable" , flagSince = "7.8.1" @@ -141,7 +141,7 @@ languageOptions = , flag { flagName = "-XDeriveDataTypeable" , flagDescription = "Enable ``deriving`` for the :ref:`Data class "++ - "<deriving-typeable>`. Implied by :ghc-flag:`XAutoDeriveTypeable`." + "<deriving-typeable>`. Implied by :ghc-flag:`-XAutoDeriveTypeable`." , flagType = DynamicFlag , flagReverse = "-XNoDeriveDataTypeable" , flagSince = "6.8.1" @@ -149,7 +149,7 @@ languageOptions = , flag { flagName = "-XDeriveFunctor" , flagDescription = "Enable :ref:`deriving for the Functor class <deriving-extra>`. "++ - "Implied by :ghc-flag:`XDeriveTraversable`." + "Implied by :ghc-flag:`-XDeriveTraversable`." , flagType = DynamicFlag , flagReverse = "-XNoDeriveFunctor" , flagSince = "7.10.1" @@ -157,7 +157,7 @@ languageOptions = , flag { flagName = "-XDeriveFoldable" , flagDescription = "Enable :ref:`deriving for the Foldable class <deriving-extra>`. "++ - "Implied by :ghc-flag:`XDeriveTraversable`." + "Implied by :ghc-flag:`-XDeriveTraversable`." , flagType = DynamicFlag , flagReverse = "-XNoDeriveFoldable" , flagSince = "7.10.1" @@ -186,7 +186,7 @@ languageOptions = , flag { flagName = "-XDeriveTraversable" , flagDescription = "Enable :ref:`deriving for the Traversable class <deriving-extra>`. "++ - "Implies :ghc-flag:`XDeriveFunctor` and :ghc-flag:`XDeriveFoldable`." + "Implies :ghc-flag:`-XDeriveFunctor` and :ghc-flag:`-XDeriveFoldable`." , flagType = DynamicFlag , flagReverse = "-XNoDeriveTraversable" , flagSince = "7.10.1" @@ -194,7 +194,7 @@ languageOptions = , flag { flagName = "-XDisambiguateRecordFields" , flagDescription = "Enable :ref:`record field disambiguation <disambiguate-fields>`. "++ - "Implied by :ghc-flag:`XRecordWildCards`." + "Implied by :ghc-flag:`-XRecordWildCards`." , flagType = DynamicFlag , flagReverse = "-XNoDisambiguateRecordFields" , flagSince = "6.8.1" @@ -222,8 +222,8 @@ languageOptions = , flag { flagName = "-XExplicitForAll" , flagDescription = "Enable :ref:`explicit universal quantification <explicit-foralls>`."++ - " Implied by :ghc-flag:`XScopedTypeVariables`, :ghc-flag:`XLiberalTypeSynonyms`,"++ - " :ghc-flag:`XRankNTypes` and :ghc-flag:`XExistentialQuantification`." + " Implied by :ghc-flag:`-XScopedTypeVariables`, :ghc-flag:`-XLiberalTypeSynonyms`,"++ + " :ghc-flag:`-XRankNTypes` and :ghc-flag:`-XExistentialQuantification`." , flagType = DynamicFlag , flagReverse = "-XNoExplicitForAll" , flagSince = "6.12.1" @@ -232,7 +232,7 @@ languageOptions = , flagDescription = "Enable using the keyword ``type`` to specify the namespace of "++ "entries in imports and exports (:ref:`explicit-namespaces`). "++ - "Implied by :ghc-flag:`XTypeOperators` and :ghc-flag:`XTypeFamilies`." + "Implied by :ghc-flag:`-XTypeOperators` and :ghc-flag:`-XTypeFamilies`." , flagType = DynamicFlag , flagReverse = "-XNoExplicitNamespaces" , flagSince = "7.6.1" @@ -248,7 +248,7 @@ languageOptions = , flag { flagName = "-XFlexibleContexts" , flagDescription = "Enable :ref:`flexible contexts <flexible-contexts>`. Implied by "++ - ":ghc-flag:`XImplicitParams`." + ":ghc-flag:`-XImplicitParams`." , flagType = DynamicFlag , flagReverse = "-XNoFlexibleContexts" , flagSince = "6.8.1" @@ -256,8 +256,8 @@ languageOptions = , flag { flagName = "-XFlexibleInstances" , flagDescription = "Enable :ref:`flexible instances <instance-rules>`. "++ - "Implies :ghc-flag:`XTypeSynonymInstances`. "++ - "Implied by :ghc-flag:`XImplicitParams`." + "Implies :ghc-flag:`-XTypeSynonymInstances`. "++ + "Implied by :ghc-flag:`-XImplicitParams`." , flagType = DynamicFlag , flagReverse = "-XNoFlexibleInstances" , flagSince = "6.8.1" @@ -272,7 +272,7 @@ languageOptions = , flag { flagName = "-XFunctionalDependencies" , flagDescription = "Enable :ref:`functional dependencies <functional-dependencies>`. "++ - "Implies :ghc-flag:`XMultiParamTypeClasses`." + "Implies :ghc-flag:`-XMultiParamTypeClasses`." , flagType = DynamicFlag , flagReverse = "-XNoFunctionalDependencies" , flagSince = "6.8.1" @@ -280,7 +280,7 @@ languageOptions = , flag { flagName = "-XGADTs" , flagDescription = "Enable :ref:`generalised algebraic data types <gadt>`. "++ - "Implies :ghc-flag:`XGADTSyntax` and :ghc-flag:`XMonoLocalBinds`." + "Implies :ghc-flag:`-XGADTSyntax` and :ghc-flag:`-XMonoLocalBinds`." , flagType = DynamicFlag , flagReverse = "-XNoGADTs" , flagSince = "6.8.1" @@ -311,7 +311,7 @@ languageOptions = , flag { flagName = "-XImplicitParams" , flagDescription = "Enable :ref:`Implicit Parameters <implicit-parameters>`. "++ - "Implies :ghc-flag:`XFlexibleContexts` and :ghc-flag:`XFlexibleInstances`." + "Implies :ghc-flag:`-XFlexibleContexts` and :ghc-flag:`-XFlexibleInstances`." , flagType = DynamicFlag , flagReverse = "-XNoImplicitParams" , flagSince = "6.8.1" @@ -319,7 +319,7 @@ languageOptions = , flag { flagName = "-XNoImplicitPrelude" , flagDescription = "Don't implicitly ``import Prelude``. "++ - "Implied by :ghc-flag:`XRebindableSyntax`." + "Implied by :ghc-flag:`-XRebindableSyntax`." , flagType = DynamicFlag , flagReverse = "-XImplicitPrelude" , flagSince = "6.8.1" @@ -327,7 +327,7 @@ languageOptions = , flag { flagName = "-XImpredicativeTypes" , flagDescription = "Enable :ref:`impredicative types <impredicative-polymorphism>`. "++ - "Implies :ghc-flag:`XRankNTypes`." + "Implies :ghc-flag:`-XRankNTypes`." , flagType = DynamicFlag , flagReverse = "-XNoImpredicativeTypes" , flagSince = "6.10.1" @@ -335,7 +335,7 @@ languageOptions = , flag { flagName = "-XIncoherentInstances" , flagDescription = "Enable :ref:`incoherent instances <instance-overlap>`. "++ - "Implies :ghc-flag:`XOverlappingInstances`." + "Implies :ghc-flag:`-XOverlappingInstances`." , flagType = DynamicFlag , flagReverse = "-XNoIncoherentInstances" , flagSince = "6.8.1" @@ -343,7 +343,7 @@ languageOptions = , flag { flagName = "-XTypeFamilyDependencies" , flagDescription = "Enable :ref:`injective type families <injective-ty-fams>`. "++ - "Implies :ghc-flag:`XTypeFamilies`." + "Implies :ghc-flag:`-XTypeFamilies`." , flagType = DynamicFlag , flagReverse = "-XNoTypeFamilyDependencies" , flagSince = "8.0.1" @@ -364,7 +364,7 @@ languageOptions = , flag { flagName = "-XKindSignatures" , flagDescription = "Enable :ref:`kind signatures <kinding>`. "++ - "Implied by :ghc-flag:`XTypeFamilies` and :ghc-flag:`XPolyKinds`." + "Implied by :ghc-flag:`-XTypeFamilies` and :ghc-flag:`-XPolyKinds`." , flagType = DynamicFlag , flagReverse = "-XNoKindSignatures" , flagSince = "6.8.1" @@ -400,7 +400,7 @@ languageOptions = , flag { flagName = "-XMonoLocalBinds" , flagDescription = "Enable :ref:`do not generalise local bindings <mono-local-binds>`. "++ - "Implied by :ghc-flag:`XTypeFamilies` and :ghc-flag:`XGADTs`." + "Implied by :ghc-flag:`-XTypeFamilies` and :ghc-flag:`-XGADTs`." , flagType = DynamicFlag , flagReverse = "-XNoMonoLocalBinds" , flagSince = "6.12.1" @@ -416,7 +416,7 @@ languageOptions = , flagDescription = "Enable :ref:`multi parameter type classes "++ "<multi-param-type-classes>`. Implied by "++ - ":ghc-flag:`XFunctionalDependencies`." + ":ghc-flag:`-XFunctionalDependencies`." , flagType = DynamicFlag , flagReverse = "-XNoMultiParamTypeClasses" , flagSince = "6.8.1" @@ -457,7 +457,7 @@ languageOptions = , flagDescription = "Deprecated, does nothing. :ref:`nullary (no parameter) type "++ "classes <nullary-type-classes>` are now enabled using "++ - ":ghc-flag:`XMultiParamTypeClasses`." + ":ghc-flag:`-XMultiParamTypeClasses`." , flagType = DynamicFlag , flagReverse = "-XNoNullaryTypeClasses" , flagSince = "7.8.1" @@ -499,7 +499,7 @@ languageOptions = } , flag { flagName = "-XParallelArrays" , flagDescription = - "Enable parallel arrays. Implies :ghc-flag:`XParallelListComp`." + "Enable parallel arrays. Implies :ghc-flag:`-XParallelListComp`." , flagType = DynamicFlag , flagReverse = "-XNoParallelArrays" , flagSince = "7.4.1" @@ -508,7 +508,7 @@ languageOptions = , flagDescription = "Enable :ref:`parallel list comprehensions "++ "<parallel-list-comprehensions>`. "++ - "Implied by :ghc-flag:`XParallelArrays`." + "Implied by :ghc-flag:`-XParallelArrays`." , flagType = DynamicFlag , flagReverse = "-XNoParallelListComp" , flagSince = "6.8.1" @@ -536,7 +536,7 @@ languageOptions = , flag { flagName = "-XPolyKinds" , flagDescription = "Enable :ref:`kind polymorphism <kind-polymorphism>`. "++ - "Implies :ghc-flag:`XKindSignatures`." + "Implies :ghc-flag:`-XKindSignatures`." , flagType = DynamicFlag , flagReverse = "-XNoPolyKinds" , flagSince = "7.4.1" @@ -544,7 +544,7 @@ languageOptions = , flag { flagName = "-XPolymorphicComponents" , flagDescription = "Enable :ref:`polymorphic components for data constructors "++ - "<universal-quantification>`. Synonym for :ghc-flag:`XRankNTypes`." + "<universal-quantification>`. Synonym for :ghc-flag:`-XRankNTypes`." , flagType = DynamicFlag , flagReverse = "-XNoPolymorphicComponents" , flagSince = "6.8.1" @@ -565,7 +565,7 @@ languageOptions = , flag { flagName = "-XRank2Types" , flagDescription = "Enable :ref:`rank-2 types <universal-quantification>`. "++ - "Synonym for :ghc-flag:`XRankNTypes`." + "Synonym for :ghc-flag:`-XRankNTypes`." , flagType = DynamicFlag , flagReverse = "-XNoRank2Types" , flagSince = "6.8.1" @@ -573,7 +573,7 @@ languageOptions = , flag { flagName = "-XRankNTypes" , flagDescription = "Enable :ref:`rank-N types <universal-quantification>`. "++ - "Implied by :ghc-flag:`XImpredicativeTypes`." + "Implied by :ghc-flag:`-XImpredicativeTypes`." , flagType = DynamicFlag , flagReverse = "-XNoRankNTypes" , flagSince = "6.8.1" @@ -581,7 +581,7 @@ languageOptions = , flag { flagName = "-XRebindableSyntax" , flagDescription = "Employ :ref:`rebindable syntax <rebindable-syntax>`. "++ - "Implies :ghc-flag:`XNoImplicitPrelude`." + "Implies :ghc-flag:`-XNoImplicitPrelude`." , flagType = DynamicFlag , flagReverse = "-XNoRebindableSyntax" , flagSince = "7.0.1" @@ -589,7 +589,7 @@ languageOptions = , flag { flagName = "-XRecordWildCards" , flagDescription = "Enable :ref:`record wildcards <record-wildcards>`. "++ - "Implies :ghc-flag:`XDisambiguateRecordFields`." + "Implies :ghc-flag:`-XDisambiguateRecordFields`." , flagType = DynamicFlag , flagReverse = "-XNoRecordWildCards" , flagSince = "6.8.1" @@ -695,8 +695,8 @@ languageOptions = , flag { flagName = "-XTypeFamilies" , flagDescription = "Enable :ref:`type families <type-families>`. "++ - "Implies :ghc-flag:`XExplicitNamespaces`, :ghc-flag:`XKindSignatures`, "++ - "and :ghc-flag:`XMonoLocalBinds`." + "Implies :ghc-flag:`-XExplicitNamespaces`, :ghc-flag:`-XKindSignatures`, "++ + "and :ghc-flag:`-XMonoLocalBinds`." , flagType = DynamicFlag , flagReverse = "-XNoTypeFamilies" , flagSince = "6.8.1" @@ -704,7 +704,7 @@ languageOptions = , flag { flagName = "-XTypeOperators" , flagDescription = "Enable :ref:`type operators <type-operators>`. "++ - "Implies :ghc-flag:`XExplicitNamespaces`." + "Implies :ghc-flag:`-XExplicitNamespaces`." , flagType = DynamicFlag , flagReverse = "-XNoTypeOperators" , flagSince = "6.8.1" @@ -712,7 +712,7 @@ languageOptions = , flag { flagName = "-XTypeSynonymInstances" , flagDescription = "Enable :ref:`type synonyms in instance heads "++ - "<flexible-instance-head>`. Implied by :ghc-flag:`XFlexibleInstances`." + "<flexible-instance-head>`. Implied by :ghc-flag:`-XFlexibleInstances`." , flagType = DynamicFlag , flagReverse = "-XNoTypeSynonymInstances" , flagSince = "6.8.1" diff --git a/utils/mkUserGuidePart/Options/Linking.hs b/utils/mkUserGuidePart/Options/Linking.hs index 919cc096f1..9edc7c3fd3 100644 --- a/utils/mkUserGuidePart/Options/Linking.hs +++ b/utils/mkUserGuidePart/Options/Linking.hs @@ -75,7 +75,7 @@ linkingOptions = } , flag { flagName = "-no-rtsopts-suggestions" , flagDescription = - "Don't print RTS suggestions about linking with :ghc-flag:`rtsopts`." + "Don't print RTS suggestions about linking with :ghc-flag:`-rtsopts`." , flagType = DynamicFlag } , flag { flagName = "-no-link" @@ -104,7 +104,7 @@ linkingOptions = } , flag { flagName = "-ticky" , flagDescription = - "For linking, this simply implies :ghc-flag:`debug`; "++ + "For linking, this simply implies :ghc-flag:`-debug`; "++ "see :ref:`ticky-ticky`." , flagType = DynamicFlag } diff --git a/utils/mkUserGuidePart/Options/Misc.hs b/utils/mkUserGuidePart/Options/Misc.hs index a3e8738d48..0bb504a2fd 100644 --- a/utils/mkUserGuidePart/Options/Misc.hs +++ b/utils/mkUserGuidePart/Options/Misc.hs @@ -6,7 +6,7 @@ miscOptions :: [Flag] miscOptions = [ flag { flagName = "-jN" , flagDescription = - "When compiling with :ghc-flag:`-make`, compile ⟨N⟩ modules in parallel." + "When compiling with :ghc-flag:`--make`, compile ⟨N⟩ modules in parallel." , flagType = DynamicFlag } , flag { flagName = "-fno-hi-version-check" diff --git a/utils/mkUserGuidePart/Options/Optimizations.hs b/utils/mkUserGuidePart/Options/Optimizations.hs index 5f46a06e39..29d35a0377 100644 --- a/utils/mkUserGuidePart/Options/Optimizations.hs +++ b/utils/mkUserGuidePart/Options/Optimizations.hs @@ -6,35 +6,35 @@ optimizationsOptions :: [Flag] optimizationsOptions = [ flag { flagName = "-fcall-arity" , flagDescription = - "Enable call-arity optimisation. Implied by :ghc-flag:`O`." + "Enable call-arity optimisation. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-call-arity" } , flag { flagName = "-fcase-merge" - , flagDescription = "Enable case-merging. Implied by :ghc-flag:`O`." + , flagDescription = "Enable case-merging. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-case-merge" } , flag { flagName = "-fcmm-elim-common-blocks" , flagDescription = - "Enable Cmm common block elimination. Implied by :ghc-flag:`O`." + "Enable Cmm common block elimination. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-cmm-elim-common-blocks" } , flag { flagName = "-fcmm-sink" - , flagDescription = "Enable Cmm sinking. Implied by :ghc-flag:`O`." + , flagDescription = "Enable Cmm sinking. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-cmm-sink" } , flag { flagName = "-fcpr-anal" , flagDescription = - "Turn on CPR analysis in the demand analyser. Implied by :ghc-flag:`O`." + "Turn on CPR analysis in the demand analyser. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-cpr-anal" } , flag { flagName = "-fcse" , flagDescription = - "Enable common sub-expression elimination. Implied by :ghc-flag:`O`." + "Enable common sub-expression elimination. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-cse" } @@ -57,7 +57,7 @@ optimizationsOptions = , flagReverse = "-fno-dmd-tx-dict-sel" } , flag { flagName = "-fdo-eta-reduction" - , flagDescription = "Enable eta-reduction. Implied by :ghc-flag:`O`." + , flagDescription = "Enable eta-reduction. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-do-eta-reduction" } @@ -76,7 +76,7 @@ optimizationsOptions = , flagDescription = "Switch on all rewrite rules (including rules generated by "++ "automatic specialisation of overloaded functions). Implied by "++ - ":ghc-flag:`O`." + ":ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-enable-rewrite-rules" } @@ -93,14 +93,14 @@ optimizationsOptions = } , flag { flagName = "-ffloat-in" , flagDescription = - "Turn on the float-in transformation. Implied by :ghc-flag:`O`." + "Turn on the float-in transformation. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-float-in" } , flag { flagName = "-ffull-laziness" , flagDescription = "Turn on full laziness (floating bindings outwards). "++ - "Implied by :ghc-flag:`O`." + "Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-full-laziness" } @@ -113,13 +113,13 @@ optimizationsOptions = } , flag { flagName = "-fignore-asserts" , flagDescription = - "Ignore assertions in the source. Implied by :ghc-flag:`O`." + "Ignore assertions in the source. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-ignore-asserts" } , flag { flagName = "-fignore-interface-pragmas" , flagDescription = - "Ignore pragmas in interface files. Implied by :ghc-flag:`O0` only." + "Ignore pragmas in interface files. Implied by :ghc-flag:`-O0` only." , flagType = DynamicFlag , flagReverse = "-fno-ignore-interface-pragmas" } @@ -132,7 +132,7 @@ optimizationsOptions = } , flag { flagName = "-fliberate-case" , flagDescription = - "Turn on the liberate-case transformation. Implied by :ghc-flag:`O2`." + "Turn on the liberate-case transformation. Implied by :ghc-flag:`-O2`." , flagType = DynamicFlag , flagReverse = "-fno-liberate-case" } @@ -146,7 +146,7 @@ optimizationsOptions = , flag { flagName = "-floopification" , flagDescription = "Turn saturated self-recursive tail-calls into local jumps in the "++ - "generated assembly. Implied by :ghc-flag:`O`." + "generated assembly. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-loopification" } @@ -212,7 +212,7 @@ optimizationsOptions = } , flag { flagName = "-fomit-interface-pragmas" , flagDescription = - "Don't generate interface pragmas. Implied by :ghc-flag:`O0` only." + "Don't generate interface pragmas. Implied by :ghc-flag:`-O0` only." , flagType = DynamicFlag , flagReverse = "-fno-omit-interface-pragmas" } @@ -231,7 +231,7 @@ optimizationsOptions = , flag { flagName = "-fpedantic-bottoms" , flagDescription = "Make GHC be more precise about its treatment of bottom (but see "++ - "also :ghc-flag:`fno-state-hack`). In particular, GHC will not "++ + "also :ghc-flag:`-fno-state-hack`). In particular, GHC will not "++ "eta-expand through a case expression." , flagType = DynamicFlag , flagReverse = "-fno-pedantic-bottoms" @@ -239,7 +239,7 @@ optimizationsOptions = , flag { flagName = "-fregs-graph" , flagDescription = "Use the graph colouring register allocator for register "++ - "allocation in the native code generator. Implied by :ghc-flag:`O2`." + "allocation in the native code generator. Implied by :ghc-flag:`-O2`." , flagType = DynamicFlag , flagReverse = "-fno-regs-graph" } @@ -253,7 +253,7 @@ optimizationsOptions = , flag { flagName = "-fsimplifier-phases=⟨n⟩" , flagDescription = "*default: 2.* Set the number of phases for the simplifier. "++ - "Ignored with :ghc-flag:`O0`." + "Ignored with :ghc-flag:`-O0`." , flagType = DynamicFlag } , flag { flagName = "-fsimpl-tick-factor=⟨n⟩" @@ -263,7 +263,7 @@ optimizationsOptions = } , flag { flagName = "-fspec-constr" , flagDescription = - "Turn on the SpecConstr transformation. Implied by :ghc-flag:`O2`." + "Turn on the SpecConstr transformation. Implied by :ghc-flag:`-O2`." , flagType = DynamicFlag , flagReverse = "-fno-spec-constr" } @@ -284,7 +284,7 @@ optimizationsOptions = } , flag { flagName = "-fspecialise" , flagDescription = - "Turn on specialisation of overloaded functions. Implied by :ghc-flag:`O`." + "Turn on specialisation of overloaded functions. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-specialise" } @@ -302,7 +302,7 @@ optimizationsOptions = } , flag { flagName = "-fstrictness" , flagDescription = "Turn on strictness analysis." ++ - " Implied by :ghc-flag:`O`. Implies :ghc-flag:`fworker-wrapper`" + " Implied by :ghc-flag:`-O`. Implies :ghc-flag:`-fworker-wrapper`" , flagType = DynamicFlag , flagReverse = "-fno-strictness" } @@ -314,7 +314,7 @@ optimizationsOptions = , flag { flagName = "-funbox-small-strict-fields" , flagDescription = "Flatten strict constructor fields with a pointer-sized "++ - "representation. Implied by :ghc-flag:`O`." + "representation. Implied by :ghc-flag:`-O`." , flagType = DynamicFlag , flagReverse = "-fno-unbox-small-strict-fields" } @@ -357,9 +357,9 @@ optimizationsOptions = , flag { flagName = "-fworker-wrapper" , flagDescription = "Enable the worker-wrapper transformation after a strictness" ++ - " analysis pass. Implied by :ghc-flag:`O`, and by :ghc-flag:`fstrictness`." ++ - " Disabled by :ghc-flag:`fno-strictness`. Enabling :ghc-flag:`fworker-wrapper`" ++ - " while strictness analysis is disabled (by :ghc-flag:`fno-strictness`)" ++ + " analysis pass. Implied by :ghc-flag:`-O`, and by :ghc-flag:`-fstrictness`." ++ + " Disabled by :ghc-flag:`-fno-strictness`. Enabling :ghc-flag:`-fworker-wrapper`" ++ + " while strictness analysis is disabled (by :ghc-flag:`-fno-strictness`)" ++ " has no effect." , flagType = DynamicFlag , flagReverse = "-fno-worker-wrapper" diff --git a/utils/mkUserGuidePart/Options/Phases.hs b/utils/mkUserGuidePart/Options/Phases.hs index b32fa3468e..f302f569dd 100644 --- a/utils/mkUserGuidePart/Options/Phases.hs +++ b/utils/mkUserGuidePart/Options/Phases.hs @@ -7,7 +7,7 @@ phaseOptions = [ flag { flagName = "-F" , flagDescription = "Enable the use of a :ref:`pre-processor <pre-processor>` "++ - "(set with :ghc-flag:`pgmF`)" + "(set with :ghc-flag:`-pgmF`)" , flagType = DynamicFlag } , flag { flagName = "-E" diff --git a/utils/mkUserGuidePart/Options/RecompilationChecking.hs b/utils/mkUserGuidePart/Options/RecompilationChecking.hs index 740d04f55d..f119c1111e 100644 --- a/utils/mkUserGuidePart/Options/RecompilationChecking.hs +++ b/utils/mkUserGuidePart/Options/RecompilationChecking.hs @@ -8,7 +8,7 @@ recompilationCheckingOptions = , flagDescription = "Turn off recompilation checking. This is implied by any " ++ "``-ddump-X`` option when compiling a single file " ++ - "(i.e. when using :ghc-flag:`c`)." + "(i.e. when using :ghc-flag:`-c`)." , flagType = DynamicFlag , flagReverse = "-fno-force-recomp" } diff --git a/utils/mkUserGuidePart/Options/Verbosity.hs b/utils/mkUserGuidePart/Options/Verbosity.hs index 5aefd22600..9f9678ae2d 100644 --- a/utils/mkUserGuidePart/Options/Verbosity.hs +++ b/utils/mkUserGuidePart/Options/Verbosity.hs @@ -22,14 +22,14 @@ verbosityOptions = , flag { flagName = "-fprint-explicit-foralls" , flagDescription = "Print explicit ``forall`` quantification in types. " ++ - "See also :ghc-flag:`XExplicitForAll`" + "See also :ghc-flag:`-XExplicitForAll`" , flagType = DynamicFlag , flagReverse = "-fno-print-explicit-foralls" } , flag { flagName = "-fprint-explicit-kinds" , flagDescription = "Print explicit kind foralls and kind arguments in types. " ++ - "See also :ghc-flag:`XKindSignature`" + "See also :ghc-flag:`-XKindSignature`" , flagType = DynamicFlag , flagReverse = "-fno-print-explicit-kinds" } @@ -43,7 +43,7 @@ verbosityOptions = , flag { flagName = "-fprint-unicode-syntax" , flagDescription = "Use unicode syntax when printing expressions, types and kinds. " ++ - "See also :ghc-flag:`XUnicodeSyntax`" + "See also :ghc-flag:`-XUnicodeSyntax`" , flagType = DynamicFlag , flagReverse = "-fno-print-unicode-syntax" } diff --git a/utils/mkUserGuidePart/Options/Warnings.hs b/utils/mkUserGuidePart/Options/Warnings.hs index 31513d92a4..61e6019826 100644 --- a/utils/mkUserGuidePart/Options/Warnings.hs +++ b/utils/mkUserGuidePart/Options/Warnings.hs @@ -51,8 +51,8 @@ warningsOptions = , flag { flagName = "-fdefer-type-errors" , flagDescription = "Turn type errors into warnings, :ref:`deferring the error until "++ - "runtime <defer-type-errors>`. Implies :ghc-flag:`fdefer-typed-holes`. "++ - "See also :ghc-flag:`Wdeferred-type-errors`" + "runtime <defer-type-errors>`. Implies :ghc-flag:`-fdefer-typed-holes`. "++ + "See also :ghc-flag:`-Wdeferred-type-errors`" , flagType = DynamicFlag , flagReverse = "-fno-defer-type-errors" } @@ -60,8 +60,8 @@ warningsOptions = , flagDescription = "Convert :ref:`typed hole <typed-holes>` errors into warnings, "++ ":ref:`deferring the error until runtime <defer-type-errors>`. "++ - "Implied by :ghc-flag:`fdefer-type-errors`. "++ - "See also :ghc-flag:`Wtyped-holes`." + "Implied by :ghc-flag:`-fdefer-type-errors`. "++ + "See also :ghc-flag:`-Wtyped-holes`." , flagType = DynamicFlag , flagReverse = "-fno-defer-typed-holes" } @@ -274,8 +274,8 @@ warningsOptions = , flag { flagName = "-Wunused-binds" , flagDescription = "warn about bindings that are unused. Alias for "++ - ":ghc-flag:`Wunused-top-binds`, :ghc-flag:`Wunused-local-binds` and "++ - ":ghc-flag:`Wunused-pattern-binds`" + ":ghc-flag:`-Wunused-top-binds`, :ghc-flag:`-Wunused-local-binds` and "++ + ":ghc-flag:`-Wunused-pattern-binds`" , flagType = DynamicFlag , flagReverse = "-Wno-unused-binds" } @@ -336,7 +336,7 @@ warningsOptions = "Should be used to check the safety status of modules when using "++ "safe inference. Works on all module types, even those using "++ "explicit :ref:`Safe Haskell <safe-haskell>` modes (such as "++ - ":ghc-flag:`XTrustworthy`) and so can be used to have the compiler check "++ + ":ghc-flag:`-XTrustworthy`) and so can be used to have the compiler check "++ "any assumptions made." , flagType = DynamicFlag , flagReverse = "-Wno-unsafe" @@ -347,7 +347,7 @@ warningsOptions = "be used to check the safety status of modules when using safe "++ "inference. Works on all module types, even those using explicit "++ ":ref:`Safe Haskell <safe-haskell>` modes (such as "++ - ":ghc-flag:`XTrustworthy`) and so can be used to have the compiler check "++ + ":ghc-flag:`-XTrustworthy`) and so can be used to have the compiler check "++ "any assumptions made." , flagType = DynamicFlag , flagReverse = "-Wno-safe" @@ -355,8 +355,8 @@ warningsOptions = , flag { flagName = "-Wtrustworthy-safe" , flagDescription = "warn if the module being compiled is marked as "++ - ":ghc-flag:`XTrustworthy` but it could instead be marked as "++ - ":ghc-flag:`XSafe`, a more informative bound. Can be used to detect"++ + ":ghc-flag:`-XTrustworthy` but it could instead be marked as "++ + ":ghc-flag:`-XSafe`, a more informative bound. Can be used to detect"++ "once a Safe Haskell bound can be improved as dependencies are updated." , flagType = DynamicFlag , flagReverse = "-Wno-safe" @@ -386,7 +386,7 @@ warningsOptions = , flagDescription = "Report warnings when :ref:`deferred type errors "++ "<defer-type-errors>` are enabled. This option is enabled by "++ - "default. See :ghc-flag:`fdefer-type-errors`." + "default. See :ghc-flag:`-fdefer-type-errors`." , flagType = DynamicFlag , flagReverse = "-Wno-deferred-type-errors" } @@ -394,15 +394,15 @@ warningsOptions = , flagDescription = "Report warnings when :ref:`typed hole <typed-holes>` errors are "++ ":ref:`deferred until runtime <defer-type-errors>`. See "++ - ":ghc-flag:`fdefer-typed-holes`." + ":ghc-flag:`-fdefer-typed-holes`." , flagType = DynamicFlag , flagReverse = "-Wno-typed-holes" } , flag { flagName = "-Wpartial-type-signatures" , flagDescription = "warn about holes in partial type signatures when "++ - ":ghc-flag:`XPartialTypeSignatures` is enabled. Not applicable when "++ - ":ghc-flag:`XPartialTypesignatures` is not enabled, in which case "++ + ":ghc-flag:`-XPartialTypeSignatures` is enabled. Not applicable when "++ + ":ghc-flag:`-XPartialTypesignatures` is not enabled, in which case "++ "errors are generated for such holes. See "++ ":ref:`partial-type-signatures`." , flagType = DynamicFlag |