Document environment variables in usage

This commit is contained in:
Steve Streeting 2020-05-11 14:57:10 +01:00
parent bbec3852f6
commit a190a9b07e

View File

@ -23,6 +23,14 @@ function Print-Usage {
Write-Output " -nocloseeditor : Don't close UE4 editor (this will prevent DLL cleanup)" Write-Output " -nocloseeditor : Don't close UE4 editor (this will prevent DLL cleanup)"
Write-Output " -dryrun : Don't perform any actual actions, just report on what you would do" Write-Output " -dryrun : Don't perform any actual actions, just report on what you would do"
Write-Output " -help : Print this help" Write-Output " -help : Print this help"
Write-Output " "
Write-Output "Environment Variables:"
Write-Output " UE4INSTALL : Use a specific UE4 install."
Write-Output " : Default is to find one based on project version, under UE4ROOT"
Write-Output " UE4ROOT : Parent folder of all binary UE4 installs (detects version). "
Write-Output " : Default C:\Program Files\Epic Games"
Write-Output " "
} }
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
@ -39,7 +47,7 @@ if (-not $mode) {
Exit 3 Exit 3
} }
if (-not (@('dev', 'test', 'prod') -contains $mode)) { if (-not ($mode -in @('dev', 'test', 'prod'))) {
Print-Usage Print-Usage
Write-Output "ERROR: Invalid mode argument: $mode" Write-Output "ERROR: Invalid mode argument: $mode"
Exit 3 Exit 3