From 81a46615f5bea7a455f2210e55cebb5a68dc0e13 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:07:47 +0100 Subject: NetworkPkg/DnsDxe: Fix various typos Fix various typos in comments and documentation. Cc: Jiaxin Wu Cc: Siyuan Fu Cc: Maciej Rabeda Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Maciej Rabeda Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-35-philmd@redhat.com> --- NetworkPkg/DnsDxe/DnsDriver.c | 12 ++++++------ NetworkPkg/DnsDxe/DnsDriver.h | 12 ++++++------ NetworkPkg/DnsDxe/DnsImpl.c | 20 ++++++++++---------- NetworkPkg/DnsDxe/DnsImpl.h | 28 ++++++++++++++-------------- NetworkPkg/DnsDxe/DnsProtocol.c | 16 ++++++++-------- 5 files changed, 44 insertions(+), 44 deletions(-) (limited to 'NetworkPkg') diff --git a/NetworkPkg/DnsDxe/DnsDriver.c b/NetworkPkg/DnsDxe/DnsDriver.c index ad007da8b7..f099da8a5a 100644 --- a/NetworkPkg/DnsDxe/DnsDriver.c +++ b/NetworkPkg/DnsDxe/DnsDriver.c @@ -630,7 +630,7 @@ Dns4DriverBindingSupported ( @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval Others The driver failded to start the device. + @retval Others The driver failed to start the device. **/ EFI_STATUS @@ -894,7 +894,7 @@ Dns6DriverBindingSupported ( @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval Others The driver failded to start the device. + @retval Others The driver failed to start the device. **/ EFI_STATUS @@ -1057,7 +1057,7 @@ Dns6DriverBindingStop ( then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. - @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_SUCCESS The protocol was added to ChildHandle. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child @@ -1186,7 +1186,7 @@ ON_ERROR: @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param[in] ChildHandle Handle of the child to destroy - @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_SUCCESS The protocol was removed from ChildHandle. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @@ -1300,7 +1300,7 @@ Dns4ServiceBindingDestroyChild ( then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. - @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_SUCCESS The protocol was added to ChildHandle. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child @@ -1429,7 +1429,7 @@ ON_ERROR: @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param[in] ChildHandle Handle of the child to destroy - @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_SUCCESS The protocol was removed from ChildHandle. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle diff --git a/NetworkPkg/DnsDxe/DnsDriver.h b/NetworkPkg/DnsDxe/DnsDriver.h index 471b1134dd..67365ca81a 100644 --- a/NetworkPkg/DnsDxe/DnsDriver.h +++ b/NetworkPkg/DnsDxe/DnsDriver.h @@ -318,7 +318,7 @@ Dns4DriverBindingSupported ( @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval Others The driver failded to start the device. + @retval Others The driver failed to start the device. **/ EFI_STATUS @@ -446,7 +446,7 @@ Dns6DriverBindingSupported ( @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval Others The driver failded to start the device. + @retval Others The driver failed to start the device. **/ EFI_STATUS @@ -504,7 +504,7 @@ Dns6DriverBindingStop ( then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. - @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_SUCCESS The protocol was added to ChildHandle. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child @@ -528,7 +528,7 @@ Dns4ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param[in] ChildHandle Handle of the child to destroy - @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_SUCCESS The protocol was removed from ChildHandle. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @@ -555,7 +555,7 @@ Dns4ServiceBindingDestroyChild ( then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. - @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_SUCCESS The protocol was added to ChildHandle. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create the child @@ -579,7 +579,7 @@ Dns6ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param[in] ChildHandle Handle of the child to destroy - @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_SUCCESS The protocol was removed from ChildHandle. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle diff --git a/NetworkPkg/DnsDxe/DnsImpl.c b/NetworkPkg/DnsDxe/DnsImpl.c index 4c232740be..25628a5704 100644 --- 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. @param[in] TokenEntry TokenEntry need to be removed. - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -49,7 +49,7 @@ Dns4RemoveTokenEntry ( @param[in] TokenMap All DNSv6 Token entrys. @param[in] TokenEntry TokenEntry need to be removed. - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -79,7 +79,7 @@ Dns6RemoveTokenEntry ( } /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -139,7 +139,7 @@ Dns4CancelTokens ( } /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -205,7 +205,7 @@ Dns6CancelTokens ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Token. - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -241,7 +241,7 @@ GetDns4TokenEntry ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Token. - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -530,7 +530,7 @@ DnsDummyExtFree ( @param UdpCfgData The UDP configure data to reconfigure the UDP_IO @retval TRUE The default address is retrieved and UDP is reconfigured. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. **/ BOOLEAN @@ -582,7 +582,7 @@ Dns4GetMapping ( @param UdpCfgData The UDP configure data to reconfigure the UDP_IO @retval TRUE Configure the Udp6 instance successfully. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. **/ BOOLEAN @@ -2101,7 +2101,7 @@ DnsOnTimerRetransmit ( } // - // Retransmit the packet if haven't reach the maxmium retry count, + // Retransmit the packet if haven't reach the maximum retry count, // otherwise exit the transfer. // if (++Dns4TokenEntry->RetryCounting <= Dns4TokenEntry->Token->RetryCount) { @@ -2145,7 +2145,7 @@ DnsOnTimerRetransmit ( } // - // Retransmit the packet if haven't reach the maxmium retry count, + // Retransmit the packet if haven't reach the maximum retry count, // otherwise exit the transfer. // if (++Dns6TokenEntry->RetryCounting <= Dns6TokenEntry->Token->RetryCount) { diff --git a/NetworkPkg/DnsDxe/DnsImpl.h b/NetworkPkg/DnsDxe/DnsImpl.h index fdab9c75e3..10bc399e9e 100644 --- a/NetworkPkg/DnsDxe/DnsImpl.h +++ b/NetworkPkg/DnsDxe/DnsImpl.h @@ -182,7 +182,7 @@ typedef struct { @param[in] TokenMap All DNSv4 Token entrys. @param[in] TokenEntry TokenEntry need to be removed. - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -198,7 +198,7 @@ Dns4RemoveTokenEntry ( @param[in] TokenMap All DNSv6 Token entrys. @param[in] TokenEntry TokenEntry need to be removed. - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -209,7 +209,7 @@ Dns6RemoveTokenEntry ( ); /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -233,7 +233,7 @@ Dns4CancelTokens ( ); /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -263,7 +263,7 @@ Dns6CancelTokens ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Token. - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -282,7 +282,7 @@ GetDns4TokenEntry ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Token. - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap successfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. **/ @@ -410,7 +410,7 @@ DnsDummyExtFree ( @param UdpCfgData The UDP configure data to reconfigure the UDP_IO @retval TRUE The default address is retrieved and UDP is reconfigured. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. **/ BOOLEAN @@ -429,7 +429,7 @@ Dns4GetMapping ( @param UdpCfgData The UDP configure data to reconfigure the UDP_IO @retval TRUE Configure the Udp6 instance successfully. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. **/ BOOLEAN @@ -743,7 +743,7 @@ Dns4GetModeData ( @retval EFI_SUCCESS The operation completed successfully. @retval EFI_UNSUPPORTED The designated protocol is not supported. - @retval EFI_INVALID_PARAMTER Thisis NULL. + @retval EFI_INVALID_PARAMETER This is NULL. The StationIp address provided in DnsConfigData is not a valid unicast. DnsServerList is NULL while DnsServerListCount @@ -869,9 +869,9 @@ Dns4GeneralLookUp ( @param[in] This Pointer to EFI_DNS4_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one entry to the - DNS Cahce. If TRUE, this function will delete + DNS Cache. If TRUE, this function will delete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry will be + @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already existed. @@ -989,7 +989,7 @@ Dns6GetModeData ( storage to be allocated and released by caller. @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMTER This is NULL. + @retval EFI_INVALID_PARAMETER This is NULL. The StationIp address provided in DnsConfigData is not zero and not a valid unicast. DnsServerList is NULL while DnsServerList Count is not ZERO. DnsServerList Count is ZERO while DnsServerList is not NULL. @@ -1117,9 +1117,9 @@ Dns6GeneralLookUp ( @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one entry to the - DNS Cahce. If TRUE, this function will delete + DNS Cache. If TRUE, this function will delete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry will be + @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already existed. diff --git a/NetworkPkg/DnsDxe/DnsProtocol.c b/NetworkPkg/DnsDxe/DnsProtocol.c index 9b98e90ddf..4acc5fca46 100644 --- a/NetworkPkg/DnsDxe/DnsProtocol.c +++ b/NetworkPkg/DnsDxe/DnsProtocol.c @@ -158,7 +158,7 @@ ON_EXIT: @retval EFI_SUCCESS The operation completed successfully. @retval EFI_UNSUPPORTED The designated protocol is not supported. - @retval EFI_INVALID_PARAMTER Thisis NULL. + @retval EFI_INVALID_PARAMETER This is NULL. The StationIp address provided in DnsConfigData is not a valid unicast. DnsServerList is NULL while DnsServerListCount @@ -721,9 +721,9 @@ ON_EXIT: @param[in] This Pointer to EFI_DNS4_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one entry to the - DNS Cahce. If TRUE, this function will delete + DNS Cache. If TRUE, this function will delete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry will be + @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already existed. @@ -864,7 +864,7 @@ Dns4Cancel ( OldTpl = gBS->RaiseTPL (TPL_CALLBACK); // - // Cancle the tokens specified by Token for this instance. + // Cancel the tokens specified by Token for this instance. // Status = Dns4InstanceCancelToken (Instance, Token); @@ -1007,7 +1007,7 @@ ON_EXIT: storage to be allocated and released by caller. @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMTER This is NULL. + @retval EFI_INVALID_PARAMETER This is NULL. The StationIp address provided in DnsConfigData is not zero and not a valid unicast. DnsServerList is NULL while DnsServerList Count is not ZERO. DnsServerList Count is ZERO while DnsServerList is not NULL. @@ -1566,9 +1566,9 @@ ON_EXIT: @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one entry to the - DNS Cahce. If TRUE, this function will delete + DNS Cache. If TRUE, this function will delete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry will be + @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already existed. @@ -1713,7 +1713,7 @@ Dns6Cancel ( OldTpl = gBS->RaiseTPL (TPL_CALLBACK); // - // Cancle the tokens specified by Token for this instance. + // Cancel the tokens specified by Token for this instance. // Status = Dns6InstanceCancelToken (Instance, Token); -- cgit v1.2.3