Skip to content

Commit caa8ab9

Browse files
authored
Merge pull request #1086 from vexx32/shouldprocess
(doc) Update cmdlet docs for ShouldProcess support
2 parents d658ca2 + b41cdbd commit caa8ab9

File tree

4 files changed

+124
-4
lines changed

4 files changed

+124
-4
lines changed

src/content/docs/en-us/create/cmdlets/Install-ChocolateyPath.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This puts a directory to the PATH environment variable.
2222

2323
```
2424
Install-ChocolateyPath [-Path] <String> [[-PathType] <EnvironmentVariableTarget>]
25-
[-IgnoredArguments <Object[]>] [<CommonParameters>]
25+
[-IgnoredArguments <Object[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

2828
## DESCRIPTION
@@ -92,6 +92,36 @@ Accept pipeline input: False
9292
Accept wildcard characters: False
9393
```
9494

95+
### -Confirm
96+
Prompts you for confirmation before running the cmdlet.
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases: cf
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -WhatIf
111+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
112+
113+
```yaml
114+
Type: SwitchParameter
115+
Parameter Sets: (All)
116+
Aliases: wi
117+
118+
Required: False
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
95125
### CommonParameters
96126
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).
97127

src/content/docs/en-us/create/cmdlets/Set-EnvironmentVariable.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ DO NOT USE. Not part of the public API. Use `Install-ChocolateyEnvironmentVariab
2222

2323
```
2424
Set-EnvironmentVariable [-Name] <String> [[-Value] <String>] [[-Scope] <EnvironmentVariableTarget>]
25-
[-IgnoredArguments <Object[]>] [<CommonParameters>]
25+
[-IgnoredArguments <Object[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

2828
## DESCRIPTION
@@ -100,6 +100,36 @@ Accept pipeline input: False
100100
Accept wildcard characters: False
101101
```
102102
103+
### -Confirm
104+
Prompts you for confirmation before running the cmdlet.
105+
106+
```yaml
107+
Type: SwitchParameter
108+
Parameter Sets: (All)
109+
Aliases: cf
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### -WhatIf
119+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
120+
121+
```yaml
122+
Type: SwitchParameter
123+
Parameter Sets: (All)
124+
Aliases: wi
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: False
130+
Accept wildcard characters: False
131+
```
132+
103133
### CommonParameters
104134
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).
105135

src/content/docs/en-us/create/cmdlets/Uninstall-ChocolateyPath.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This puts a directory to the PATH environment variable.
2222

2323
```
2424
Uninstall-ChocolateyPath [-Path] <String> [[-PathType] <EnvironmentVariableTarget>]
25-
[-IgnoredArguments <Object[]>] [<CommonParameters>]
25+
[-IgnoredArguments <Object[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

2828
## DESCRIPTION
@@ -92,6 +92,36 @@ Accept pipeline input: False
9292
Accept wildcard characters: False
9393
```
9494

95+
### -Confirm
96+
Prompts you for confirmation before running the cmdlet.
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases: cf
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -WhatIf
111+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
112+
113+
```yaml
114+
Type: SwitchParameter
115+
Parameter Sets: (All)
116+
Aliases: wi
117+
118+
Required: False
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
95125
### CommonParameters
96126
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).
97127

src/content/docs/en-us/create/cmdlets/Update-SessionEnvironment.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Updates the environment variables of the current powershell session with any env
1818
## SYNTAX
1919

2020
```
21-
Update-SessionEnvironment [-IgnoredArguments <Object[]>] [<CommonParameters>]
21+
Update-SessionEnvironment [-IgnoredArguments <Object[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
@@ -54,6 +54,36 @@ Accept pipeline input: False
5454
Accept wildcard characters: False
5555
```
5656
57+
### -Confirm
58+
Prompts you for confirmation before running the cmdlet.
59+
60+
```yaml
61+
Type: SwitchParameter
62+
Parameter Sets: (All)
63+
Aliases: cf
64+
65+
Required: False
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### -WhatIf
73+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
74+
75+
```yaml
76+
Type: SwitchParameter
77+
Parameter Sets: (All)
78+
Aliases: wi
79+
80+
Required: False
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
5787
### CommonParameters
5888
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).
5989

0 commit comments

Comments
 (0)