Skip to content

Commit 433ac79

Browse files
committed
Update Usage message
1 parent 2d457c0 commit 433ac79

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,19 @@ Build.Run(); // Note 4
4949
The recipe supports a number of standard command-line arguments. Additional arguments may be
5050
supported directly by the user's `build.cake` file, but must not conflict with the built-in arguments.
5151

52-
Arguments taking a value may use `=` or space to separate the name from the value.
52+
Arguments taking a value may use `=` or space to separate the name from the value and
53+
may be specified in abbreviated form, down to the minimum length shown in square braces.
54+
Single character abbreviations use a single dash.
5355

54-
#### --target, -t=TARGET
55-
The name of the TARGET task to be run, e.g. Test. Default is "Build."
56+
#### --target=TARGET [-t]
57+
The name of the TARGET task to be run, e.g. Test. Default is "Build." For a list
58+
of supported targets, use the Cake `--description` option.
5659

57-
#### --configuration, -c=CONFIG
60+
#### --configuration=CONFIG [-c]
5861
The name of the configuration to build, test and/or package, e.g. Debug.
5962
Defaults to Release.
6063

61-
#### --packageVersion, --package=VERSION
64+
#### --packageVersion=VERSION [--pack]
6265
Specifies the full package version, including any pre-release
6366
suffix. This version is used directly instead of the default
6467
version from the script or that calculated by GitVersion.
@@ -67,19 +70,17 @@ derived from the package version.
6770

6871
NOTE: We can't use "version" since that's an argument to Cake itself.
6972

70-
#### --where=EXPRESSION
71-
Specifies that packaging should be done for selected packages, rather
72-
than all of them. This is useful for debugging and testing projects
73-
which produce multiple packages.
74-
75-
A simple expression is of the form `id=VALUE` or `type=VALUE`, where
76-
`id` specifies a package id and `type` specifies a package type:
77-
NuGet, Chocolatey or Zip. Both the key word and the value are case-inensitive.
78-
79-
More complex expressions may be formed by use of & or |, with the usual
80-
precedence given to the operators. Use of parentheses is not supported.
81-
82-
#### --level=LEVEL
73+
#### --where=SELECTION [-w]
74+
Specifies a selction expression used to choose which packages
75+
to build and test, for use in debugging. Consists of one or
76+
more specifications, separated by '|' and '&'. Each specification
77+
is of the form "prop=value", where prop may be either id or type.
78+
Examples:
79+
--where type=nuget
80+
--where id=NUnit.Engine.Api
81+
--where "type=nuget|type=choco"
82+
83+
#### --level=LEVEL [--lev]
8384
Specifies the level of package testing, which is normally set
8485
automatically for different types of builds like CI, PR, etc.
8586
Used by developers to test packages locally without creating
@@ -88,17 +89,17 @@ a PR or publishing the package. Defined levels are
8889
2. Adds more tests for PRs and Dev builds uploaded to MyGet
8990
3. Adds even more tests prior to publishing a release
9091

91-
#### --trace=LEVEL
92+
#### --trace=LEVEL [--tr]
9293
Specifies the default trace level for this run. Values are Off,
9394
Error, Warning, Info or Debug. Default is Off.
9495

95-
#### --nobuild
96+
#### --nobuild [--nob]
9697
Indicates that the Build task should not be run even if other
9798
tasks depend on it. The existing build is used instead.
9899

99-
#### --nopush
100+
#### --nopush [--nop]
100101
Indicates that no publishing or releasing should be done. If
101102
publish or release targets are run, a message is displayed.
102103

103-
#### --usage
104+
#### --usage [--us]
104105
Displays a general help message. No targets are run.

recipe/help-messages.cake

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,19 @@
1414
1515
Options:
1616
17-
--target=TARGET [-t]
18-
The TARGET task to be run, e.g. Test. Default is Build.
17+
--target=TARGET [-t]
18+
The TARGET task to be run, e.g. Test. Default is Build. For a list
19+
of supported targets, use the Cake `--description` option.
1920
20-
--configuration=CONFIG [-c]
21+
--configuration=CONFIG [-c]
2122
The name of the configuration to build. Default is Release.
2223
23-
--packageVersion [--pack]
24+
--packageVersion=VERSION [--pack]
2425
Specifies the full package version, including any pre-release
2526
suffix. If provided, this version is used directly in place of
2627
the default version calculated by the script.
2728
28-
--where=SELECTION [-w]
29+
--where=SELECTION [-w]
2930
Specifies a selction expression used to choose which packages
3031
to build and test, for use in debugging. Consists of one or
3132
more specifications, separated by '|' and '&'. Each specification
@@ -35,27 +36,25 @@
3536
--where id=NUnit.Engine.Api
3637
--where "type=nuget|type=choco"
3738
38-
--level=LEVEL [--lev]
39+
--level=LEVEL [--lev]
3940
Specifies the level of package testing, 1, 2 or 3. Defaults are
4041
1 = for normal CI tests run every time you build a package
4142
2 = for PRs and Dev builds uploaded to MyGet
4243
3 = prior to publishing a release
4344
44-
--trace=LEVEL [--tr]
45+
--trace=LEVEL [--tr]
4546
Specifies the default trace level for this run. Values are Off,
46-
Error, Warning, Info or Debug. Default is value of environment
47-
variable NUNIT_INTERNAL_TRACE_LEVEL if set. If not,
48-
tracing is turned Off.
47+
Error, Warning, Info or Debug. Default is Off.
4948
50-
--nobuild [--nob]
49+
--nobuild [--nob]
5150
Indicates that the Build task should not be run even if other
5251
tasks depend on it. The existing build is used instead.
5352
54-
--nopush [--nop]
53+
--nopush [--nop]
5554
Indicates that no publishing or releasing should be done. If
5655
publish or release targets are run, a message is displayed.
5756
58-
--usage [--us]
57+
--usage [--us]
5958
Displays this help message. No targets are run.
6059
6160
Selected Cake Options:

0 commit comments

Comments
 (0)