Change term "Dampening" to "Port Link Flap Error Disable" to bas as s…

…ame as other vendors link Cisco

system/intf-dampening-HLD.md

@@ -1,5 +1,5 @@
 # Feature Name
-Interface Dampening
+Port Link Flap Error Disable
 # High Level Design Document
 #### Rev 0.1
 
@@ -14,14 +14,15 @@ Interface Dampening
 [Table 1: Abbreviations](#table-1-abbreviations)
 
 # Revision
-| Rev |     Date    |       Author       | Change Description                |
-|:---:|:-----------:|:------------------:|-----------------------------------|
-| 0.1 | 04/14/2021  |   Steven Lu        | Initial version for requirements  |
+| Rev |     Date    |       Author       | Change Description                                   |
+|:---:|:-----------:|:------------------:|------------------------------------------------------|
+| 0.1 | 04/14/2021  |   Steven Lu        | Initial version for requirements                     |
+| 0.2 | 04/20/2021  |   Steven Lu        | Change feature name to Port Link Flap Error Disable  |
 
 # About this Manual
-This document provides general information about the Interface Dampening feature implementation in SONiC.
+This document provides general information about the Port Link Flap Error Disable feature implementation in SONiC.
 # Scope
-This document describes the high level design of Interface Dampening feature. Call out any related design that is not covered by this document
+This document describes the high level design of Port Link Flap Error Disable feature. Call out any related design that is not covered by this document
 
 # Definition/Abbreviation
 
@@ -31,9 +32,9 @@ This document describes the high level design of Interface Dampening feature. Ca
 | XYZ                      | Term description                    |
 
 # 1 Feature Overview
-The interface dampening feature uses an exponential decay mechanism to prevent excessive interface flapping events from adversely affecting routing protocols and routing tables in the network. Suppressing interface state change events to protect the system resources.
+The Port Link Flap Error Disable feature uses an exponential decay mechanism to prevent excessive interface flapping events from adversely affecting routing protocols and routing tables in the network. Suppressing port state change events to protect the system resources.
 
-When dampening is enabled, the system monitors the number of times a port link state toggles from "up to down", and not from "down to up".
+When Port Link Flap Error Disable is enabled, the system monitors the number of times a port link state toggles from "up to down", and not from "down to up".
 
 The sampling time or window (the time during which the specified toggle threshold can occur before the wait period is activated) is triggered when the first "up to down" transition occurs.
 
@@ -51,7 +52,7 @@ User shall be able to save configuration parameters (both global and per-interfa
 The configuration parameters (both global and per-interface) must be preserved across device reboot.
 
 ### 1.1.1 Functional Requirements
-Dampening shall use below parameters to supress and protect system.
+Port Link Flap Error Disable shall use below parameters to supress and protect system.
 - toggle-frequency
 Specifies the number of times a port link state goes from up to down before the wait period is activated. The value ranges from 1 through 50.
 - sample-interval
@@ -60,22 +61,22 @@ Specifies the amount of time, in seconds, during which the specified toggle thre
 Specifies the amount of time in seconds, for which the port remains disabled (down) before it becomes enabled. The value ranges from 0 through 65535. A value of 0 indicates that the port will stay down until an administrative override occurs.
 
 ### 1.1.2 Configuration and Management Requirements
-- Interface Dampening feature default is OFF on all physical interfaces and port-channels
-- When Dampening is enabled, use below default values:
+- Port Link Flap Error Disable feature default is OFF on all physical interfaces and port-channels
+- When Port Link Flap Error Disable is enabled, use below default values:
   sample-interval: TBD
   toggle-frequency: TBD
   waiting-period: TBD
 - User shall be able to specify different sample-interval, toggle-frequency and waiting-period on a physical interface
-- User shall be able to display current interface dampening confiuration values.
-- User shall be able to display current interface status if it was surpresed by Link-Dampening
-- User shall be able to display Link-Down-Reason if a port is disabled by Link-Dampening feature
+- User shall be able to display current Port Link Flap Error Disable confiuration values.
+- User shall be able to display current interface status if it was surpresed by Port Link Flap Error Disable
+- User shall be able to display Link-Down-Reason if a port is disabled by Port Link Flap Error Disable feature
 
 
 ### 1.1.3 Scalability Requirements
-Interface Dampening must be supported on all physcial ports. All the platform design, SDK, and ASIC constraints should be considered.
+Port Link Flap Error Disable must be supported on all physcial ports. All the platform design, SDK, and ASIC constraints should be considered.
 
 
 ### 1.1.4 Warm Boot Requirements
-Interfaces that are configured Dampening must be retained across warmboot.
+Interfaces that are configured Port Link Flap Error Disable must be retained across warmboot.