Annotate ThrowTerminatingError with DoesNotReturn attribute (#15352)

powercode · web-flow · commit efdc500ba531 · 2021-05-06T09:23:34.000-07:00
diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs
@@ -672,6 +672,7 @@ internal virtual CmdletOperationBase CmdletOperation
         /// Throw terminating error
         /// </para>
         /// </summary>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         internal void ThrowTerminatingError(Exception exception, string operation)
         {
             ErrorRecord errorRecord = new(exception, operation, ErrorCategory.InvalidOperation, this);
diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CmdletOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CmdletOperation.cs
@@ -65,6 +65,7 @@ public virtual bool ShouldProcess(string verboseDescription, string verboseWarni
             return cmdlet.ShouldProcess(verboseDescription, verboseWarning, caption, out shouldProcessReason);
         }
 
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         public virtual void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             cmdlet.ThrowTerminatingError(errorRecord);
@@ -115,6 +116,7 @@ public virtual void WriteWarning(string text)
         /// Throw terminating error
         /// </para>
         /// </summary>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         internal void ThrowTerminatingError(Exception exception, string operation)
         {
             ErrorRecord errorRecord = new(exception, operation, ErrorCategory.InvalidOperation, this);
diff --git a/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs b/src/System.Management.Automation/FormatAndOutput/common/BaseCommand.cs
@@ -22,6 +22,7 @@ internal TerminatingErrorContext(PSCmdlet command)
             _command = command;
         }
 
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         internal void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             _command.ThrowTerminatingError(errorRecord);
diff --git a/src/System.Management.Automation/engine/DefaultCommandRuntime.cs b/src/System.Management.Automation/engine/DefaultCommandRuntime.cs
@@ -230,6 +230,7 @@ public PSTransactionContext CurrentPSTransaction
         /// if it exists, otherwise throw an invalid operation exception.
         /// </summary>
         /// <param name="errorRecord">The error record to throw.</param>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         public void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             if (errorRecord.Exception != null)
diff --git a/src/System.Management.Automation/engine/ICommandRuntime.cs b/src/System.Management.Automation/engine/ICommandRuntime.cs
@@ -549,6 +549,7 @@ public interface ICommandRuntime
         /// if any information is to be added. It should encapsulate the
         /// error record into an exception and then throw that exception.
         /// </remarks>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         void ThrowTerminatingError(ErrorRecord errorRecord);
         #endregion ThrowTerminatingError
         #endregion misc
diff --git a/src/System.Management.Automation/engine/MshCommandRuntime.cs b/src/System.Management.Automation/engine/MshCommandRuntime.cs
@@ -2055,6 +2055,7 @@ public PSTransactionContext CurrentPSTransaction
         /// <see cref="System.Management.Automation.Cmdlet.ProcessRecord"/>.
         /// etc.
         /// </remarks>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         public void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             ThrowIfStopping();
diff --git a/src/System.Management.Automation/engine/cmdlet.cs b/src/System.Management.Automation/engine/cmdlet.cs
@@ -1714,6 +1714,7 @@ public PSTransactionContext CurrentPSTransaction
         /// <see cref="System.Management.Automation.Cmdlet.ProcessRecord"/>.
         /// etc.
         /// </remarks>
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         public void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             using (PSTransactionManager.GetEngineProtectionScope())
diff --git a/src/System.Management.Automation/namespaces/ProviderBase.cs b/src/System.Management.Automation/namespaces/ProviderBase.cs
@@ -1417,6 +1417,7 @@ public virtual string GetResourceString(string baseName, string resourceId)
 
         #region ThrowTerminatingError
         /// <Content contentref="System.Management.Automation.Cmdlet.ThrowTerminatingError" />
+        [System.Diagnostics.CodeAnalysis.DoesNotReturn]
         public void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             using (PSTransactionManager.GetEngineProtectionScope())

Original file line number	Diff line number	Diff line change
`@@ -672,6 +672,7 @@ internal virtual CmdletOperationBase CmdletOperation`
`672`	`672`	`/// Throw terminating error`
`673`	`673`	`/// </para>`
`674`	`674`	`/// </summary>`
	`675`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`675`	`676`	`internal void ThrowTerminatingError(Exception exception, string operation)`
`676`	`677`	`{`
`677`	`678`	`ErrorRecord errorRecord = new(exception, operation, ErrorCategory.InvalidOperation, this);`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ public virtual bool ShouldProcess(string verboseDescription, string verboseWarni`
`65`	`65`	`return cmdlet.ShouldProcess(verboseDescription, verboseWarning, caption, out shouldProcessReason);`
`66`	`66`	`}`
`67`	`67`
	`68`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`68`	`69`	`public virtual void ThrowTerminatingError(ErrorRecord errorRecord)`
`69`	`70`	`{`
`70`	`71`	`cmdlet.ThrowTerminatingError(errorRecord);`
`@@ -115,6 +116,7 @@ public virtual void WriteWarning(string text)`
`115`	`116`	`/// Throw terminating error`
`116`	`117`	`/// </para>`
`117`	`118`	`/// </summary>`
	`119`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`118`	`120`	`internal void ThrowTerminatingError(Exception exception, string operation)`
`119`	`121`	`{`
`120`	`122`	`ErrorRecord errorRecord = new(exception, operation, ErrorCategory.InvalidOperation, this);`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ internal TerminatingErrorContext(PSCmdlet command)`
`22`	`22`	`_command = command;`
`23`	`23`	`}`
`24`	`24`
	`25`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`25`	`26`	`internal void ThrowTerminatingError(ErrorRecord errorRecord)`
`26`	`27`	`{`
`27`	`28`	`_command.ThrowTerminatingError(errorRecord);`
Original file line number	Diff line number	Diff line change
`@@ -230,6 +230,7 @@ public PSTransactionContext CurrentPSTransaction`
`230`	`230`	`/// if it exists, otherwise throw an invalid operation exception.`
`231`	`231`	`/// </summary>`
`232`	`232`	`/// <param name="errorRecord">The error record to throw.</param>`
	`233`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`233`	`234`	`public void ThrowTerminatingError(ErrorRecord errorRecord)`
`234`	`235`	`{`
`235`	`236`	`if (errorRecord.Exception != null)`
Original file line number	Diff line number	Diff line change
`@@ -2055,6 +2055,7 @@ public PSTransactionContext CurrentPSTransaction`
`2055`	`2055`	`/// <see cref="System.Management.Automation.Cmdlet.ProcessRecord"/>.`
`2056`	`2056`	`/// etc.`
`2057`	`2057`	`/// </remarks>`
	`2058`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`2058`	`2059`	`public void ThrowTerminatingError(ErrorRecord errorRecord)`
`2059`	`2060`	`{`
`2060`	`2061`	`ThrowIfStopping();`
Original file line number	Diff line number	Diff line change
`@@ -1714,6 +1714,7 @@ public PSTransactionContext CurrentPSTransaction`
`1714`	`1714`	`/// <see cref="System.Management.Automation.Cmdlet.ProcessRecord"/>.`
`1715`	`1715`	`/// etc.`
`1716`	`1716`	`/// </remarks>`
	`1717`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`1717`	`1718`	`public void ThrowTerminatingError(ErrorRecord errorRecord)`
`1718`	`1719`	`{`
`1719`	`1720`	`using (PSTransactionManager.GetEngineProtectionScope())`
Original file line number	Diff line number	Diff line change
`@@ -1417,6 +1417,7 @@ public virtual string GetResourceString(string baseName, string resourceId)`
`1417`	`1417`
`1418`	`1418`	`#region ThrowTerminatingError`
`1419`	`1419`	`/// <Content contentref="System.Management.Automation.Cmdlet.ThrowTerminatingError" />`
	`1420`	`+ [System.Diagnostics.CodeAnalysis.DoesNotReturn]`
`1420`	`1421`	`public void ThrowTerminatingError(ErrorRecord errorRecord)`
`1421`	`1422`	`{`
`1422`	`1423`	`using (PSTransactionManager.GetEngineProtectionScope())`