diff --git a/GenerateDocs.ps1 b/GenerateDocs.ps1 index 1b5aaecbfa..e5d3a5645c 100644 --- a/GenerateDocs.ps1 +++ b/GenerateDocs.ps1 @@ -23,6 +23,7 @@ $psModuleLocation = [System.IO.Path]::GetFullPath("$thisDirectory\src\chocolatey $docsFolder = [System.IO.Path]::GetFullPath("$thisDirectory\docs\generated") $chocoExe = [System.IO.Path]::GetFullPath("$thisDirectory\code_drop\chocolatey\console\choco.exe") $lineFeed = "`r`n" +$srcFunctions = 'https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions' $global:powerShellReferenceTOC = @' # PowerShell Functions aka Helpers Reference @@ -309,6 +310,8 @@ $( if ($_.relatedLinks -ne $null) {Write-Output "$lineFeed## Links$lineFeed$line [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from ``Import-Module `"`$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1`" -Force; Get-Help $($_.Name) -Full``. + +View the source for [$($_.Name)]($srcFunctions/$($_.Name)`.ps1) "@ | Out-File $fileName -Encoding UTF8 -Force } @@ -317,6 +320,7 @@ $( if ($_.relatedLinks -ne $null) {Write-Output "$lineFeed## Links$lineFeed$line $global:powerShellReferenceTOC += @' + ## Variables There are also a number of environment variables providing access to some values from the nuspec and other information that may be useful. They are accessed via `$env:variableName`. diff --git a/docs/generated/CommandsInstall.md b/docs/generated/CommandsInstall.md index 0113f0a0b4..f0bd3b5d3e 100644 --- a/docs/generated/CommandsInstall.md +++ b/docs/generated/CommandsInstall.md @@ -236,6 +236,14 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch PackageParameters - Parameters to pass to the package. Defaults to unspecified. + --apply-install-arguments-to-dependencies + Apply Install Arguments To Dependencies - Should install arguments be + applied to dependent packages? Defaults to false. + + --apply-package-parameters-to-dependencies + Apply Package Parameters To Dependencies - Should package parameters be + applied to dependent packages? Defaults to false. + --allowdowngrade, --allow-downgrade AllowDowngrade - Should an attempt at downgrading be allowed? Defaults to false. diff --git a/docs/generated/CommandsUninstall.md b/docs/generated/CommandsUninstall.md index c944165071..b35c977485 100644 --- a/docs/generated/CommandsUninstall.md +++ b/docs/generated/CommandsUninstall.md @@ -150,6 +150,14 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch PackageParameters - Parameters to pass to the package. Defaults to unspecified. + --apply-install-arguments-to-dependencies + Apply Install Arguments To Dependencies - Should install arguments be + applied to dependent packages? Defaults to false. + + --apply-package-parameters-to-dependencies + Apply Package Parameters To Dependencies - Should package parameters be + applied to dependent packages? Defaults to false. + -m, --sxs, --sidebyside, --side-by-side, --allowmultiple, --allow-multiple, --allowmultipleversions, --allow-multiple-versions AllowMultipleVersions - Should multiple versions of a package be installed? Defaults to false. diff --git a/docs/generated/CommandsUpgrade.md b/docs/generated/CommandsUpgrade.md index d608a8a893..43eb1e5642 100644 --- a/docs/generated/CommandsUpgrade.md +++ b/docs/generated/CommandsUpgrade.md @@ -135,6 +135,14 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch PackageParameters - Parameters to pass to the package. Defaults to unspecified. + --apply-install-arguments-to-dependencies + Apply Install Arguments To Dependencies - Should install arguments be + applied to dependent packages? Defaults to false. + + --apply-package-parameters-to-dependencies + Apply Package Parameters To Dependencies - Should package parameters be + applied to dependent packages? Defaults to false. + --allowdowngrade, --allow-downgrade AllowDowngrade - Should an attempt at downgrading be allowed? Defaults to false. diff --git a/docs/generated/HelpersFormatFileSize.md b/docs/generated/HelpersFormatFileSize.md index da4da2a84a..2c6bb3f9bc 100644 --- a/docs/generated/HelpersFormatFileSize.md +++ b/docs/generated/HelpersFormatFileSize.md @@ -78,3 +78,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Format-FileSize -Full`. + +View the source for [Format-FileSize](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Format-FileSize.ps1) diff --git a/docs/generated/HelpersGetChecksumValid.md b/docs/generated/HelpersGetChecksumValid.md index 6beca1eba1..68cfa5eb8a 100644 --- a/docs/generated/HelpersGetChecksumValid.md +++ b/docs/generated/HelpersGetChecksumValid.md @@ -175,3 +175,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChecksumValid -Full`. + +View the source for [Get-ChecksumValid](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChecksumValid.ps1) diff --git a/docs/generated/HelpersGetChocolateyUnzip.md b/docs/generated/HelpersGetChocolateyUnzip.md index ae7277a82b..cb8e29f8e2 100644 --- a/docs/generated/HelpersGetChocolateyUnzip.md +++ b/docs/generated/HelpersGetChocolateyUnzip.md @@ -133,3 +133,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChocolateyUnzip -Full`. + +View the source for [Get-ChocolateyUnzip](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChocolateyUnzip.ps1) diff --git a/docs/generated/HelpersGetChocolateyWebFile.md b/docs/generated/HelpersGetChocolateyWebFile.md index 303e0208a4..37aa6fc3ec 100644 --- a/docs/generated/HelpersGetChocolateyWebFile.md +++ b/docs/generated/HelpersGetChocolateyWebFile.md @@ -322,3 +322,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ChocolateyWebFile -Full`. + +View the source for [Get-ChocolateyWebFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1) diff --git a/docs/generated/HelpersGetEnvironmentVariable.md b/docs/generated/HelpersGetEnvironmentVariable.md index ebefe24aa6..95b23d11aa 100644 --- a/docs/generated/HelpersGetEnvironmentVariable.md +++ b/docs/generated/HelpersGetEnvironmentVariable.md @@ -117,3 +117,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-EnvironmentVariable -Full`. + +View the source for [Get-EnvironmentVariable](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-EnvironmentVariable.ps1) diff --git a/docs/generated/HelpersGetEnvironmentVariableNames.md b/docs/generated/HelpersGetEnvironmentVariableNames.md index 903814561f..0bdb0b704c 100644 --- a/docs/generated/HelpersGetEnvironmentVariableNames.md +++ b/docs/generated/HelpersGetEnvironmentVariableNames.md @@ -53,3 +53,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-EnvironmentVariableNames -Full`. + +View the source for [Get-EnvironmentVariableNames](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-EnvironmentVariableNames.ps1) diff --git a/docs/generated/HelpersGetFtpFile.md b/docs/generated/HelpersGetFtpFile.md index 5fe65e65b8..fa26e76b98 100644 --- a/docs/generated/HelpersGetFtpFile.md +++ b/docs/generated/HelpersGetFtpFile.md @@ -123,3 +123,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-FtpFile -Full`. + +View the source for [Get-FtpFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1) diff --git a/docs/generated/HelpersGetOSArchitectureWidth.md b/docs/generated/HelpersGetOSArchitectureWidth.md index 840e7d584e..656b4e97a2 100644 --- a/docs/generated/HelpersGetOSArchitectureWidth.md +++ b/docs/generated/HelpersGetOSArchitectureWidth.md @@ -45,3 +45,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-OSArchitectureWidth -Full`. + +View the source for [Get-OSArchitectureWidth](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-OSArchitectureWidth.ps1) diff --git a/docs/generated/HelpersGetToolsLocation.md b/docs/generated/HelpersGetToolsLocation.md index 43ce0bd65e..19b7456a3f 100644 --- a/docs/generated/HelpersGetToolsLocation.md +++ b/docs/generated/HelpersGetToolsLocation.md @@ -51,3 +51,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-ToolsLocation -Full`. + +View the source for [Get-ToolsLocation](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-ToolsLocation.ps1) diff --git a/docs/generated/HelpersGetUACEnabled.md b/docs/generated/HelpersGetUACEnabled.md index 0de877736d..27ac175e76 100644 --- a/docs/generated/HelpersGetUACEnabled.md +++ b/docs/generated/HelpersGetUACEnabled.md @@ -38,3 +38,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-UACEnabled -Full`. + +View the source for [Get-UACEnabled](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-UACEnabled.ps1) diff --git a/docs/generated/HelpersGetUninstallRegistryKey.md b/docs/generated/HelpersGetUninstallRegistryKey.md index 94727e988b..1f6343a02e 100644 --- a/docs/generated/HelpersGetUninstallRegistryKey.md +++ b/docs/generated/HelpersGetUninstallRegistryKey.md @@ -117,3 +117,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-UninstallRegistryKey -Full`. + +View the source for [Get-UninstallRegistryKey](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-UninstallRegistryKey.ps1) diff --git a/docs/generated/HelpersGetVirusCheckValid.md b/docs/generated/HelpersGetVirusCheckValid.md index 901f440b87..632ea18723 100644 --- a/docs/generated/HelpersGetVirusCheckValid.md +++ b/docs/generated/HelpersGetVirusCheckValid.md @@ -78,3 +78,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-VirusCheckValid -Full`. + +View the source for [Get-VirusCheckValid](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-VirusCheckValid.ps1) diff --git a/docs/generated/HelpersGetWebFile.md b/docs/generated/HelpersGetWebFile.md index 6082bec1b5..30cac39a3b 100644 --- a/docs/generated/HelpersGetWebFile.md +++ b/docs/generated/HelpersGetWebFile.md @@ -139,3 +139,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-WebFile -Full`. + +View the source for [Get-WebFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1) diff --git a/docs/generated/HelpersGetWebFileName.md b/docs/generated/HelpersGetWebFileName.md index 7adb5d1595..aa736f6ab3 100644 --- a/docs/generated/HelpersGetWebFileName.md +++ b/docs/generated/HelpersGetWebFileName.md @@ -114,3 +114,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-WebFileName -Full`. + +View the source for [Get-WebFileName](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-WebFileName.ps1) diff --git a/docs/generated/HelpersGetWebHeaders.md b/docs/generated/HelpersGetWebHeaders.md index f551568d79..245cf8c435 100644 --- a/docs/generated/HelpersGetWebHeaders.md +++ b/docs/generated/HelpersGetWebHeaders.md @@ -84,3 +84,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-WebHeaders -Full`. + +View the source for [Get-WebHeaders](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Get-WebHeaders.ps1) diff --git a/docs/generated/HelpersInstallBinFile.md b/docs/generated/HelpersInstallBinFile.md index d23800209a..eb0fbe35d9 100644 --- a/docs/generated/HelpersInstallBinFile.md +++ b/docs/generated/HelpersInstallBinFile.md @@ -127,3 +127,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-BinFile -Full`. + +View the source for [Install-BinFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-BinFile.ps1) diff --git a/docs/generated/HelpersInstallChocolateyDesktopLink.md b/docs/generated/HelpersInstallChocolateyDesktopLink.md index 4bfe7303c2..137341800d 100644 --- a/docs/generated/HelpersInstallChocolateyDesktopLink.md +++ b/docs/generated/HelpersInstallChocolateyDesktopLink.md @@ -88,3 +88,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyDesktopLink -Full`. + +View the source for [Install-ChocolateyDesktopLink](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyDesktopLink.ps1) diff --git a/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md b/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md index 87e00fb096..3c155ef0f1 100644 --- a/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md +++ b/docs/generated/HelpersInstallChocolateyEnvironmentVariable.md @@ -140,3 +140,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyEnvironmentVariable -Full`. + +View the source for [Install-ChocolateyEnvironmentVariable](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyEnvironmentVariable.ps1) diff --git a/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md b/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md index 45b483a917..215aeae8e9 100644 --- a/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md +++ b/docs/generated/HelpersInstallChocolateyExplorerMenuItem.md @@ -143,3 +143,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyExplorerMenuItem -Full`. + +View the source for [Install-ChocolateyExplorerMenuItem](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyExplorerMenuItem.ps1) diff --git a/docs/generated/HelpersInstallChocolateyFileAssociation.md b/docs/generated/HelpersInstallChocolateyFileAssociation.md index 3b8b5703ad..3983e6a463 100644 --- a/docs/generated/HelpersInstallChocolateyFileAssociation.md +++ b/docs/generated/HelpersInstallChocolateyFileAssociation.md @@ -93,3 +93,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyFileAssociation -Full`. + +View the source for [Install-ChocolateyFileAssociation](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyFileAssociation.ps1) diff --git a/docs/generated/HelpersInstallChocolateyInstallPackage.md b/docs/generated/HelpersInstallChocolateyInstallPackage.md index 2b52bb02c6..4a1c7fbc47 100644 --- a/docs/generated/HelpersInstallChocolateyInstallPackage.md +++ b/docs/generated/HelpersInstallChocolateyInstallPackage.md @@ -222,3 +222,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyInstallPackage -Full`. + +View the source for [Install-ChocolateyInstallPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyInstallPackage.ps1) diff --git a/docs/generated/HelpersInstallChocolateyPackage.md b/docs/generated/HelpersInstallChocolateyPackage.md index 0e17555ea8..c51457584c 100644 --- a/docs/generated/HelpersInstallChocolateyPackage.md +++ b/docs/generated/HelpersInstallChocolateyPackage.md @@ -406,3 +406,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyPackage -Full`. + +View the source for [Install-ChocolateyPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1) diff --git a/docs/generated/HelpersInstallChocolateyPath.md b/docs/generated/HelpersInstallChocolateyPath.md index 8de2c72e6f..05b95c363e 100644 --- a/docs/generated/HelpersInstallChocolateyPath.md +++ b/docs/generated/HelpersInstallChocolateyPath.md @@ -109,3 +109,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyPath -Full`. + +View the source for [Install-ChocolateyPath](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyPath.ps1) diff --git a/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md b/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md index 878136d992..60b04a389d 100644 --- a/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md +++ b/docs/generated/HelpersInstallChocolateyPinnedTaskBarItem.md @@ -77,3 +77,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyPinnedTaskBarItem -Full`. + +View the source for [Install-ChocolateyPinnedTaskBarItem](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyPinnedTaskBarItem.ps1) diff --git a/docs/generated/HelpersInstallChocolateyPowershellCommand.md b/docs/generated/HelpersInstallChocolateyPowershellCommand.md index 1c5584d510..5954a5becf 100644 --- a/docs/generated/HelpersInstallChocolateyPowershellCommand.md +++ b/docs/generated/HelpersInstallChocolateyPowershellCommand.md @@ -278,3 +278,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyPowershellCommand -Full`. + +View the source for [Install-ChocolateyPowershellCommand](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyPowershellCommand.ps1) diff --git a/docs/generated/HelpersInstallChocolateyShortcut.md b/docs/generated/HelpersInstallChocolateyShortcut.md index cf0b82048b..6d3bbfb686 100644 --- a/docs/generated/HelpersInstallChocolateyShortcut.md +++ b/docs/generated/HelpersInstallChocolateyShortcut.md @@ -222,3 +222,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyShortcut -Full`. + +View the source for [Install-ChocolateyShortcut](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyShortcut.ps1) diff --git a/docs/generated/HelpersInstallChocolateyVsixPackage.md b/docs/generated/HelpersInstallChocolateyVsixPackage.md index 068ddf642a..83b8384b94 100644 --- a/docs/generated/HelpersInstallChocolateyVsixPackage.md +++ b/docs/generated/HelpersInstallChocolateyVsixPackage.md @@ -197,3 +197,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyVsixPackage -Full`. + +View the source for [Install-ChocolateyVsixPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyVsixPackage.ps1) diff --git a/docs/generated/HelpersInstallChocolateyZipPackage.md b/docs/generated/HelpersInstallChocolateyZipPackage.md index dc7af3beff..c0f775b6aa 100644 --- a/docs/generated/HelpersInstallChocolateyZipPackage.md +++ b/docs/generated/HelpersInstallChocolateyZipPackage.md @@ -279,3 +279,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-ChocolateyZipPackage -Full`. + +View the source for [Install-ChocolateyZipPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-ChocolateyZipPackage.ps1) diff --git a/docs/generated/HelpersInstallVsix.md b/docs/generated/HelpersInstallVsix.md index ed5fdc1593..c6e348633e 100644 --- a/docs/generated/HelpersInstallVsix.md +++ b/docs/generated/HelpersInstallVsix.md @@ -80,3 +80,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Install-Vsix -Full`. + +View the source for [Install-Vsix](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Install-Vsix.ps1) diff --git a/docs/generated/HelpersReference.md b/docs/generated/HelpersReference.md index 4b664e24f2..b7d0a0b95c 100644 --- a/docs/generated/HelpersReference.md +++ b/docs/generated/HelpersReference.md @@ -92,6 +92,7 @@ These are the functions from above as one list. * [[Write-ChocolateyFailure|HelpersWriteChocolateyFailure]] * [[Write-ChocolateySuccess|HelpersWriteChocolateySuccess]] * [[Write-FileUpdateLog|HelpersWriteFileUpdateLog]] + ## Variables There are also a number of environment variables providing access to some values from the nuspec and other information that may be useful. They are accessed via `$env:variableName`. diff --git a/docs/generated/HelpersSetEnvironmentVariable.md b/docs/generated/HelpersSetEnvironmentVariable.md index c0e098c772..cf6a75f186 100644 --- a/docs/generated/HelpersSetEnvironmentVariable.md +++ b/docs/generated/HelpersSetEnvironmentVariable.md @@ -95,3 +95,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Set-EnvironmentVariable -Full`. + +View the source for [Set-EnvironmentVariable](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Set-EnvironmentVariable.ps1) diff --git a/docs/generated/HelpersSetPowerShellExitCode.md b/docs/generated/HelpersSetPowerShellExitCode.md index ae82bb6439..e5a4698426 100644 --- a/docs/generated/HelpersSetPowerShellExitCode.md +++ b/docs/generated/HelpersSetPowerShellExitCode.md @@ -73,3 +73,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Set-PowerShellExitCode -Full`. + +View the source for [Set-PowerShellExitCode](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Set-PowerShellExitCode.ps1) diff --git a/docs/generated/HelpersStartChocolateyProcessAsAdmin.md b/docs/generated/HelpersStartChocolateyProcessAsAdmin.md index 95003410dd..5b7aea072a 100644 --- a/docs/generated/HelpersStartChocolateyProcessAsAdmin.md +++ b/docs/generated/HelpersStartChocolateyProcessAsAdmin.md @@ -190,3 +190,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Start-ChocolateyProcessAsAdmin -Full`. + +View the source for [Start-ChocolateyProcessAsAdmin](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Start-ChocolateyProcessAsAdmin.ps1) diff --git a/docs/generated/HelpersTestProcessAdminRights.md b/docs/generated/HelpersTestProcessAdminRights.md index d142287667..63de9ea673 100644 --- a/docs/generated/HelpersTestProcessAdminRights.md +++ b/docs/generated/HelpersTestProcessAdminRights.md @@ -40,3 +40,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Test-ProcessAdminRights -Full`. + +View the source for [Test-ProcessAdminRights](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Test-ProcessAdminRights.ps1) diff --git a/docs/generated/HelpersUnInstallChocolateyZipPackage.md b/docs/generated/HelpersUnInstallChocolateyZipPackage.md index ae295204c5..88d017aa0b 100644 --- a/docs/generated/HelpersUnInstallChocolateyZipPackage.md +++ b/docs/generated/HelpersUnInstallChocolateyZipPackage.md @@ -95,3 +95,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Uninstall-ChocolateyZipPackage -Full`. + +View the source for [Uninstall-ChocolateyZipPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Uninstall-ChocolateyZipPackage.ps1) diff --git a/docs/generated/HelpersUninstallBinFile.md b/docs/generated/HelpersUninstallBinFile.md index 6e90959ad8..51d6d11919 100644 --- a/docs/generated/HelpersUninstallBinFile.md +++ b/docs/generated/HelpersUninstallBinFile.md @@ -89,3 +89,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Uninstall-BinFile -Full`. + +View the source for [Uninstall-BinFile](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Uninstall-BinFile.ps1) diff --git a/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md b/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md index 611a5cc1f8..355be0298a 100644 --- a/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md +++ b/docs/generated/HelpersUninstallChocolateyEnvironmentVariable.md @@ -114,3 +114,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Uninstall-ChocolateyEnvironmentVariable -Full`. + +View the source for [Uninstall-ChocolateyEnvironmentVariable](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Uninstall-ChocolateyEnvironmentVariable.ps1) diff --git a/docs/generated/HelpersUninstallChocolateyPackage.md b/docs/generated/HelpersUninstallChocolateyPackage.md index 994a808839..166eee2c09 100644 --- a/docs/generated/HelpersUninstallChocolateyPackage.md +++ b/docs/generated/HelpersUninstallChocolateyPackage.md @@ -169,3 +169,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Uninstall-ChocolateyPackage -Full`. + +View the source for [Uninstall-ChocolateyPackage](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Uninstall-ChocolateyPackage.ps1) diff --git a/docs/generated/HelpersUpdateSessionEnvironment.md b/docs/generated/HelpersUpdateSessionEnvironment.md index 080cfa0ce7..c470da0f88 100644 --- a/docs/generated/HelpersUpdateSessionEnvironment.md +++ b/docs/generated/HelpersUpdateSessionEnvironment.md @@ -52,3 +52,5 @@ None [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Update-SessionEnvironment -Full`. + +View the source for [Update-SessionEnvironment](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Update-SessionEnvironment.ps1) diff --git a/docs/generated/HelpersWriteChocolateyFailure.md b/docs/generated/HelpersWriteChocolateyFailure.md index d06a5f6688..03c1d89516 100644 --- a/docs/generated/HelpersWriteChocolateyFailure.md +++ b/docs/generated/HelpersWriteChocolateyFailure.md @@ -83,3 +83,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Write-ChocolateyFailure -Full`. + +View the source for [Write-ChocolateyFailure](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Write-ChocolateyFailure.ps1) diff --git a/docs/generated/HelpersWriteChocolateySuccess.md b/docs/generated/HelpersWriteChocolateySuccess.md index e1bf5150ef..26301eb797 100644 --- a/docs/generated/HelpersWriteChocolateySuccess.md +++ b/docs/generated/HelpersWriteChocolateySuccess.md @@ -71,3 +71,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Write-ChocolateySuccess -Full`. + +View the source for [Write-ChocolateySuccess](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Write-ChocolateySuccess.ps1) diff --git a/docs/generated/HelpersWriteFileUpdateLog.md b/docs/generated/HelpersWriteFileUpdateLog.md index 79077b71c6..a667ecab64 100644 --- a/docs/generated/HelpersWriteFileUpdateLog.md +++ b/docs/generated/HelpersWriteFileUpdateLog.md @@ -100,3 +100,5 @@ This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -Err [[Function Reference|HelpersReference]] ***NOTE:*** This documentation has been automatically generated from `Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Write-FileUpdateLog -Full`. + +View the source for [Write-FileUpdateLog](https://github.com/chocolatey/choco/tree/stable/src/chocolatey.resources/helpers/functions/Write-FileUpdateLog.ps1) diff --git a/src/chocolatey.resources/chocolatey.resources.csproj b/src/chocolatey.resources/chocolatey.resources.csproj index 7b88613372..41b456b674 100644 --- a/src/chocolatey.resources/chocolatey.resources.csproj +++ b/src/chocolatey.resources/chocolatey.resources.csproj @@ -157,6 +157,9 @@ + + +