]> git.proxmox.com Git - mirror_edk2.git/commitdiff
NetworkPkg/HttpBootDxe: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:07:50 +0000 (02:07 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
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-38-philmd@redhat.com>

NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
NetworkPkg/HttpBootDxe/HttpBootDxe.c
NetworkPkg/HttpBootDxe/HttpBootDxe.h
NetworkPkg/HttpBootDxe/HttpBootImpl.c
NetworkPkg/HttpBootDxe/HttpBootSupport.c
NetworkPkg/HttpBootDxe/HttpBootSupport.h

index b5dd6e09567aaa00ede203ba4db006123cd553cb..1da05dbf0e959d1c1a44b9a0d2989e6b4e885d47 100644 (file)
@@ -94,7 +94,7 @@ HttpBootBuildDhcp4Options (
   OptEnt.Uuid->Type       = 0;\r
   if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) {\r
     //\r
-    // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+    // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
     //\r
     ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));\r
   }\r
index 2c2fa28302a3425f2baa55eb8fd4df76644a0e6c..74bbdac58e863667e1716356967572b82ee0059a 100644 (file)
@@ -41,7 +41,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
 /// DHCP offer types among HTTP boot.\r
 /// Dhcp4 and Dhcp6 share this definition, and corresponding\r
-/// relatioinship is as follows:\r
+/// relationship is as follows:\r
 ///   Dhcp4Discover <> Dhcp6Solicit\r
 ///   Dhcp4Offer    <> Dhcp6Advertise\r
 ///   Dhcp4Request  <> Dhcp6Request\r
index 8a1dd66ceec01f6b19cb920d2b3a60ca50ac3252..4905bca4ad19e64d7e7a88cb32f8c03f315ebefe 100644 (file)
@@ -126,7 +126,7 @@ HttpBootBuildDhcp6Options (
   @param[in]  OptTag        The required option tag.\r
 \r
   @retval     NULL          Failed to parse the required option.\r
-  @retval     Others        The postion of the required option in buffer.\r
+  @retval     Others        The position of the required option in buffer.\r
 \r
 **/\r
 EFI_DHCP6_PACKET_OPTION *\r
@@ -225,7 +225,7 @@ HttpBootParseDhcp6Packet (
   }\r
   //\r
   // The offer with assigned client address is NOT a proxy offer.\r
-  // An ia_na option, embeded with valid ia_addr option and a status_code of success.\r
+  // An ia_na option, embedded with valid ia_addr option and a status_code of success.\r
   //\r
   Option = Options[HTTP_BOOT_DHCP6_IDX_IA_NA];\r
   if (Option != NULL) {\r
@@ -514,7 +514,7 @@ HttpBootDhcp6CallBack (
 \r
   @retval     EFI_SUCCESS         Found a valid gateway address successfully.\r
   @retval     EFI_TIMEOUT         The operation is time out.\r
-  @retval     Other               Unexpect error happened.\r
+  @retval     Other               Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -628,8 +628,8 @@ ON_EXIT:
 \r
   @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
 \r
-  @retval     EFI_SUCCESS         Switch the IP policy succesfully.\r
-  @retval     Others              Unexpect error happened.\r
+  @retval     EFI_SUCCESS         Switch the IP policy successfully.\r
+  @retval     Others              Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
index e21f272aa1ac33ae5f00bf3a3e149bccedf644b4..e1a6520319763b45f163747e68d55cd639683815 100644 (file)
@@ -110,8 +110,8 @@ HttpBootDhcp6Sarr (
 \r
   @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
 \r
-  @retval     EFI_SUCCESS         Switch the IP policy succesfully.\r
-  @retval     Others              Unexpect error happened.\r
+  @retval     EFI_SUCCESS         Switch the IP policy successfully.\r
+  @retval     Others              Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
index 2efdd9be101a8e600b9bb9a469f9491fbf60d5b1..5d9c24f4a22ad8efb77b78ab4836a40911286289 100644 (file)
@@ -382,7 +382,7 @@ HttpBootIp4DxeDriverBindingSupported (
   @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
@@ -720,7 +720,7 @@ HttpBootIp4DxeDriverBindingStop (
   }\r
 \r
   //\r
-  // Destory all child instance and uninstall protocol interface.\r
+  // Destroy all child instance and uninstall protocol interface.\r
   //\r
   HttpBootDestroyIp4Children (This, Private);\r
 \r
@@ -871,7 +871,7 @@ HttpBootIp6DxeDriverBindingSupported (
   @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
@@ -1250,7 +1250,7 @@ HttpBootIp6DxeDriverBindingStop (
   }\r
 \r
   //\r
-  // Destory all child instance and uninstall protocol interface.\r
+  // Destroy all child instance and uninstall protocol interface.\r
   //\r
   HttpBootDestroyIp6Children (This, Private);\r
 \r
index 89b7d6aa702bf263e5804b9915d6e08a2d900d62..0b45f9de0bdb0d994261dc11b5a13969749fe2c6 100644 (file)
@@ -147,7 +147,7 @@ struct _HTTP_BOOT_PRIVATE_DATA {
   HTTP_BOOT_VIRTUAL_NIC                     *Ip6Nic;\r
 \r
   //\r
-  // Cousumed children\r
+  // Consumed children\r
   //\r
   EFI_HANDLE                                Ip6Child;\r
   EFI_HANDLE                                Dhcp4Child;\r
@@ -348,7 +348,7 @@ HttpBootIp4DxeDriverBindingSupported (
   @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
@@ -476,7 +476,7 @@ HttpBootIp6DxeDriverBindingSupported (
   @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
index 5eeb1ea2b4a76e42026ac7ffe5a1d30598243b72..4a51f35cddbe84e3c79b1ae93f6fe51a45abe6d3 100644 (file)
@@ -14,7 +14,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
   @param[in] Private           Pointer to HTTP Boot private data.\r
 \r
-  @retval EFI_SUCCESS          HTTP Boot Callback Protocol installed succesfully.\r
+  @retval EFI_SUCCESS          HTTP Boot Callback Protocol installed successfully.\r
   @retval Others               Failed to install HTTP Boot Callback Protocol.\r
 \r
 **/\r
index 61814d3b64ff485eb250f0bfa98e8cbc117d31b1..5b0e054a05ebb81f7f45cba24a42d4de402833d2 100644 (file)
@@ -494,7 +494,7 @@ Exit:
 /**\r
   Create a HTTP_IO_HEADER to hold the HTTP header items.\r
 \r
-  @param[in]  MaxHeaderCount         The maximun number of HTTP header in this holder.\r
+  @param[in]  MaxHeaderCount         The maximum number of HTTP header in this holder.\r
 \r
   @return    A pointer of the HTTP header holder or NULL if failed.\r
 \r
@@ -522,7 +522,7 @@ HttpBootCreateHeader (
 }\r
 \r
 /**\r
-  Destroy the HTTP_IO_HEADER and release the resouces.\r
+  Destroy the HTTP_IO_HEADER and release the resources.\r
 \r
   @param[in]  HttpIoHeader       Point to the HTTP header holder to be destroyed.\r
 \r
@@ -765,7 +765,7 @@ HttpIoCreateIo (
   }\r
 \r
   //\r
-  // Create events for variuos asynchronous operations.\r
+  // Create events for various asynchronous operations.\r
   //\r
   Status = gBS->CreateEvent (\r
                   EVT_NOTIFY_SIGNAL,\r
@@ -817,7 +817,7 @@ ON_ERROR:
 }\r
 \r
 /**\r
-  Destroy the HTTP_IO and release the resouces.\r
+  Destroy the HTTP_IO and release the resources.\r
 \r
   @param[in]  HttpIo          The HTTP_IO which wraps the HTTP service to be destroyed.\r
 \r
@@ -878,7 +878,7 @@ HttpIoDestroyIo (
   @param[in]   BodyLength       Length in bytes of the HTTP body.\r
   @param[in]   Body             Body associated with the HTTP request.\r
 \r
-  @retval EFI_SUCCESS            The HTTP request is trasmitted.\r
+  @retval EFI_SUCCESS            The HTTP request is transmitted.\r
   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
   @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.\r
@@ -1179,7 +1179,7 @@ HttpBootParseFilePath (
   @retval EFI_INVALID_PARAMETER  ImageType, Uri or UriParser is NULL.\r
   @retval EFI_INVALID_PARAMETER  HeaderCount is not zero, and Headers is NULL.\r
   @retval EFI_NOT_FOUND          Failed to identify the image type.\r
-  @retval Others                 Unexpect error happened.\r
+  @retval Others                 Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r
index 10f62f6ec31ab840b3d3a66f0dd6a6fa2eff7755..81d072ae37342e9b63e01b7772d00e5ea3dcb0d1 100644 (file)
@@ -98,7 +98,7 @@ typedef struct {
 /**\r
   Create a HTTP_IO_HEADER to hold the HTTP header items.\r
 \r
-  @param[in]  MaxHeaderCount         The maximun number of HTTP header in this holder.\r
+  @param[in]  MaxHeaderCount         The maximum number of HTTP header in this holder.\r
 \r
   @return    A pointer of the HTTP header holder or NULL if failed.\r
 \r
@@ -109,7 +109,7 @@ HttpBootCreateHeader (
   );\r
 \r
 /**\r
-  Destroy the HTTP_IO_HEADER and release the resouces.\r
+  Destroy the HTTP_IO_HEADER and release the resources.\r
 \r
   @param[in]  HttpIoHeader       Point to the HTTP header holder to be destroyed.\r
 \r
@@ -300,7 +300,7 @@ HttpIoCreateIo (
   );\r
 \r
 /**\r
-  Destroy the HTTP_IO and release the resouces.\r
+  Destroy the HTTP_IO and release the resources.\r
 \r
   @param[in]  HttpIo          The HTTP_IO which wraps the HTTP service to be destroyed.\r
 \r
@@ -320,7 +320,7 @@ HttpIoDestroyIo (
   @param[in]   BodyLength       Length in bytes of the HTTP body.\r
   @param[in]   Body             Body associated with the HTTP request.\r
 \r
-  @retval EFI_SUCCESS            The HTTP request is trasmitted.\r
+  @retval EFI_SUCCESS            The HTTP request is transmitted.\r
   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.\r
   @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.\r
@@ -406,7 +406,7 @@ HttpBootParseFilePath (
   @retval EFI_INVALID_PARAMETER  ImageType, Uri or UriParser is NULL.\r
   @retval EFI_INVALID_PARAMETER  HeaderCount is not zero, and Headers is NULL.\r
   @retval EFI_NOT_FOUND          Failed to identify the image type.\r
-  @retval Others                 Unexpect error happened.\r
+  @retval Others                 Unexpected error happened.\r
 \r
 **/\r
 EFI_STATUS\r