From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.61]) by mx.groups.io with SMTP id smtpd.web12.6481.1581037774258282092 for ; Thu, 06 Feb 2020 17:09:34 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=fx0e0uwK; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1581037773; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nITy0Wk5271qptBJegqSLu7zJH/pFQAZo2FAhpJNL8g=; b=fx0e0uwK/QsEFx7tfAjDTawpNdtai3Emq9UtCB/Sq/g1COz+jBYiEPqLd2k3QQEx4vP+95 pOq9ioIdeXw1ThzZlYkbVVAihWtRQAfwMBm6dFOoDMai8kLQ7sTkwBkGKpuc/hcE4sslGi pzIN8VewNGQEAGre/ZZRJuStDHQF0Iw= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-432-sPqMaOkwNvOUxURwDn9CCQ-1; Thu, 06 Feb 2020 20:09:31 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 67DF71835A13; Fri, 7 Feb 2020 01:09:30 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-120.brq.redhat.com [10.40.204.120]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 597905C1BB; Fri, 7 Feb 2020 01:09:29 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Laszlo Ersek , Eric Dong Subject: [PATCH v3 34/78] NetworkPkg/DnsDxe: Fix various typos Date: Fri, 7 Feb 2020 02:07:47 +0100 Message-Id: <20200207010831.9046-35-philmd@redhat.com> In-Reply-To: <20200207010831.9046-1-philmd@redhat.com> References: <20200207010831.9046-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-MC-Unique: sPqMaOkwNvOUxURwDn9CCQ-1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Antoine Coeur 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 --- NetworkPkg/DnsDxe/DnsDriver.h | 12 ++++++------ NetworkPkg/DnsDxe/DnsImpl.h | 28 ++++++++++++++-------------- NetworkPkg/DnsDxe/DnsDriver.c | 12 ++++++------ NetworkPkg/DnsDxe/DnsImpl.c | 20 ++++++++++---------- NetworkPkg/DnsDxe/DnsProtocol.c | 16 ++++++++-------- 5 files changed, 44 insertions(+), 44 deletions(-) diff --git a/NetworkPkg/DnsDxe/DnsDriver.h b/NetworkPkg/DnsDxe/DnsDriver.h index 471b1134ddb3..67365ca81a1b 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. =20 **/ 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. =20 **/ 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 h= andle. =20 - @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 t= o create the child @@ -528,7 +528,7 @@ Dns4ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL insta= nce. @param[in] ChildHandle Handle of the child to destroy =20 - @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 h= andle. =20 - @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 t= o create the child @@ -579,7 +579,7 @@ Dns6ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL insta= nce. @param[in] ChildHandle Handle of the child to destroy =20 - @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.h b/NetworkPkg/DnsDxe/DnsImpl.h index fdab9c75e3f3..10bc399e9ed5 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. =20 - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully= . + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfull= y. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -198,7 +198,7 @@ Dns4RemoveTokenEntry ( @param[in] TokenMap All DNSv6 Token entrys. @param[in] TokenEntry TokenEntry need to be removed. =20 - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfull= y. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successful= ly. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -209,7 +209,7 @@ Dns6RemoveTokenEntry ( ); =20 /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. =20 @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -233,7 +233,7 @@ Dns4CancelTokens ( ); =20 /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. =20 @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 Toke= n. =20 - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= cessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= ccessfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -282,7 +282,7 @@ GetDns4TokenEntry ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Toke= n. =20 - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= cessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= ccessfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -410,7 +410,7 @@ DnsDummyExtFree ( @param UdpCfgData The UDP configure data to reconfigure the= UDP_IO =20 @retval TRUE The default address is retrieved and UDP = is reconfigured. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. =20 **/ BOOLEAN @@ -429,7 +429,7 @@ Dns4GetMapping ( @param UdpCfgData The UDP configure data to reconfigure the= UDP_IO =20 @retval TRUE Configure the Udp6 instance successfully. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. =20 **/ BOOLEAN @@ -743,7 +743,7 @@ Dns4GetModeData ( =20 @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 DnsCon= figData is not a valid unicast. DnsServerList is NULL while DnsServerLis= tCount @@ -869,9 +869,9 @@ Dns4GeneralLookUp ( =20 @param[in] This Pointer to EFI_DNS4_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one en= try to the - DNS Cahce. If TRUE, this function will d= elete + DNS Cache. If TRUE, this function will d= elete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry wil= l be + @param[in] Override If TRUE, the matching DNS cache entry wi= ll be overwritten with the supplied parameter.= If FALSE, EFI_ACCESS_DENIED will be returned if th= e entry to be added is already existed. @@ -989,7 +989,7 @@ Dns6GetModeData ( storage to be allocated and released by = caller. =20 @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 DnsCon= figData is not zero and not a valid unicast. DnsServerList is NULL while DnsServerLis= t Count is not ZERO. DnsServerList Count is ZERO while DnsSer= verList is not NULL. @@ -1117,9 +1117,9 @@ Dns6GeneralLookUp ( =20 @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one en= try to the - DNS Cahce. If TRUE, this function will d= elete + DNS Cache. If TRUE, this function will d= elete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry wil= l be + @param[in] Override If TRUE, the matching DNS cache entry wi= ll be overwritten with the supplied parameter.= If FALSE, EFI_ACCESS_DENIED will be returned if th= e entry to be added is already existed. diff --git a/NetworkPkg/DnsDxe/DnsDriver.c b/NetworkPkg/DnsDxe/DnsDriver.c index ad007da8b7d6..f099da8a5a95 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. =20 **/ 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. =20 **/ 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 h= andle. =20 - @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 t= o create the child @@ -1186,7 +1186,7 @@ Dns4ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL insta= nce. @param[in] ChildHandle Handle of the child to destroy =20 - @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 h= andle. =20 - @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 t= o create the child @@ -1429,7 +1429,7 @@ Dns6ServiceBindingCreateChild ( @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL insta= nce. @param[in] ChildHandle Handle of the child to destroy =20 - @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 4c232740be3f..25628a5704f0 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. =20 - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully= . + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successfull= y. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -49,7 +49,7 @@ Dns4RemoveTokenEntry ( @param[in] TokenMap All DNSv6 Token entrys. @param[in] TokenEntry TokenEntry need to be removed. =20 - @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfull= y. + @retval EFI_SUCCESS Remove TokenEntry from TokenMap successful= ly. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -79,7 +79,7 @@ Dns6RemoveTokenEntry ( } =20 /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. =20 @param[in] Map Pointer to the NET_MAP. @param[in] Item Pointer to the NET_MAP_ITEM. @@ -139,7 +139,7 @@ Dns4CancelTokens ( } =20 /** - This function cancle the token specified by Arg in the Map. + This function cancel the token specified by Arg in the Map. =20 @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 Toke= n. =20 - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= cessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= ccessfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -241,7 +241,7 @@ GetDns4TokenEntry ( @param[in] Token Pointer to the token to be get. @param[out] TokenEntry Pointer to TokenEntry corresponding Toke= n. =20 - @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= cessfully. + @retval EFI_SUCCESS Get the TokenEntry from the TokensMap su= ccessfully. @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap. =20 **/ @@ -530,7 +530,7 @@ DnsDummyExtFree ( @param UdpCfgData The UDP configure data to reconfigure the= UDP_IO =20 @retval TRUE The default address is retrieved and UDP = is reconfigured. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. =20 **/ BOOLEAN @@ -582,7 +582,7 @@ Dns4GetMapping ( @param UdpCfgData The UDP configure data to reconfigure the= UDP_IO =20 @retval TRUE Configure the Udp6 instance successfully. - @retval FALSE Some error occured. + @retval FALSE Some error occurred. =20 **/ BOOLEAN @@ -2101,7 +2101,7 @@ DnsOnTimerRetransmit ( } =20 // - // 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 <=3D Dns4TokenEntry->Token->Re= tryCount) { @@ -2145,7 +2145,7 @@ DnsOnTimerRetransmit ( } =20 // - // 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 <=3D Dns6TokenEntry->Token->Re= tryCount) { diff --git a/NetworkPkg/DnsDxe/DnsProtocol.c b/NetworkPkg/DnsDxe/DnsProtoco= l.c index 9b98e90ddf1e..4acc5fca46cf 100644 --- a/NetworkPkg/DnsDxe/DnsProtocol.c +++ b/NetworkPkg/DnsDxe/DnsProtocol.c @@ -158,7 +158,7 @@ Dns4GetModeData ( =20 @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 DnsCon= figData is not a valid unicast. DnsServerList is NULL while DnsServerLis= tCount @@ -721,9 +721,9 @@ Dns4GeneralLookUp ( =20 @param[in] This Pointer to EFI_DNS4_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one en= try to the - DNS Cahce. If TRUE, this function will d= elete + DNS Cache. If TRUE, this function will d= elete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry wil= l be + @param[in] Override If TRUE, the matching DNS cache entry wi= ll be overwritten with the supplied parameter.= If FALSE, EFI_ACCESS_DENIED will be returned if th= e entry to be added is already existed. @@ -864,7 +864,7 @@ Dns4Cancel ( OldTpl =3D gBS->RaiseTPL (TPL_CALLBACK); =20 // - // Cancle the tokens specified by Token for this instance. + // Cancel the tokens specified by Token for this instance. // Status =3D Dns4InstanceCancelToken (Instance, Token); =20 @@ -1007,7 +1007,7 @@ Dns6GetModeData ( storage to be allocated and released by = caller. =20 @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 DnsCon= figData is not zero and not a valid unicast. DnsServerList is NULL while DnsServerLis= t Count is not ZERO. DnsServerList Count is ZERO while DnsSer= verList is not NULL. @@ -1566,9 +1566,9 @@ Dns6GeneralLookUp ( =20 @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. @param[in] DeleteFlag If FALSE, this function is to add one en= try to the - DNS Cahce. If TRUE, this function will d= elete + DNS Cache. If TRUE, this function will d= elete matching DNS Cache entry. - @param[in] Override If TRUE, the maching DNS cache entry wil= l be + @param[in] Override If TRUE, the matching DNS cache entry wi= ll be overwritten with the supplied parameter.= If FALSE, EFI_ACCESS_DENIED will be returned if th= e entry to be added is already existed. @@ -1713,7 +1713,7 @@ Dns6Cancel ( OldTpl =3D gBS->RaiseTPL (TPL_CALLBACK); =20 // - // Cancle the tokens specified by Token for this instance. + // Cancel the tokens specified by Token for this instance. // Status =3D Dns6InstanceCancelToken (Instance, Token); =20 --=20 2.21.1