diff --git a/Cabal/src/Distribution/Simple/Command.hs b/Cabal/src/Distribution/Simple/Command.hs index d3cff2db4e8..a92cc1b019c 100644 --- a/Cabal/src/Distribution/Simple/Command.hs +++ b/Cabal/src/Distribution/Simple/Command.hs @@ -340,10 +340,10 @@ commandGetOpts -> CommandUI flags -> [GetOpt.OptDescr (flags -> flags)] commandGetOpts showOrParse command = - concatMap viewAsGetOpt (commandOptions command showOrParse) + concatMap (viewAsGetOpt showOrParse) (commandOptions command showOrParse) -viewAsGetOpt :: OptionField a -> [GetOpt.OptDescr (a -> a)] -viewAsGetOpt (OptionField _n aa) = concatMap optDescrToGetOpt aa +viewAsGetOpt :: ShowOrParseArgs -> OptionField a -> [GetOpt.OptDescr (a -> a)] +viewAsGetOpt showOrParse (OptionField _n aa) = concatMap optDescrToGetOpt aa where optDescrToGetOpt (ReqArg d (cs, ss) arg_desc set _) = [GetOpt.Option cs ss (GetOpt.ReqArg (runReadE set) arg_desc) d] @@ -358,10 +358,27 @@ viewAsGetOpt (OptionField _n aa) = concatMap optDescrToGetOpt aa [GetOpt.Option sfT lfT (GetOpt.NoArg (set True)) d] optDescrToGetOpt (BoolOpt d ([], []) (sfF, lfF) set _) = [GetOpt.Option sfF lfF (GetOpt.NoArg (set False)) d] - optDescrToGetOpt (BoolOpt d (sfT, lfT) (sfF, lfF) set _) = - [ GetOpt.Option sfT lfT (GetOpt.NoArg (set True)) ("Enable " ++ d) - , GetOpt.Option sfF lfF (GetOpt.NoArg (set False)) ("Disable " ++ d) - ] + optDescrToGetOpt (BoolOpt d trueFlags@(sfT, lfT) falseFlags@(sfF, lfF) set _) = + case showOrParse of + ShowArgs + | Just groupedLongFlag <- mkGroupedBoolLongFlag trueFlags falseFlags -> + [ GetOpt.Option [] [groupedLongFlag] (GetOpt.NoArg (set True)) ("Toggle " ++ d) + ] + _ -> + [ GetOpt.Option sfT lfT (GetOpt.NoArg (set True)) ("Enable " ++ d) + , GetOpt.Option sfF lfF (GetOpt.NoArg (set False)) ("Disable " ++ d) + ] + + mkGroupedBoolLongFlag :: OptFlags -> OptFlags -> Maybe String + mkGroupedBoolLongFlag ([], [longA]) ([], [longB]) = + checkPair longA longB <|> checkPair longB longA + where + checkPair longEnable longDisable = do + suffixEnable <- List.stripPrefix "enable-" longEnable + suffixDisable <- List.stripPrefix "disable-" longDisable + guard (suffixEnable == suffixDisable) + pure ("[enable|disable]-" ++ suffixEnable) + mkGroupedBoolLongFlag _ _ = Nothing getCurrentChoice :: OptDescr a -> a -> [String] getCurrentChoice (ChoiceOpt alts) a = diff --git a/changelog.d/12425.md b/changelog.d/12425.md new file mode 100644 index 00000000000..7dced7ba7a7 --- /dev/null +++ b/changelog.d/12425.md @@ -0,0 +1,10 @@ +--- +synopsis: Show --enable and --disable flag pairs as one +packages: [Cabal] +prs: 12426 +issues: 12425 +--- + +In command `--help` output, boolean option matched pairs that have an +`--enable-foo` and `--disable-foo` form are now shown as a single +`--[enable|disable]-foo` option. diff --git a/doc/cmd-v1-help/configure.txt b/doc/cmd-v1-help/configure.txt index 7059ef5d400..71c2c70720b 100644 --- a/doc/cmd-v1-help/configure.txt +++ b/doc/cmd-v1-help/configure.txt @@ -41,29 +41,24 @@ Flags for v1-configure: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -79,27 +74,20 @@ Flags for v1-configure: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -120,9 +108,8 @@ Flags for v1-configure: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -140,30 +127,21 @@ Flags for v1-configure: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -182,13 +160,9 @@ Flags for v1-configure: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, diff --git a/doc/cmd-v1-help/freeze.txt b/doc/cmd-v1-help/freeze.txt index 2357900bdf0..3e965fb8e01 100644 --- a/doc/cmd-v1-help/freeze.txt +++ b/doc/cmd-v1-help/freeze.txt @@ -16,14 +16,10 @@ Flags for v1-freeze: verbosity level is 1) --dry-run # Do not freeze anything, only print what would be frozen - --enable-tests # Enable freezing of the dependencies of any + --[enable|disable]-tests # Toggle freezing of the dependencies of any tests suites in the package description file. - --disable-tests # Disable freezing of the dependencies of any - tests suites in the package description file. - --enable-benchmarks # Enable freezing of the dependencies of any - benchmarks suites in the package description - file. - --disable-benchmarks # Disable freezing of the dependencies of any + --[enable|disable]-benchmarks + # Toggle freezing of the dependencies of any benchmarks suites in the package description file. --solver=SOLVER # Select dependency solver to use (default: diff --git a/doc/cmd-v1-help/install.txt b/doc/cmd-v1-help/install.txt index b4937a719cc..d8957ac4d36 100644 --- a/doc/cmd-v1-help/install.txt +++ b/doc/cmd-v1-help/install.txt @@ -52,29 +52,24 @@ Flags for v1-install: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -90,27 +85,20 @@ Flags for v1-install: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -131,9 +119,8 @@ Flags for v1-install: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -151,30 +138,21 @@ Flags for v1-install: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -193,13 +171,9 @@ Flags for v1-install: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -215,8 +189,8 @@ Flags for v1-install: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -300,8 +274,8 @@ Flags for v1-install: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v1-help/reconfigure.txt b/doc/cmd-v1-help/reconfigure.txt index 15d821d1358..a0a38ada0fe 100644 --- a/doc/cmd-v1-help/reconfigure.txt +++ b/doc/cmd-v1-help/reconfigure.txt @@ -40,29 +40,24 @@ Flags for v1-reconfigure: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -78,27 +73,20 @@ Flags for v1-reconfigure: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -119,9 +107,8 @@ Flags for v1-reconfigure: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -139,30 +126,21 @@ Flags for v1-reconfigure: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -181,13 +159,9 @@ Flags for v1-reconfigure: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, diff --git a/doc/cmd-v2-help/bench.txt b/doc/cmd-v2-help/bench.txt index c5ba5a99f02..59ac2ce8867 100644 --- a/doc/cmd-v2-help/bench.txt +++ b/doc/cmd-v2-help/bench.txt @@ -45,29 +45,24 @@ Flags for bench: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -83,27 +78,20 @@ Flags for bench: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -124,9 +112,8 @@ Flags for bench: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -144,30 +131,21 @@ Flags for bench: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -186,13 +164,9 @@ Flags for bench: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -208,8 +182,8 @@ Flags for bench: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -291,8 +265,8 @@ Flags for bench: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/build.txt b/doc/cmd-v2-help/build.txt index c4d2f57a62f..c29ab8f7161 100644 --- a/doc/cmd-v2-help/build.txt +++ b/doc/cmd-v2-help/build.txt @@ -45,29 +45,24 @@ Flags for build: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -83,27 +78,20 @@ Flags for build: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -124,9 +112,8 @@ Flags for build: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -144,30 +131,21 @@ Flags for build: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -186,13 +164,9 @@ Flags for build: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -208,8 +182,8 @@ Flags for build: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -291,8 +265,8 @@ Flags for build: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/configure.txt b/doc/cmd-v2-help/configure.txt index c97f66063b1..dc8178a9a5a 100644 --- a/doc/cmd-v2-help/configure.txt +++ b/doc/cmd-v2-help/configure.txt @@ -58,29 +58,24 @@ Flags for configure: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -96,27 +91,20 @@ Flags for configure: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -137,9 +125,8 @@ Flags for configure: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -157,30 +144,21 @@ Flags for configure: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -199,13 +177,9 @@ Flags for configure: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -221,8 +195,8 @@ Flags for configure: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -304,8 +278,8 @@ Flags for configure: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/exec.txt b/doc/cmd-v2-help/exec.txt index ea4368e9cd8..6d7a436d16e 100644 --- a/doc/cmd-v2-help/exec.txt +++ b/doc/cmd-v2-help/exec.txt @@ -47,29 +47,24 @@ Flags for exec: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -85,27 +80,20 @@ Flags for exec: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -126,9 +114,8 @@ Flags for exec: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -146,30 +133,21 @@ Flags for exec: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -188,13 +166,9 @@ Flags for exec: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -210,8 +184,8 @@ Flags for exec: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -293,8 +267,8 @@ Flags for exec: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/fetch.txt b/doc/cmd-v2-help/fetch.txt index b66044ab234..a986883b91b 100644 --- a/doc/cmd-v2-help/fetch.txt +++ b/doc/cmd-v2-help/fetch.txt @@ -13,18 +13,13 @@ Flags for fetch: --no-dependencies # Ignore dependencies --dry-run # Do not install anything, only print what would be installed. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. --solver=SOLVER # Select dependency solver to use (default: modular). Choices: modular. --max-backjumps=NUM # Maximum number of backjumps allowed while diff --git a/doc/cmd-v2-help/freeze.txt b/doc/cmd-v2-help/freeze.txt index 64269ce7f8e..5c9ce9cefbe 100644 --- a/doc/cmd-v2-help/freeze.txt +++ b/doc/cmd-v2-help/freeze.txt @@ -50,29 +50,24 @@ Flags for freeze: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -88,27 +83,20 @@ Flags for freeze: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -129,9 +117,8 @@ Flags for freeze: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -149,30 +136,21 @@ Flags for freeze: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -191,13 +169,9 @@ Flags for freeze: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -213,8 +187,8 @@ Flags for freeze: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -296,8 +270,8 @@ Flags for freeze: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/gen-bounds.txt b/doc/cmd-v2-help/gen-bounds.txt index 8764aac5bda..919f4c0887e 100644 --- a/doc/cmd-v2-help/gen-bounds.txt +++ b/doc/cmd-v2-help/gen-bounds.txt @@ -36,29 +36,24 @@ Flags for gen-bounds: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -74,27 +69,20 @@ Flags for gen-bounds: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -115,9 +103,8 @@ Flags for gen-bounds: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -135,30 +122,21 @@ Flags for gen-bounds: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -177,13 +155,9 @@ Flags for gen-bounds: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -199,8 +173,8 @@ Flags for gen-bounds: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -282,8 +256,8 @@ Flags for gen-bounds: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/haddock.txt b/doc/cmd-v2-help/haddock.txt index 2e5046e47f7..7e695c0f436 100644 --- a/doc/cmd-v2-help/haddock.txt +++ b/doc/cmd-v2-help/haddock.txt @@ -50,29 +50,24 @@ Flags for haddock: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -88,27 +83,20 @@ Flags for haddock: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -129,9 +117,8 @@ Flags for haddock: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -149,30 +136,21 @@ Flags for haddock: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -191,13 +169,9 @@ Flags for haddock: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -213,8 +187,8 @@ Flags for haddock: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -296,8 +270,8 @@ Flags for haddock: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/install.txt b/doc/cmd-v2-help/install.txt index 8850a2a2890..ae630f2fe78 100644 --- a/doc/cmd-v2-help/install.txt +++ b/doc/cmd-v2-help/install.txt @@ -28,29 +28,24 @@ Flags for install: --with-hc-pkg=PATH # Give the path to the package tool --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -66,27 +61,20 @@ Flags for install: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -107,9 +95,8 @@ Flags for install: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -127,30 +114,21 @@ Flags for install: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -169,13 +147,9 @@ Flags for install: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -191,8 +165,8 @@ Flags for install: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -274,8 +248,8 @@ Flags for install: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/list-bin.txt b/doc/cmd-v2-help/list-bin.txt index 3b8b8f01156..a2544de9964 100644 --- a/doc/cmd-v2-help/list-bin.txt +++ b/doc/cmd-v2-help/list-bin.txt @@ -37,29 +37,24 @@ Flags for list-bin: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -75,27 +70,20 @@ Flags for list-bin: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -116,9 +104,8 @@ Flags for list-bin: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -136,30 +123,21 @@ Flags for list-bin: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -178,13 +156,9 @@ Flags for list-bin: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -200,8 +174,8 @@ Flags for list-bin: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -283,8 +257,8 @@ Flags for list-bin: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/outdated.txt b/doc/cmd-v2-help/outdated.txt index 85a07dd7493..c3ee0f7c010 100644 --- a/doc/cmd-v2-help/outdated.txt +++ b/doc/cmd-v2-help/outdated.txt @@ -38,29 +38,24 @@ Flags for outdated: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -76,27 +71,20 @@ Flags for outdated: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -117,9 +105,8 @@ Flags for outdated: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -137,30 +124,21 @@ Flags for outdated: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -179,13 +157,9 @@ Flags for outdated: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -201,8 +175,8 @@ Flags for outdated: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -284,8 +258,8 @@ Flags for outdated: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/path.txt b/doc/cmd-v2-help/path.txt index 74f4a3b3355..d81435107be 100644 --- a/doc/cmd-v2-help/path.txt +++ b/doc/cmd-v2-help/path.txt @@ -39,29 +39,24 @@ Flags for path: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -77,27 +72,20 @@ Flags for path: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -118,9 +106,8 @@ Flags for path: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -138,30 +125,21 @@ Flags for path: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -180,13 +158,9 @@ Flags for path: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -202,8 +176,8 @@ Flags for path: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -285,8 +259,8 @@ Flags for path: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/repl.txt b/doc/cmd-v2-help/repl.txt index 2913c652167..d669e4c03e5 100644 --- a/doc/cmd-v2-help/repl.txt +++ b/doc/cmd-v2-help/repl.txt @@ -48,29 +48,24 @@ Flags for repl: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -86,27 +81,20 @@ Flags for repl: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -127,9 +115,8 @@ Flags for repl: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -147,30 +134,21 @@ Flags for repl: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -189,13 +167,9 @@ Flags for repl: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -211,8 +185,8 @@ Flags for repl: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -294,8 +268,8 @@ Flags for repl: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel @@ -385,8 +359,8 @@ Flags for repl: presented to GHCi. --no-transitive-deps # Don't automatically include transitive dependencies of requested packages. - --enable-multi-repl # Enable multi-component repl sessions - --disable-multi-repl # Disable multi-component repl sessions + --[enable|disable]-multi-repl + # Toggle multi-component repl sessions Examples, open an interactive session: cabal repl diff --git a/doc/cmd-v2-help/run.txt b/doc/cmd-v2-help/run.txt index f8dd2b32a58..b42535073b3 100644 --- a/doc/cmd-v2-help/run.txt +++ b/doc/cmd-v2-help/run.txt @@ -51,29 +51,24 @@ Flags for run: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -89,27 +84,20 @@ Flags for run: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -130,9 +118,8 @@ Flags for run: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -150,30 +137,21 @@ Flags for run: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -192,13 +170,9 @@ Flags for run: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -214,8 +188,8 @@ Flags for run: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -297,8 +271,8 @@ Flags for run: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/target.txt b/doc/cmd-v2-help/target.txt index 6dddae62364..67cf76aebed 100644 --- a/doc/cmd-v2-help/target.txt +++ b/doc/cmd-v2-help/target.txt @@ -67,29 +67,24 @@ Flags for target: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -105,27 +100,20 @@ Flags for target: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -146,9 +134,8 @@ Flags for target: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -166,30 +153,21 @@ Flags for target: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -208,13 +186,9 @@ Flags for target: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -230,8 +204,8 @@ Flags for target: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -313,8 +287,8 @@ Flags for target: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/test.txt b/doc/cmd-v2-help/test.txt index 00c529d1a3b..9fc457bbf16 100644 --- a/doc/cmd-v2-help/test.txt +++ b/doc/cmd-v2-help/test.txt @@ -47,29 +47,24 @@ Flags for test: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -85,27 +80,20 @@ Flags for test: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -126,9 +114,8 @@ Flags for test: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -146,30 +133,21 @@ Flags for test: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -188,13 +166,9 @@ Flags for test: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -210,8 +184,8 @@ Flags for test: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -293,8 +267,8 @@ Flags for test: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/cmd-v2-help/update.txt b/doc/cmd-v2-help/update.txt index cc4e6a3ea26..77c52ee3171 100644 --- a/doc/cmd-v2-help/update.txt +++ b/doc/cmd-v2-help/update.txt @@ -37,29 +37,24 @@ Flags for update: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -75,27 +70,20 @@ Flags for update: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to - reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -116,9 +104,8 @@ Flags for update: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -136,30 +123,21 @@ Flags for update: locations) --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program - Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs @@ -178,13 +156,9 @@ Flags for update: use "" to prevent splitting) --cabal-lib-version=VERSION # Select which version of the Cabal lib to use to build packages (useful for testing). - --enable-append # Enable appending the new config to the old + --[enable|disable]-append # Toggle appending the new config to the old config file - --disable-append # Disable appending the new config to the old - config file - --enable-backup # Enable the backup of the config file before - any alterations - --disable-backup # Disable the backup of the config file before + --[enable|disable]-backup # Toggle the backup of the config file before any alterations -c CONSTRAINT or -cCONSTRAINT, --constraint=CONSTRAINT # Specify constraints on a package (version, @@ -200,8 +174,8 @@ Flags for update: --write-ghc-environment-files=always|never|ghc8.4.4+ # Whether to create a .ghc.environment file after a successful build (v2-build only) - --enable-documentation # Enable building of documentation - --disable-documentation # Disable building of documentation + --[enable|disable]-documentation + # Toggle building of documentation --doc-index-file=TEMPLATE # A central index of haddock API documentation (template cannot use $pkgid) --dry-run # Do not install anything, only print what would @@ -283,8 +257,8 @@ Flags for update: --report-planning-failure # Generate build reports when the dependency solver fails. This is used by the Hackage build bot. - --enable-per-component # Enable Per-component builds when possible - --disable-per-component # Disable Per-component builds when possible + --[enable|disable]-per-component + # Toggle Per-component builds when possible --run-tests # Run package test suites during installation. --semaphore # Use a semaphore so GHC can compile components in parallel diff --git a/doc/setup-help/configure.txt b/doc/setup-help/configure.txt index a5b3587cdd3..2039e080640 100644 --- a/doc/setup-help/configure.txt +++ b/doc/setup-help/configure.txt @@ -41,29 +41,24 @@ Flags for configure: --sysconfdir=DIR # Installation directory for configuration files --program-prefix=PREFIX # Prefix to be applied to installed executables --program-suffix=SUFFIX # Suffix to be applied to installed executables - --enable-library-vanilla # Enable Vanilla libraries - --disable-library-vanilla # Disable Vanilla libraries + --[enable|disable]-library-vanilla + # Toggle Vanilla libraries -p, --enable-library-profiling # Enable Library profiling --disable-library-profiling # Disable Library profiling - --enable-shared # Enable Shared library - --disable-shared # Disable Shared library - --enable-static # Enable Static library - --disable-static # Disable Static library - --enable-library-bytecode # Enable Bytecode library - --disable-library-bytecode # Disable Bytecode library - --enable-executable-dynamic # Enable Executable dynamic linking - --disable-executable-dynamic # Disable Executable dynamic linking - --enable-executable-static # Enable Executable fully static linking - --disable-executable-static # Disable Executable fully static linking - --enable-profiling # Enable Executable and library profiling - --disable-profiling # Disable Executable and library profiling - --enable-profiling-shared # Enable Build profiling shared libraries - --disable-profiling-shared # Disable Build profiling shared libraries - --enable-executable-profiling - # Enable Executable profiling (DEPRECATED) - --disable-executable-profiling - # Disable Executable profiling (DEPRECATED) + --[enable|disable]-shared # Toggle Shared library + --[enable|disable]-static # Toggle Static library + --[enable|disable]-library-bytecode + # Toggle Bytecode library + --[enable|disable]-executable-dynamic + # Toggle Executable dynamic linking + --[enable|disable]-executable-static + # Toggle Executable fully static linking + --[enable|disable]-profiling # Toggle Executable and library profiling + --[enable|disable]-profiling-shared + # Toggle Build profiling shared libraries + --[enable|disable]-executable-profiling + # Toggle Executable profiling (DEPRECATED) --profiling-detail=level # Profiling detail level for executable and library (default, none, exported-functions, toplevel-functions, all-functions, late). @@ -79,27 +74,20 @@ Flags for configure: project building --disable-build-info # Disable build information generation during project building - --enable-library-for-ghci # Enable compile library for use with GHCi - --disable-library-for-ghci # Disable compile library for use with GHCi - --enable-split-sections # Enable compile library code such that unneeded + --[enable|disable]-library-for-ghci + # Toggle compile library for use with GHCi + --[enable|disable]-split-sections + # Toggle compile library code such that unneeded definitions can be dropped from the final executable (GHC 7.8+) - --disable-split-sections # Disable compile library code such that - unneeded definitions can be dropped from the - final executable (GHC 7.8+) - --enable-split-objs # Enable split library into smaller objects to + --[enable|disable]-split-objs + # Toggle split library into smaller objects to reduce binary sizes (GHC 6.6+) - --disable-split-objs # Disable split library into smaller objects to - reduce binary sizes (GHC 6.6+) - --enable-executable-stripping - # Enable strip executables upon installation to - reduce binary sizes - --disable-executable-stripping - # Disable strip executables upon installation to - reduce binary sizes - --enable-library-stripping # Enable strip libraries upon installation to + --[enable|disable]-executable-stripping + # Toggle strip executables upon installation to reduce binary sizes - --disable-library-stripping # Disable strip libraries upon installation to + --[enable|disable]-library-stripping + # Toggle strip libraries upon installation to reduce binary sizes --configure-option=OPT # Extra option for configure --user # Enable doing a per-user installation @@ -120,9 +108,8 @@ Flags for configure: false. --extra-include-dirs=PATH # A list of directories to search for header files - --enable-deterministic # Enable Try to be as deterministic as possible - (used by the test suite) - --disable-deterministic # Disable Try to be as deterministic as possible + --[enable|disable]-deterministic + # Toggle Try to be as deterministic as possible (used by the test suite) --ipid=IPID # Installed package ID to compile this package as @@ -148,32 +135,23 @@ Flags for configure: --promised-dependency="void-0.5.8=void-0.5.8-177d5cdf20962d0581fe2e4932a6c309" --instantiate-with=NAME=MOD # A mapping of signature names to concrete module instantiations. - --enable-tests # Enable dependency checking and compilation for + --[enable|disable]-tests # Toggle dependency checking and compilation for test suites listed in the package description file. - --disable-tests # Disable dependency checking and compilation - for test suites listed in the package - description file. - --enable-coverage # Enable build package with Haskell Program - Coverage. (GHC only) - --disable-coverage # Disable build package with Haskell Program + --[enable|disable]-coverage # Toggle build package with Haskell Program Coverage. (GHC only) - --enable-library-coverage # Enable build package with Haskell Program - Coverage. (GHC only) (DEPRECATED) - --disable-library-coverage # Disable build package with Haskell Program + --[enable|disable]-library-coverage + # Toggle build package with Haskell Program Coverage. (GHC only) (DEPRECATED) --exact-configuration # All direct dependencies and flags are provided on the command line. - --enable-benchmarks # Enable dependency checking and compilation for + --[enable|disable]-benchmarks + # Toggle dependency checking and compilation for benchmarks listed in the package description file. - --disable-benchmarks # Disable dependency checking and compilation - for benchmarks listed in the package - description file. - --enable-relocatable # Enable building a package that is relocatable. + --[enable|disable]-relocatable + # Toggle building a package that is relocatable. (GHC only) - --disable-relocatable # Disable building a package that is - relocatable. (GHC only) --disable-response-files # Enable workaround for old versions of programs like "ar" that do not support @file arguments --allow-depending-on-private-libs diff --git a/doc/setup-help/install.txt b/doc/setup-help/install.txt index 4aa64d05a4f..1cec92d8c76 100644 --- a/doc/setup-help/install.txt +++ b/doc/setup-help/install.txt @@ -17,9 +17,8 @@ Flags for install: --inplace # install the package in the install subdirectory of the dist prefix, so it can be used without being installed - --enable-shell-wrappers # Enable using shell script wrappers around - executables - --disable-shell-wrappers # Disable using shell script wrappers around + --[enable|disable]-shell-wrappers + # Toggle using shell script wrappers around executables --user # upon configuration register this package in the user's local package database