Update Build Script Help Content (#2046)
authorViktor Hofer <viktor.hofer@microsoft.com>
Mon, 17 Feb 2020 07:41:46 +0000 (08:41 +0100)
committerGitHub <noreply@github.com>
Mon, 17 Feb 2020 07:41:46 +0000 (08:41 +0100)
* Update Build Script Help Content

Add the new runtime/library configuration arguments.

* PR feedback

eng/build.ps1
eng/build.sh

index 81c417a..cf9297f 100644 (file)
@@ -14,21 +14,24 @@ Param(
   [string]$arch,
   [string]$subsetCategory,
   [string]$subset,
-  [string]$runtimeConfiguration,
-  [string]$librariesConfiguration,
+  [ValidateSet("Debug","Release","Checked")][string]$runtimeConfiguration,
+  [ValidateSet("Debug","Release")][string]$librariesConfiguration,
   [Parameter(ValueFromRemainingArguments=$true)][String[]]$properties
 )
 
 function Get-Help() {
   Write-Host "Common settings:"
-  Write-Host "  -subset                 Build a subset, print available subsets with -subset help"
-  Write-Host "  -subsetCategory         Build a subsetCategory, print available subsetCategories with -subset help"
-  Write-Host "  -os                     Build operating system: Windows_NT or Unix"
-  Write-Host "  -arch                   Build platform: x86, x64, arm or arm64"
-  Write-Host "  -configuration <value>  Build configuration: Debug or Release (short: -c)"
-  Write-Host "  -verbosity <value>      MSBuild verbosity: q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] (short: -v)"
-  Write-Host "  -binaryLog              Output binary log (short: -bl)"
-  Write-Host "  -help                   Print help and exit (short: -h)"
+  Write-Host "  -subset                   Build a subset, print available subsets with -subset help"
+  Write-Host "  -subsetCategory           Build a subsetCategory, print available subsetCategories with -subset help"
+  Write-Host "  -vs                       Open the solution with VS for Test Explorer support. Path or solution name (ie -vs Microsoft.CSharp)"
+  Write-Host "  -os                       Build operating system: Windows_NT or Unix"
+  Write-Host "  -arch                     Build platform: x86, x64, arm or arm64"
+  Write-Host "  -configuration            Build configuration: Debug, Release or [CoreCLR]Checked (short: -c)"
+  Write-Host "  -runtimeConfiguration     Runtime build configuration: Debug, Release or [CoreCLR]Checked"
+  Write-Host "  -librariesConfiguration   Libraries build configuration: Debug or Release"
+  Write-Host "  -verbosity                MSBuild verbosity: q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] (short: -v)"
+  Write-Host "  -binaryLog                Output binary log (short: -bl)"
+  Write-Host "  -help                     Print help and exit (short: -h)"
   Write-Host ""
 
   Write-Host "Actions (defaults to -restore -build):"
@@ -44,7 +47,6 @@ function Get-Help() {
   Write-Host ""
 
   Write-Host "Libraries settings:"
-  Write-Host "  -vs                     Open the solution with VS for Test Explorer support. Path or solution name (ie -vs Microsoft.CSharp)"
   Write-Host "  -framework              Build framework: netcoreapp5.0 or net472 (short: -f)"
   Write-Host "  -coverage               Collect code coverage when testing"
   Write-Host "  -testscope              Scope tests, allowed values: innerloop, outerloop, all"
index 4da7816..22577c6 100755 (executable)
@@ -21,8 +21,10 @@ usage()
   echo "  --subsetCategory           Build a subsetCategory, print available subsetCategories with -subset help"
   echo "  --os                       Build operating system: Windows_NT or Unix"
   echo "  --arch                     Build platform: x86, x64, arm or arm64"
-  echo "  --configuration <value>    Build configuration: Debug or Release (short: -c)"
-  echo "  --verbosity <value>        MSBuild verbosity: q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] (short: -v)"
+  echo "  --configuration            Build configuration: Debug, Release or [CoreCLR]Checked (short: -c)"
+  echo "  --runtimeConfiguration     Runtime build configuration: Debug, Release or [CoreCLR]Checked"
+  echo "  --librariesConfiguration   Libraries build configuration: Debug or Release"
+  echo "  --verbosity                MSBuild verbosity: q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] (short: -v)"
   echo "  --binaryLog                Output binary log (short: -bl)"
   echo "  --cross                    Optional argument to signify cross compilation"
   echo "  --help                     Print help and exit (short: -h)"
@@ -41,7 +43,7 @@ usage()
   echo ""
 
   echo "Libraries settings:"
-  echo "  --framework                Build framework: netcoreapp or net472 (short: -f)"
+  echo "  --framework                Build framework: netcoreapp5.0 or net472 (short: -f)"
   echo "  --coverage                 Collect code coverage when testing"
   echo "  --testscope                Test scope, allowed values: innerloop, outerloop, all"
   echo "  --allconfigurations        Build packages for all build configurations"