Skip to content

Commit a2910ec

Browse files
committed
Add help message for show-build-info cmd
1 parent 098fd30 commit a2910ec

File tree

1 file changed

+8
-22
lines changed

1 file changed

+8
-22
lines changed

cabal-install/Distribution/Client/CmdShowBuildInfo.hs

+8-22
Original file line numberDiff line numberDiff line change
@@ -46,30 +46,16 @@ showBuildInfoCommand = Client.installCommand {
4646
commandSynopsis = "Show project build information",
4747
commandUsage = usageAlternatives "new-show-build-info" [ "[TARGETS] [FLAGS]" ],
4848
commandDescription = Just $ \_ -> wrapText $
49-
"Build one or more targets from within the project. The available "
50-
++ "targets are the packages in the project as well as individual "
51-
++ "components within those packages, including libraries, executables, "
52-
++ "test-suites or benchmarks. Targets can be specified by name or "
53-
++ "location. If no target is specified then the default is to build "
54-
++ "the package in the current directory.\n\n"
55-
56-
++ "Dependencies are built or rebuilt as necessary. Additional "
57-
++ "configuration flags can be specified on the command line and these "
58-
++ "extend the project configuration from the 'cabal.project', "
59-
++ "'cabal.project.local' and other files.",
49+
"Provides detailed json output for the given package.\n"
50+
++ "Contains information about the different build components and compiler flags.\n",
6051
commandNotes = Just $ \pname ->
6152
"Examples:\n"
62-
++ " " ++ pname ++ " new-build\n"
63-
++ " Build the package in the current directory or all packages in the project\n"
64-
++ " " ++ pname ++ " new-build pkgname\n"
65-
++ " Build the package named pkgname in the project\n"
66-
++ " " ++ pname ++ " new-build ./pkgfoo\n"
67-
++ " Build the package in the ./pkgfoo directory\n"
68-
++ " " ++ pname ++ " new-build cname\n"
69-
++ " Build the component named cname module Distribution.Client.InstallPlanin the project\n"
70-
++ " " ++ pname ++ " new-build cname --module Distribution.Client.InstallPlanenable-profiling\n"
71-
++ " Build the component in profilingmodule Distribution.Client.InstallPlan mode (including dependencies as needed)\n\n"
72-
53+
++ " " ++ pname ++ " new-show-build-info\n"
54+
++ " Shows build information about the current package\n"
55+
++ " " ++ pname ++ " new-show-build-info .\n"
56+
++ " Shows build information about the current package\n"
57+
++ " " ++ pname ++ " new-show-build-info ./pkgname \n"
58+
++ " Shows build information about the package located in './pkgname'\n"
7359
++ cmdCommonHelpTextNewBuildBeta
7460
}
7561

0 commit comments

Comments
 (0)