Unverified Commit d28c80ac authored by Oleg Grenrus's avatar Oleg Grenrus Committed by GitHub
Browse files

Merge pull request #7098 from phadej/issue-7090-v2-is-not-experimental

Resolve #7090: Remove v2-build beta note from --help
parents f6682efc 02281c9e
......@@ -65,9 +65,7 @@ benchCommand = CommandUI {
++ " " ++ pname ++ " v2-bench cname\n"
++ " Run the benchmark named cname\n"
++ " " ++ pname ++ " v2-bench cname -O2\n"
++ " Run the benchmark built with '-O2' (including local libs used)\n\n"
++ cmdCommonHelpTextNewBuildBeta
++ " Run the benchmark built with '-O2' (including local libs used)\n"
, commandDefaultFlags = defaultNixStyleFlags ()
, commandOptions = nixStyleOptions (const [])
......
......@@ -64,9 +64,8 @@ buildCommand = CommandUI {
++ " Build the component named cname in the project\n"
++ " " ++ pname ++ " v2-build cname --enable-profiling\n"
++ " Build the component in profiling mode "
++ "(including dependencies as needed)\n\n"
++ "(including dependencies as needed)\n"
++ cmdCommonHelpTextNewBuildBeta
, commandDefaultFlags = defaultNixStyleFlags defaultBuildFlags
, commandOptions = filter (\o -> optionName o /= "ignore-project")
. nixStyleOptions (\showOrParseArgs ->
......
......@@ -70,9 +70,8 @@ configureCommand = CommandUI {
++ " program and check the resulting configuration works.\n"
++ " " ++ pname ++ " v2-configure\n"
++ " Reset the local configuration to empty and check the overall\n"
++ " project configuration works.\n\n"
++ " project configuration works.\n"
++ cmdCommonHelpTextNewBuildBeta
, commandDefaultFlags = defaultNixStyleFlags ()
, commandOptions = filter (\o -> optionName o /= "ignore-project")
. nixStyleOptions (const [])
......
......@@ -74,6 +74,7 @@ freezeCommand = CommandUI {
++ "solver flags such as '--constraint=\"pkg < 1.2\"' and once you have "
++ "a satisfactory solution to freeze it using the 'v2-freeze' command "
++ "with the same set of flags.",
commandNotes = Just $ \pname ->
"Examples:\n"
++ " " ++ pname ++ " v2-freeze\n"
......@@ -81,17 +82,8 @@ freezeCommand = CommandUI {
++ " " ++ pname ++ " v2-build --dry-run --constraint=\"aeson < 1\"\n"
++ " Check what a solution with the given constraints would look like\n"
++ " " ++ pname ++ " v2-freeze --constraint=\"aeson < 1\"\n"
++ " Freeze a solution using the given constraints\n\n"
++ "Note: this command is part of the new project-based system (aka "
++ "nix-style\nlocal builds). These features are currently in beta. "
++ "Please see\n"
++ "http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html "
++ "for\ndetails and advice on what you can expect to work. If you "
++ "encounter problems\nplease file issues at "
++ "https://github.com/haskell/cabal/issues and if you\nhave any time "
++ "to get involved and help with testing, fixing bugs etc then\nthat "
++ "is very much appreciated.\n"
++ " Freeze a solution using the given constraints\n"
, commandDefaultFlags = defaultNixStyleFlags ()
, commandOptions = nixStyleOptions (const [])
}
......
......@@ -57,9 +57,7 @@ haddockCommand = CommandUI {
commandNotes = Just $ \pname ->
"Examples:\n"
++ " " ++ pname ++ " v2-haddock pkgname"
++ " Build documentation for the package named pkgname\n\n"
++ cmdCommonHelpTextNewBuildBeta
++ " Build documentation for the package named pkgname\n"
, commandOptions = nixStyleOptions (const [])
, commandDefaultFlags = defaultNixStyleFlags ()
}
......
......@@ -169,7 +169,6 @@ installCommand = CommandUI
++ " " ++ pname ++ " v2-install ./pkgfoo\n"
++ " Install the package in the ./pkgfoo directory\n"
++ cmdCommonHelpTextNewBuildBeta
, commandOptions = nixStyleOptions clientInstallOptions
, commandDefaultFlags = defaultNixStyleFlags defaultClientInstallFlags
}
......
......@@ -177,9 +177,8 @@ replCommand = Client.installCommand {
++ "(or no componentif there is no project present)\n"
++ " " ++ pname ++ " v2-repl --build-depends \"lens >= 4.15 && < 4.18\"\n"
++ " add a version (constrained between 4.15 and 4.18) of the library 'lens' "
++ "to the default component (or no component if there is no project present)\n"
++ "to the default component (or no component if there is no project present)\n",
++ cmdCommonHelpTextNewBuildBeta,
commandDefaultFlags = defaultNixStyleFlags ([], defaultEnvFlags),
commandOptions = nixStyleOptions $ \showOrParseArgs ->
map (liftOptionL _1) (replOptions showOrParseArgs) ++
......
......@@ -143,9 +143,8 @@ runCommand = CommandUI
++ " " ++ pname ++ " v2-run pkgfoo:foo-tool\n"
++ " Run the executable-like 'foo-tool' in the package 'pkgfoo'\n"
++ " " ++ pname ++ " v2-run foo -O2 -- dothing --fooflag\n"
++ " Build with '-O2' and run the program, passing it extra arguments.\n\n"
++ " Build with '-O2' and run the program, passing it extra arguments.\n"
++ cmdCommonHelpTextNewBuildBeta
, commandDefaultFlags = defaultNixStyleFlags ()
, commandOptions = nixStyleOptions (const [])
}
......
......@@ -73,9 +73,7 @@ testCommand = CommandUI
++ " " ++ pname ++ " v2-test cname\n"
++ " Run the test-suite named cname\n"
++ " " ++ pname ++ " v2-test cname --enable-coverage\n"
++ " Run the test-suite built with code coverage (including local libs used)\n\n"
++ cmdCommonHelpTextNewBuildBeta
++ " Run the test-suite built with code coverage (including local libs used)\n"
, commandDefaultFlags = defaultNixStyleFlags ()
, commandOptions = nixStyleOptions (const [])
......
......@@ -71,6 +71,7 @@ updateCommand = CommandUI
, commandUsage = usageAlternatives "v2-update" [ "[FLAGS] [REPOS]" ]
, commandDescription = Just $ \_ -> wrapText $
"For all known remote repositories, download the package list."
, commandNotes = Just $ \pname ->
"REPO has the format <repo-id>[,<index-state>] where index-state follows\n"
++ "the same format and syntax that is supported by the --index-state flag.\n\n"
......@@ -85,18 +86,8 @@ updateCommand = CommandUI
++ " " ++ pname ++ " new update hackage.haskell.org head.hackage\n"
++ " Download hackage.haskell.org and head.hackage\n"
++ " head.hackage must be a known repo-id. E.g. from\n"
++ " your cabal.project(.local) file.\n\n"
++ "Note: this command is part of the new project-based system (aka "
++ "nix-style\nlocal builds). These features are currently in beta. "
++ "Please see\n"
++ "http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html "
++ "for\ndetails and advice on what you can expect to work. If you "
++ "encounter problems\nplease file issues at "
++ "https://github.com/haskell/cabal/issues and if you\nhave any time "
++ "to get involved and help with testing, fixing bugs etc then\nthat "
++ "is very much appreciated.\n"
-- TODO: Add ProjectFlags to NixStyleFlags,
-- so project-file won't be ambiguous
++ " your cabal.project(.local) file.\n"
, commandOptions = nixStyleOptions $ const []
, commandDefaultFlags = defaultNixStyleFlags ()
}
......
......@@ -93,9 +93,6 @@ module Distribution.Client.ProjectOrchestration (
runProjectPostBuildPhase,
dieOnBuildFailures,
-- * Shared CLI utils
cmdCommonHelpTextNewBuildBeta,
-- * Dummy projects
establishDummyProjectBaseContext,
establishDummyDistDirLayout,
......@@ -1193,19 +1190,6 @@ data BuildFailurePresentation =
ShowBuildSummaryOnly BuildFailureReason
| ShowBuildSummaryAndLog BuildFailureReason FilePath
cmdCommonHelpTextNewBuildBeta :: String
cmdCommonHelpTextNewBuildBeta =
"Note: this command is part of the new project-based system (aka "
++ "nix-style\nlocal builds). These features are currently in beta. "
++ "Please see\n"
++ "http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html "
++ "for\ndetails and advice on what you can expect to work. If you "
++ "encounter problems\nplease file issues at "
++ "https://github.com/haskell/cabal/issues and if you\nhave any time "
++ "to get involved and help with testing, fixing bugs etc then\nthat "
++ "is very much appreciated.\n"
-------------------------------------------------------------------------------
-- Dummy projects
-------------------------------------------------------------------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment