Fix spelling and aspell check (#497)

* Fix spelling and aspell check * Add aspell skip info when not present * Fix aspell info log * Address comments
opencomputeproject · Apr 7, 2017 · bf3d5a7 · bf3d5a7
1 parent e3146a5
commit bf3d5a7
Show file tree

Hide file tree

Showing 42 changed files with 409 additions and 306 deletions.
diff --git a/inc/sai.h b/inc/sai.h
@@ -8,7 +8,7 @@
  *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
  *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
  *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
- *    FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
  *
  *    See the Apache Version 2.0 License for specific language governing
  *    permissions and limitations under the License.
@@ -19,7 +19,7 @@
  *
  * @file    sai.h
  *
- * @brief   This module defines an entry point into Switch Abstraction Interfrace (SAI)
+ * @brief   This module defines an entry point into Switch Abstraction Interface (SAI)
  */
 
 #if !defined (__SAI_H_)
@@ -71,13 +71,13 @@
 /**
  * @brief Defined API sets have assigned ID's.
  *
- * If specific api method table changes in any way (method signature, number of
+ * If specific API method table changes in any way (method signature, number of
  * methods), a new ID needs to be created (e.g. VLAN2) and old API still may
  * need to be supported for compatibility with older adapter hosts.
  */
 typedef enum _sai_api_t
 {
-    SAI_API_UNSPECIFIED      =  0, /**< unspecified api */
+    SAI_API_UNSPECIFIED      =  0, /**< unspecified API */
     SAI_API_SWITCH           =  1, /**< sai_switch_api_t */
     SAI_API_PORT             =  2, /**< sai_port_api_t */
     SAI_API_FDB              =  3, /**< sai_fdb_api_t */
@@ -128,7 +128,7 @@ typedef enum _sai_log_level_t
     /** Log Level Notice */
     SAI_LOG_LEVEL_NOTICE           = 2,
 
-    /** Log level Warnng */
+    /** Log level Warning */
     SAI_LOG_LEVEL_WARN             = 3,
 
     /** Log Level Error */
@@ -185,7 +185,7 @@ sai_status_t sai_api_initialize(
  * @brief Retrieve a pointer to the C-style method table for desired SAI
  * functionality as specified by the given sai_api_id.
  *
- * @param[in] sai_api_id SAI api ID
+ * @param[in] sai_api_id SAI API ID
  * @param[out] api_method_table Caller allocated method table The table must
  * remain valid until the sai_api_uninitialize() is called
  *
@@ -196,17 +196,17 @@ sai_status_t sai_api_query(
         _Out_ void** api_method_table);
 
 /**
- * @brief Uninitialization of the adapter module. SAI functionalities,
+ * @brief Uninitialize adapter module. SAI functionalities,
  * retrieved via sai_api_query() cannot be used after this call.
  *
  * @return #SAI_STATUS_SUCCESS on success Failure status code on error
  */
 sai_status_t sai_api_uninitialize(void);
 
 /**
- * @brief Set log level for SAI api module. The default log level is #SAI_LOG_LEVEL_WARN
+ * @brief Set log level for SAI API module. The default log level is #SAI_LOG_LEVEL_WARN
  *
- * @param[in] sai_api_id SAI api ID
+ * @param[in] sai_api_id SAI API ID
  * @param[in] log_level Log level
  *
  * @return #SAI_STATUS_SUCCESS on success Failure status code on error
@@ -234,7 +234,7 @@ sai_object_type_t sai_object_type_query(
  * @return #SAI_NULL_OBJECT_ID when sai_object_id is not valid.
  * Otherwise, return a valid SAI_OBJECT_TYPE_SWITCH object on which
  * provided object id belongs. If valid switch id object is provided
- * as input parameter it should returin itself.
+ * as input parameter it should return itself.
  */
 sai_object_id_t sai_switch_id_query(
         _In_ sai_object_id_t sai_object_id);

diff --git a/inc/saiacl.h b/inc/saiacl.h
@@ -8,7 +8,7 @@
  *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
  *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
  *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
- *    FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
  *
  *    See the Apache Version 2.0 License for specific language governing
  *    permissions and limitations under the License.
@@ -153,7 +153,7 @@ typedef enum _sai_acl_action_type_t
     /** Egress Mirror */
     SAI_ACL_ACTION_TYPE_MIRROR_EGRESS,
 
-    /** Assosiate with policer (policer id) */
+    /** Associate with policer (policer id) */
     SAI_ACL_ACTION_TYPE_SET_POLICER,
 
     /** Decrement TTL */
@@ -165,16 +165,16 @@ typedef enum _sai_acl_action_type_t
     /** Set Packet Color */
     SAI_ACL_ACTION_TYPE_SET_PACKET_COLOR,
 
-    /** Set Packet Inner Vlan-Id */
+    /** Set Packet Inner Vlan Id */
     SAI_ACL_ACTION_TYPE_SET_INNER_VLAN_ID,
 
-    /** Set Packet Inner Vlan-Priority */
+    /** Set Packet Inner Vlan Priority */
     SAI_ACL_ACTION_TYPE_SET_INNER_VLAN_PRI,
 
-    /** Set Packet Outer Vlan-Id */
+    /** Set Packet Outer Vlan Id */
     SAI_ACL_ACTION_TYPE_SET_OUTER_VLAN_ID,
 
-    /** Set Packet Outer Vlan-Priority */
+    /** Set Packet Outer Vlan Priority */
     SAI_ACL_ACTION_TYPE_SET_OUTER_VLAN_PRI,
 
     /** Set Packet Src MAC Address */
@@ -225,7 +225,7 @@ typedef enum _sai_acl_action_type_t
     /** Set user defined trap id */
     SAI_ACL_ACTION_TYPE_SET_USER_TRAP_ID,
 
-    /** Set Do Not Learn unknow source MAC */
+    /** Set Do Not Learn unknown source MAC */
     SAI_ACL_ACTION_TYPE_SET_DO_NOT_LEARN,
 
 } sai_acl_action_type_t;
@@ -266,7 +266,7 @@ typedef enum _sai_acl_table_group_attr_t
      *
      * ACL group bind point list - is a create only attribute required for ACL
      * groups to let the user specify his intention to allow further error
-     * checks and optimizations based on a specific ASIC's SAI implementation.
+     * checks and optimizations based on a specific ASIC SAI implementation.
      * ACL members being added to this group SHOULD be a subset of the bind
      * point list that ACL group was created with.
      *
@@ -326,9 +326,9 @@ typedef enum _sai_acl_table_group_member_attr_t
      * @brief ACL table group id
      *
      * This attribute is required to associate or attach a member object (acl_table_id)
-     * to a ACL table group id allocated by the create ACL group api.
+     * to a ACL table group id allocated by the create ACL group API.
      *
-     * User should always use the group id returned by SAI create_acl_group api,
+     * User should always use the group id returned by SAI create_acl_group API,
      * to group the tables else Invalid attribute value error code will be returned.
      *
      * The ACL Table lookup could be done serially or in parallel. In both the
@@ -417,7 +417,7 @@ typedef enum _sai_acl_table_attr_t
      * @brief Table size
      *
      * (default = 0) - Grow dynamically till MAX ACL TCAM Size
-     * By default table can grow upto maximum ACL TCAM space.
+     * By default table can grow up to maximum ACL TCAM space.
      * Supported only during Table Create for now until NPU
      * supports Dynamic adjustment of Table size post Table creation
      *
@@ -604,7 +604,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_SRC_PORT,
 
     /**
-     * @brief Outer Vlan-Id
+     * @brief Outer Vlan Id
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -613,7 +613,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_OUTER_VLAN_ID,
 
     /**
-     * @brief Outer Vlan-Priority
+     * @brief Outer Vlan Priority
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -622,7 +622,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_OUTER_VLAN_PRI,
 
     /**
-     * @brief Outer Vlan-CFI
+     * @brief Outer Vlan CFI
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -631,7 +631,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_OUTER_VLAN_CFI,
 
     /**
-     * @brief Inner Vlan-Id
+     * @brief Inner Vlan Id
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -640,7 +640,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_INNER_VLAN_ID,
 
     /**
-     * @brief Inner Vlan-Priority
+     * @brief Inner Vlan Priority
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -649,7 +649,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_INNER_VLAN_PRI,
 
     /**
-     * @brief Inner Vlan-CFI
+     * @brief Inner Vlan CFI
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -1003,8 +1003,8 @@ typedef enum _sai_acl_entry_attr_t
     /*
      * Match fields [sai_acl_field_data_t]
      * - Mandatory to pass at least one field during ACL Rule creation.
-     * - Unless noted specificially, both data and mask are required.
-     * - When bit field is used, only those least significent bits are valid for
+     * - Unless noted specifically, both data and mask are required.
+     * - When bit field is used, only those least significant bits are valid for
      * matching.
      */
 
@@ -1140,7 +1140,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_FIELD_SRC_PORT,
 
     /**
-     * @brief Outer Vlan-Id (12 bits)
+     * @brief Outer Vlan Id (12 bits)
      *
      * @type sai_acl_field_data_t sai_uint16_t
      * @flags CREATE_AND_SET
@@ -1149,23 +1149,23 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_FIELD_OUTER_VLAN_ID,
 
     /**
-     * @brief Outer Vlan-Priority (3 bits)
+     * @brief Outer Vlan Priority (3 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_OUTER_VLAN_PRI,
 
     /**
-     * @brief Outer Vlan-CFI (1 bit)
+     * @brief Outer Vlan CFI (1 bit)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_OUTER_VLAN_CFI,
 
     /**
-     * @brief Inner Vlan-Id (12 bits)
+     * @brief Inner Vlan Id (12 bits)
      *
      * @type sai_acl_field_data_t sai_uint16_t
      * @flags CREATE_AND_SET
@@ -1174,15 +1174,15 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_FIELD_INNER_VLAN_ID,
 
     /**
-     * @brief Inner Vlan-Priority (3 bits)
+     * @brief Inner Vlan Priority (3 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_INNER_VLAN_PRI,
 
     /**
-     * @brief Inner Vlan-CFI (1 bit)
+     * @brief Inner Vlan CFI (1 bit)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
@@ -1398,7 +1398,7 @@ typedef enum _sai_acl_entry_attr_t
      * @brief Meta Data carried from previous ACL Stage.
      *
      * When an ACL entry set the meta data, the ACL meta data
-     * form previous stages are overriden.
+     * form previous stages are overridden.
      * Value must be in the range defined in
      * #SAI_SWITCH_ATTR_ACL_USER_META_DATA_RANGE
      *
@@ -1547,7 +1547,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_MIRROR_EGRESS,
 
     /**
-     * @brief Assosiate with policer (policer id)
+     * @brief Associate with policer (policer id)
      *
      * @type sai_acl_action_data_t sai_object_id_t
      * @flags CREATE_AND_SET
@@ -1580,23 +1580,23 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_SET_PACKET_COLOR,
 
     /**
-     * @brief Set Packet Inner Vlan-Id (12 bits)
+     * @brief Set Packet Inner Vlan Id (12 bits)
      *
      * @type sai_acl_action_data_t sai_uint32_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_ACTION_SET_INNER_VLAN_ID,
 
     /**
-     * @brief Set Packet Inner Vlan-Priority (3 bits)
+     * @brief Set Packet Inner Vlan Priority (3 bits)
      *
      * @type sai_acl_action_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_ACTION_SET_INNER_VLAN_PRI,
 
     /**
-     * @brief Set Packet Outer Vlan-Id (12 bits)
+     * @brief Set Packet Outer Vlan Id (12 bits)
      *
      * @type sai_acl_action_data_t sai_uint16_t
      * @flags CREATE_AND_SET
@@ -1605,7 +1605,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_SET_OUTER_VLAN_ID,
 
     /**
-     * @brief Set Packet Outer Vlan-Priority (3 bits)
+     * @brief Set Packet Outer Vlan Priority (3 bits)
      *
      * @type sai_acl_action_data_t sai_uint8_t
      * @flags CREATE_AND_SET
@@ -1695,7 +1695,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_SET_L4_DST_PORT,
 
     /**
-     * @brief Set ingress packet sampling (samplepacket session id)
+     * @brief Set ingress packet sampling (sample packet session id)
      *
      * @type sai_acl_action_data_t sai_object_id_t
      * @flags CREATE_AND_SET
@@ -1704,7 +1704,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_INGRESS_SAMPLEPACKET_ENABLE,
 
     /**
-     * @brief Set egress packet sampling (samplepacket session id)
+     * @brief Set egress packet sampling (sample packet session id)
      *
      * @type sai_acl_action_data_t sai_object_id_t
      * @flags CREATE_AND_SET
@@ -1760,7 +1760,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_ACTION_SET_USER_TRAP_ID,
 
     /**
-     * @brief Do Not Learn unknown source MAC on match(enable/disbale) (parameter is not needed)
+     * @brief Do Not Learn unknown source MAC on match(enable/disable) (parameter is not needed)
      *
      * @type sai_acl_action_data_t sai_uint32_t
      * @flags CREATE_AND_SET

diff --git a/inc/saibridge.h b/inc/saibridge.h
@@ -8,7 +8,7 @@
  *    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
  *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
  *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
- *    FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+ *    FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
  *
  *    See the Apache Version 2.0 License for specific language governing
  *    permissions and limitations under the License.
@@ -126,7 +126,7 @@ typedef enum _sai_bridge_port_attr_t
     SAI_BRIDGE_PORT_ATTR_VLAN_ID,
 
     /**
-     * @brief Associated router inerface object id
+     * @brief Associated router interface object id
      *
      * Please note that for SAI_BRIDGE_PORT_TYPE_1Q_ROUTER,
      * all vlan interfaces are auto bounded for the bridge port.