(doc) update from generated docs

chocolatey · Mar 23, 2018 · 09afbe7 · 09afbe7
1 parent b50e26a
commit 09afbe7
Show file tree

Hide file tree

Showing 28 changed files with 135 additions and 7 deletions.
diff --git a/CommandsApiKey.md b/CommandsApiKey.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsConfig.md b/CommandsConfig.md
@@ -56,6 +56,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsDownload.md b/CommandsDownload.md
@@ -70,6 +70,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsFeature.md b/CommandsFeature.md
@@ -42,6 +42,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsFeatures.md b/CommandsFeatures.md
@@ -42,6 +42,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsInfo.md b/CommandsInfo.md
@@ -35,6 +35,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsInstall.md b/CommandsInstall.md
@@ -173,6 +173,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsList.md b/CommandsList.md
@@ -75,6 +75,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsNew.md b/CommandsNew.md
@@ -81,6 +81,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsOptimize.md b/CommandsOptimize.md
@@ -67,6 +67,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsOutdated.md b/CommandsOutdated.md
@@ -53,6 +53,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.
@@ -154,6 +158,12 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      Ignore Pinned - Ignore pinned packages. Defaults to false. Available in 
        0.10.6+.
 
+     --ignore-unfound
+     Ignore Unfound Packages - Ignore packages that are not found on the 
+       sources used (or the defaults). Overrides the default feature 
+       'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
+       0.10.9+.
+
 ~~~
 
 [[Command Reference|CommandsReference]]

diff --git a/CommandsPack.md b/CommandsPack.md
@@ -57,6 +57,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsPin.md b/CommandsPin.md
@@ -48,6 +48,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsPush.md b/CommandsPush.md
@@ -74,6 +74,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsReference.md b/CommandsReference.md
@@ -33,6 +33,7 @@ This is a listing of all of the different things you can pass to choco.
  * [[sync|CommandsSync]] - synchronizes against system installed software - generates missing packages
  * [[optimize|CommandsOptimize]] - optimizes installation, reducing space usage
 
+
 Please run chocolatey with `choco command -help` for specific help on
  each command.
 
@@ -103,6 +104,10 @@ You can pass options and switches in the following ways:
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSearch.md b/CommandsSearch.md
@@ -75,6 +75,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSetapiKey.md b/CommandsSetapiKey.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSource.md b/CommandsSource.md
@@ -59,6 +59,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSources.md b/CommandsSources.md
@@ -59,6 +59,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSupport.md b/CommandsSupport.md
@@ -23,6 +23,10 @@ As a licensed customer, you can reach out to
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSync.md b/CommandsSync.md
@@ -58,6 +58,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsSynchronize.md b/CommandsSynchronize.md
@@ -58,6 +58,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsUninstall.md b/CommandsUninstall.md
@@ -102,6 +102,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsUnpackself.md b/CommandsUnpackself.md
@@ -2,11 +2,11 @@
 
 # UnpackSelf Command (choco unpackself)
 
-This will unpack files needed by choco. It will overwrite existing 
+This will unpack files needed by choco. It will overwrite existing
  files only if --force is specified.
 
-**NOTE:** This command should only be used when installing Chocolatey, not 
- during normal operation. 
+**NOTE:** This command should only be used when installing Chocolatey, not
+ during normal operation.
 
 
 ## Options and Switches
@@ -36,6 +36,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsUpdate.md b/CommandsUpdate.md
@@ -33,6 +33,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/CommandsUpgrade.md b/CommandsUpgrade.md
@@ -72,6 +72,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.
@@ -204,8 +208,14 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
      Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false.
 
      --failonunfound, --fail-on-unfound
-     Fail On Unfound Packages - If a package is not found in feeds specified, 
-       fail instead of warn.
+     Fail On Unfound Packages - If a package is not found in sources 
+       specified, fail instead of warn.
+
+     --ignore-unfound
+     Ignore Unfound Packages - Ignore packages that are not found on the 
+       sources used (or the defaults). Overrides the default feature 
+       'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
+       0.10.9+.
 
      --failonnotinstalled, --fail-on-not-installed
      Fail On Non-installed Packages - If a package is not already installed, 

diff --git a/CommandsVersion.md b/CommandsVersion.md
@@ -37,6 +37,10 @@ Includes [[default options/switches|CommandsReference#default-options-and-switch
        except when needing super low-level .NET Framework debugging. Available 
        in 0.10.4+.
 
+     --nocolor, --no-color
+     No Color - Do not show colorization in logging output. This overrides 
+       the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.
+
      --acceptlicense, --accept-license
      AcceptLicense - Accept license dialogs automatically. Reserved for 
        future use.

diff --git a/HelpersGetPackageParameters.md b/HelpersGetPackageParameters.md
@@ -42,7 +42,8 @@ build all docs with `/Item:Value`.
 
 ## Aliases
 
-None
+`Get-PackageParametersBuiltIn`
+
 
 ## Examples
 
@@ -78,7 +79,7 @@ if (!$pp['LICENSE']) { $pp['LICENSE'] = '1234' }
 
 $pp = Get-PackageParameters
 if (!$pp['UserName']) { $pp['UserName'] = "$env:UserName" }
-# Requires 0.10.8 for Read-Host -AsSecureString
+# Requires Choocolatey v0.10.8+ for Read-Host -AsSecureString
 if (!$pp['Password']) { $pp['Password'] = Read-Host "Enter password for $($pp['UserName']):" -AsSecureString}
 # fail the install/upgrade if not value is not determined
 if (!$pp['Password']) { throw "Package needs Password to install, that must be provided in params or in prompt." }
@@ -114,6 +115,12 @@ compatibility with `chocolatey-core.extension`, use `:`.
 
 For example `-Parameters "/ITEM1:value /ITEM2:value with spaces"
 
+NOTE: In 0.10.9+, to maintain compatibility with the prior art of the 
+chocolatey-core.extension method, quotes and apostrophes surrounding
+parameter values will be removed. When the param is used, those items
+can be added back if desired, but it's most important to ensure that
+existing packages are compatible on upgrade.
+
 Property               | Value
 ---------------------- | ------
 Aliases                | params