Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
  • Loading branch information
Robo210 and gewarren committed Jun 6, 2024
1 parent e6f87e6 commit fbddb03
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion xml/System.Diagnostics/EventLog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2583,7 +2583,7 @@ SVC_UPDATE.EXE
Set the `action` parameter to <xref:System.Diagnostics.OverflowAction.DoNotOverwrite> to discard new events when the maximum log size is reached. If the `action` parameter is set to <xref:System.Diagnostics.OverflowAction.DoNotOverwrite>, the `retentionDays` parameter value is ignored.
> [!WARNING]
> Never set the `action` parameter to <xref:System.Diagnostics.OverflowAction.OverwriteOlder>. This value is deprecated and may cause the log to behave as if the `DoNotOverwrite` parameter was passed instead.
> Never set the `action` parameter to <xref:System.Diagnostics.OverflowAction.OverwriteOlder>. This value is deprecated and might cause the log to behave as if the `DoNotOverwrite` parameter was passed instead.
> [!CAUTION]
> Setting the overflow policy to <xref:System.Diagnostics.OverflowAction.DoNotOverwrite> specifies that new entries are discarded when the event log is full. If you use this setting, ensure the event log is regularly archived and cleared to avoid reaching its maximum size limit.
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Diagnostics/OverflowAction.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Use the <xref:System.Diagnostics.EventLog.ModifyOverflowPolicy%2A> method to set the overflow behavior for an <xref:System.Diagnostics.EventLog>. Check the current configured behavior of an <xref:System.Diagnostics.EventLog> through its <xref:System.Diagnostics.EventLog.OverflowAction%2A> property.
> [!WARNING]
> The `OverwriteOlder` behavior is deprecated. Using this value may cause the Event Log to behave as if the `DoNotOverwrite` value was used instead, which will cause events to be discarded when the log is full.
> The `OverwriteOlder` behavior is deprecated. Using this value might cause the Event Log to behave as if the `DoNotOverwrite` value was used instead, which will cause events to be discarded when the log is full.
## Examples
Expand Down Expand Up @@ -146,7 +146,7 @@ The following example enumerates the event logs defined on the local computer an
<remarks>
<format type="text/markdown"><![CDATA[
> [!WARNING]
> Do not use this value. Doing so may cause the Event Log to behave as if the `DoNotOverwrite` value was used instead.
> Do not use this value. Doing so might cause the Event Log to behave as if the `DoNotOverwrite` value was used instead.
]]></format>
</remarks>
Expand Down

0 comments on commit fbddb03

Please sign in to comment.