NetworkPkg/DnsDxe: Fix various typos

Fix various typos in comments and documentation.

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-35-philmd@redhat.com>

diff --git a/NetworkPkg/DnsDxe/DnsDriver.c b/NetworkPkg/DnsDxe/DnsDriver.c
index ad007da8b7d669ac2497662ae09fec86c39e50b1..f099da8a5a9538b3c52a2e898bb20817dbdc3295 100644 (file)
--- a/NetworkPkg/DnsDxe/DnsDriver.c
+++ b/NetworkPkg/DnsDxe/DnsDriver.c
@@ -630,7 +630,7 @@ Dns4DriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -894,7 +894,7 @@ Dns6DriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1057,7 +1057,7 @@ Dns6DriverBindingStop (
                          then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                          then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -1186,7 +1186,7 @@ ON_ERROR:
   @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param[in] ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
@@ -1300,7 +1300,7 @@ Dns4ServiceBindingDestroyChild (
                          then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                          then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -1429,7 +1429,7 @@ ON_ERROR:
   @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param[in] ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r

diff --git a/NetworkPkg/DnsDxe/DnsDriver.h b/NetworkPkg/DnsDxe/DnsDriver.h
index 471b1134ddb34ca28599194b8f7731a604631c49..67365ca81a1b268e374debc64082dd996e15ce0a 100644 (file)
--- a/NetworkPkg/DnsDxe/DnsDriver.h
+++ b/NetworkPkg/DnsDxe/DnsDriver.h
@@ -318,7 +318,7 @@ Dns4DriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -446,7 +446,7 @@ Dns6DriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -504,7 +504,7 @@ Dns6DriverBindingStop (
                          then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                          then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -528,7 +528,7 @@ Dns4ServiceBindingCreateChild (
   @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param[in] ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
@@ -555,7 +555,7 @@ Dns4ServiceBindingDestroyChild (
                          then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                          then the protocol is added to the existing UEFI handle.\r
 \r
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                 the child\r
@@ -579,7 +579,7 @@ Dns6ServiceBindingCreateChild (
   @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param[in] ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
   @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r

diff --git a/NetworkPkg/DnsDxe/DnsImpl.c b/NetworkPkg/DnsDxe/DnsImpl.c
index 4c232740be3f2467c015fd2f1502e537b0131ed4..25628a5704f0c2cfb3e24ceb124727ca90ebe1c4 100644 (file)
--- a/NetworkPkg/DnsDxe/DnsImpl.c
+++ b/NetworkPkg/DnsDxe/DnsImpl.c
@@ -14,7 +14,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
   @param[in] TokenMap          All DNSv4 Token entrys.\r
   @param[in] TokenEntry        TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND        TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -49,7 +49,7 @@ Dns4RemoveTokenEntry (
   @param[in] TokenMap           All DNSv6 Token entrys.\r
   @param[in] TokenEntry         TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND         TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -79,7 +79,7 @@ Dns6RemoveTokenEntry (
 }\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -139,7 +139,7 @@ Dns4CancelTokens (
 }\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -205,7 +205,7 @@ Dns6CancelTokens (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -241,7 +241,7 @@ GetDns4TokenEntry (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -530,7 +530,7 @@ DnsDummyExtFree (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   The default address is retrieved and UDP is reconfigured.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -582,7 +582,7 @@ Dns4GetMapping (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   Configure the Udp6 instance successfully.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -2101,7 +2101,7 @@ DnsOnTimerRetransmit (
         }\r
 \r
         //\r
-        // Retransmit the packet if haven't reach the maxmium retry count,\r
+        // Retransmit the packet if haven't reach the maximum retry count,\r
         // otherwise exit the transfer.\r
         //\r
         if (++Dns4TokenEntry->RetryCounting <= Dns4TokenEntry->Token->RetryCount) {\r
@@ -2145,7 +2145,7 @@ DnsOnTimerRetransmit (
         }\r
 \r
         //\r
-        // Retransmit the packet if haven't reach the maxmium retry count,\r
+        // Retransmit the packet if haven't reach the maximum retry count,\r
         // otherwise exit the transfer.\r
         //\r
         if (++Dns6TokenEntry->RetryCounting <= Dns6TokenEntry->Token->RetryCount) {\r

diff --git a/NetworkPkg/DnsDxe/DnsImpl.h b/NetworkPkg/DnsDxe/DnsImpl.h
index fdab9c75e3f385624a33fa74b0bb71e6f851fd5d..10bc399e9ed5232c0fae24a12d5b6b6eb9481f2a 100644 (file)
--- a/NetworkPkg/DnsDxe/DnsImpl.h
+++ b/NetworkPkg/DnsDxe/DnsImpl.h
@@ -182,7 +182,7 @@ typedef struct {
   @param[in] TokenMap          All DNSv4 Token entrys.\r
   @param[in] TokenEntry        TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND        TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -198,7 +198,7 @@ Dns4RemoveTokenEntry (
   @param[in] TokenMap           All DNSv6 Token entrys.\r
   @param[in] TokenEntry         TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND         TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -209,7 +209,7 @@ Dns6RemoveTokenEntry (
   );\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -233,7 +233,7 @@ Dns4CancelTokens (
   );\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -263,7 +263,7 @@ Dns6CancelTokens (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -282,7 +282,7 @@ GetDns4TokenEntry (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -410,7 +410,7 @@ DnsDummyExtFree (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   The default address is retrieved and UDP is reconfigured.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -429,7 +429,7 @@ Dns4GetMapping (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   Configure the Udp6 instance successfully.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -743,7 +743,7 @@ Dns4GetModeData (
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
-  @retval EFI_INVALID_PARAMTER    Thisis NULL.\r
+  @retval EFI_INVALID_PARAMETER   This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not a\r
                                   valid unicast.\r
                                   DnsServerList is NULL while DnsServerListCount\r
@@ -869,9 +869,9 @@ Dns4GeneralLookUp (
 \r
   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the\r
-                                  DNS Cahce. If TRUE, this function will delete\r
+                                  DNS Cache. If TRUE, this function will delete\r
                                   matching DNS Cache entry.\r
-  @param[in]  Override            If TRUE, the maching DNS cache entry will be\r
+  @param[in]  Override            If TRUE, the matching DNS cache entry will be\r
                                   overwritten with the supplied parameter. If FALSE,\r
                                   EFI_ACCESS_DENIED will be returned if the entry to\r
                                   be added is already existed.\r
@@ -989,7 +989,7 @@ Dns6GetModeData (
                                   storage to be allocated and released by caller.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
-  @retval EFI_INVALID_PARAMTER    This is NULL.\r
+  @retval EFI_INVALID_PARAMETER    This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r
                                   DnsServerList is NULL while DnsServerList Count is not ZERO.\r
                                   DnsServerList Count is ZERO while DnsServerList is not NULL.\r
@@ -1117,9 +1117,9 @@ Dns6GeneralLookUp (
 \r
   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.\r
   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the\r
-                                  DNS Cahce. If TRUE, this function will delete\r
+                                  DNS Cache. If TRUE, this function will delete\r
                                   matching DNS Cache entry.\r
-  @param[in]  Override            If TRUE, the maching DNS cache entry will be\r
+  @param[in]  Override            If TRUE, the matching DNS cache entry will be\r
                                   overwritten with the supplied parameter. If FALSE,\r
                                   EFI_ACCESS_DENIED will be returned if the entry to\r
                                   be added is already existed.\r

diff --git a/NetworkPkg/DnsDxe/DnsProtocol.c b/NetworkPkg/DnsDxe/DnsProtocol.c
index 9b98e90ddf1e09cd3e8321c36d1bc8423f7a92c8..4acc5fca46cf30ed7c2660fd474083d89eb9eb20 100644 (file)
--- a/NetworkPkg/DnsDxe/DnsProtocol.c
+++ b/NetworkPkg/DnsDxe/DnsProtocol.c
@@ -158,7 +158,7 @@ ON_EXIT:
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
-  @retval EFI_INVALID_PARAMTER    Thisis NULL.\r
+  @retval EFI_INVALID_PARAMETER   This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not a\r
                                   valid unicast.\r
                                   DnsServerList is NULL while DnsServerListCount\r
@@ -721,9 +721,9 @@ ON_EXIT:
 \r
   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the\r
-                                  DNS Cahce. If TRUE, this function will delete\r
+                                  DNS Cache. If TRUE, this function will delete\r
                                   matching DNS Cache entry.\r
-  @param[in]  Override            If TRUE, the maching DNS cache entry will be\r
+  @param[in]  Override            If TRUE, the matching DNS cache entry will be\r
                                   overwritten with the supplied parameter. If FALSE,\r
                                   EFI_ACCESS_DENIED will be returned if the entry to\r
                                   be added is already existed.\r
@@ -864,7 +864,7 @@ Dns4Cancel (
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
-  // Cancle the tokens specified by Token for this instance.\r
+  // Cancel the tokens specified by Token for this instance.\r
   //\r
   Status = Dns4InstanceCancelToken (Instance, Token);\r
 \r
@@ -1007,7 +1007,7 @@ ON_EXIT:
                                   storage to be allocated and released by caller.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
-  @retval EFI_INVALID_PARAMTER    This is NULL.\r
+  @retval EFI_INVALID_PARAMETER    This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r
                                   DnsServerList is NULL while DnsServerList Count is not ZERO.\r
                                   DnsServerList Count is ZERO while DnsServerList is not NULL.\r
@@ -1566,9 +1566,9 @@ ON_EXIT:
 \r
   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.\r
   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the\r
-                                  DNS Cahce. If TRUE, this function will delete\r
+                                  DNS Cache. If TRUE, this function will delete\r
                                   matching DNS Cache entry.\r
-  @param[in]  Override            If TRUE, the maching DNS cache entry will be\r
+  @param[in]  Override            If TRUE, the matching DNS cache entry will be\r
                                   overwritten with the supplied parameter. If FALSE,\r
                                   EFI_ACCESS_DENIED will be returned if the entry to\r
                                   be added is already existed.\r
@@ -1713,7 +1713,7 @@ Dns6Cancel (
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
-  // Cancle the tokens specified by Token for this instance.\r
+  // Cancel the tokens specified by Token for this instance.\r
   //\r
   Status = Dns6InstanceCancelToken (Instance, Token);\r
 \r