Skip to content

Commit

Permalink
Remove ProgressAction from syntax and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
mdanish-kh committed Jul 31, 2024
1 parent d48abfa commit a922bd1
Show file tree
Hide file tree
Showing 19 changed files with 59 additions and 400 deletions.
25 changes: 3 additions & 22 deletions src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ Add a new source.
## SYNTAX

```
Add-WinGetSource -Name <String> -Argument <String> [-Type <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Add-WinGetSource -Name <String> -Argument <String> [-Type <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -28,7 +27,7 @@ Add a new WinGet source.
PS C:\> Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest
```

This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/.
This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/.

> **This example is illustrative and will not succeed because WinGet will not add a source that does not properly respond to the WinGet REST API**
Expand Down Expand Up @@ -67,24 +66,6 @@ Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
Type of the source. Most sources will be "Microsoft.Rest". The WinGet community repository is "Microsoft.PreIndexed.Package".
Expand All @@ -101,7 +82,7 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ Verifies WinGet is installed properly.

### IntegrityVersionSet (Default)
```
Assert-WinGetPackageManager [-Version <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Assert-WinGetPackageManager [-Version <String>] [<CommonParameters>]
```

### IntegrityLatestSet
```
Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -94,24 +93,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Version
Verifies a specific version of WinGet is installed.
Expand All @@ -128,7 +109,7 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Disables an administrative setting.
## SYNTAX

```
Disable-WinGetSetting [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Disable-WinGetSetting [-Name] <String> [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -57,26 +57,8 @@ Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Enables an administrative setting.
## SYNTAX

```
Enable-WinGetSetting [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Enable-WinGetSetting [-Name] <String> [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -56,26 +56,8 @@ Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Export-WinGetPackage [-DownloadDirectory <String>] [-AllowHashMismatch]
[-Architecture <PSProcessorArchitecture>] [-InstallerType <PSPackageInstallerType>] [-Locale <String>]
[-Scope <PSPackageInstallScope>] [-SkipDependencies] [-Version <String>] [-Id <String>] [-Name <String>]
[-Moniker <String>] [-Source <String>] [[-Query] <String[]>] [-MatchOption <PSPackageFieldMatchOption>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```

### GivenSet
```
Export-WinGetPackage [-DownloadDirectory <String>] [-AllowHashMismatch]
[-Architecture <PSProcessorArchitecture>] [-InstallerType <PSPackageInstallerType>] [-Locale <String>]
[-Scope <PSPackageInstallScope>] [-SkipDependencies] [[-PSCatalogPackage] <PSCatalogPackage>]
[-Version <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-Version <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -36,7 +36,7 @@ Downloads a package installer from the pipeline or from a configured source. The

### Example 1: Download Microsoft.PowerShell to the default location
```powershell
PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell
PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell
```

This example will download the latest available version of the Microsoft.PowerShell installer (for the current system and default scope) and the manifest to a folder (named by concatenating the package identifier with an underscore and the version number) in the Downloads directory.
Expand Down Expand Up @@ -181,24 +181,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PSCatalogPackage
Specify PSCatalogPackage
Expand Down Expand Up @@ -322,7 +304,7 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down Expand Up @@ -350,4 +332,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## RELATED LINKS
[Find-WinGetPackage](Find-WinGetPackage.md)
[Find-WinGetPackage](Find-WinGetPackage.md)
22 changes: 2 additions & 20 deletions src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Searches configured sources for packages.
```
Find-WinGetPackage [-Tag <String>] [-Command <String>] [-Count <UInt32>] [-Id <String>] [-Name <String>]
[-Moniker <String>] [-Source <String>] [[-Query] <String[]>] [-MatchOption <PSPackageFieldMatchOption>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -140,24 +140,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Query
Specifies query string to search for
Expand Down Expand Up @@ -204,7 +186,7 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
22 changes: 2 additions & 20 deletions src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ List installed packages.
```
Get-WinGetPackage [-Tag <String>] [-Command <String>] [-Count <UInt32>] [-Id <String>] [-Name <String>]
[-Moniker <String>] [-Source <String>] [[-Query] <String[]>] [-MatchOption <PSPackageFieldMatchOption>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -126,24 +126,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Query
Specifies query string to search for
Expand Down Expand Up @@ -190,7 +172,7 @@ Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
22 changes: 2 additions & 20 deletions src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Get WinGet settings.
## SYNTAX

```
Get-WinGetSettings [-AsPlainText] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-WinGetSettings [-AsPlainText] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -45,26 +45,8 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.
This parameter was added in PowerShell 7.4.
```yaml
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
Expand Down
Loading

0 comments on commit a922bd1

Please sign in to comment.