From: Antoine Coeur <co...@gmx.fr>
Fix various typos in comments and documentation.
Cc: Jiaxin Wu <jiaxin...@intel.com>
Cc: Siyuan Fu <siyuan...@intel.com>
Cc: Maciej Rabeda <maciej.rab...@intel.com>
Reviewed-by: Philippe Mathieu-Daude <phi...@redhat.com>
Signed-off-by: Philippe Mathieu-Daude <phi...@redhat.com>
---
NetworkPkg/HttpBootDxe/HttpBootDhcp4.h | 2 +-
NetworkPkg/HttpBootDxe/HttpBootDhcp6.h | 4 ++--
NetworkPkg/HttpBootDxe/HttpBootDxe.h | 6 +++---
NetworkPkg/HttpBootDxe/HttpBootSupport.h | 10 +++++-----
NetworkPkg/HttpBootDxe/HttpBootDhcp4.c | 2 +-
NetworkPkg/HttpBootDxe/HttpBootDhcp6.c | 10 +++++-----
NetworkPkg/HttpBootDxe/HttpBootDxe.c | 8 ++++----
NetworkPkg/HttpBootDxe/HttpBootImpl.c | 2 +-
NetworkPkg/HttpBootDxe/HttpBootSupport.c | 12 ++++++------
9 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
b/NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
index 2c2fa28302a3..74bbdac58e86 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
+++ b/NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
@@ -41,7 +41,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
/// DHCP offer types among HTTP boot.
/// Dhcp4 and Dhcp6 share this definition, and corresponding
-/// relatioinship is as follows:
+/// relationship is as follows:
/// Dhcp4Discover <> Dhcp6Solicit
/// Dhcp4Offer <> Dhcp6Advertise
/// Dhcp4Request <> Dhcp6Request
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
b/NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
index e21f272aa1ac..e1a652031976 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
+++ b/NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
@@ -110,8 +110,8 @@ HttpBootDhcp6Sarr (
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
- @retval EFI_SUCCESS Switch the IP policy succesfully.
- @retval Others Unexpect error happened.
+ @retval EFI_SUCCESS Switch the IP policy successfully.
+ @retval Others Unexpected error happened.
**/
EFI_STATUS
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDxe.h
b/NetworkPkg/HttpBootDxe/HttpBootDxe.h
index 89b7d6aa702b..0b45f9de0bdb 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDxe.h
+++ b/NetworkPkg/HttpBootDxe/HttpBootDxe.h
@@ -147,7 +147,7 @@ struct _HTTP_BOOT_PRIVATE_DATA {
HTTP_BOOT_VIRTUAL_NIC *Ip6Nic;
//
- // Cousumed children
+ // Consumed children
//
EFI_HANDLE Ip6Child;
EFI_HANDLE Dhcp4Child;
@@ -348,7 +348,7 @@ HttpBootIp4DxeDriverBindingSupported (
@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
@@ -476,7 +476,7 @@ HttpBootIp6DxeDriverBindingSupported (
@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
diff --git a/NetworkPkg/HttpBootDxe/HttpBootSupport.h
b/NetworkPkg/HttpBootDxe/HttpBootSupport.h
index 10f62f6ec31a..81d072ae3734 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootSupport.h
+++ b/NetworkPkg/HttpBootDxe/HttpBootSupport.h
@@ -98,7 +98,7 @@ typedef struct {
/**
Create a HTTP_IO_HEADER to hold the HTTP header items.
- @param[in] MaxHeaderCount The maximun number of HTTP header in this holder.
+ @param[in] MaxHeaderCount The maximum number of HTTP header in this
holder.
@return A pointer of the HTTP header holder or NULL if failed.
@@ -109,7 +109,7 @@ HttpBootCreateHeader (
);
/**
- Destroy the HTTP_IO_HEADER and release the resouces.
+ Destroy the HTTP_IO_HEADER and release the resources.
@param[in] HttpIoHeader Point to the HTTP header holder to be destroyed.
@@ -300,7 +300,7 @@ HttpIoCreateIo (
);
/**
- Destroy the HTTP_IO and release the resouces.
+ Destroy the HTTP_IO and release the resources.
@param[in] HttpIo The HTTP_IO which wraps the HTTP service to be destroyed.
@@ -320,7 +320,7 @@ HttpIoDestroyIo (
@param[in] BodyLength Length in bytes of the HTTP body.
@param[in] Body Body associated with the HTTP request.
- @retval EFI_SUCCESS The HTTP request is trasmitted.
+ @retval EFI_SUCCESS The HTTP request is transmitted.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_DEVICE_ERROR An unexpected network or system error
occurred.
@@ -406,7 +406,7 @@ HttpBootParseFilePath (
@retval EFI_INVALID_PARAMETER ImageType, Uri or UriParser is NULL.
@retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers is NULL.
@retval EFI_NOT_FOUND Failed to identify the image type.
- @retval Others Unexpect error happened.
+ @retval Others Unexpected error happened.
**/
EFI_STATUS
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
b/NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
index b5dd6e09567a..1da05dbf0e95 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
@@ -94,7 +94,7 @@ HttpBootBuildDhcp4Options (
OptEnt.Uuid->Type = 0;
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) {
//
- // Zero the Guid to indicate NOT programable if failed to get system Guid.
+ // Zero the Guid to indicate NOT programmable if failed to get system Guid.
//
ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));
}
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
b/NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
index 8a1dd66ceec0..4905bca4ad19 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
@@ -126,7 +126,7 @@ HttpBootBuildDhcp6Options (
@param[in] OptTag The required option tag.
@retval NULL Failed to parse the required option.
- @retval Others The postion of the required option in buffer.
+ @retval Others The position of the required option in buffer.
**/
EFI_DHCP6_PACKET_OPTION *
@@ -225,7 +225,7 @@ HttpBootParseDhcp6Packet (
}
//
// The offer with assigned client address is NOT a proxy offer.
- // An ia_na option, embeded with valid ia_addr option and a status_code of
success.
+ // An ia_na option, embedded with valid ia_addr option and a status_code of
success.
//
Option = Options[HTTP_BOOT_DHCP6_IDX_IA_NA];
if (Option != NULL) {
@@ -514,7 +514,7 @@ HttpBootDhcp6CallBack (
@retval EFI_SUCCESS Found a valid gateway address successfully.
@retval EFI_TIMEOUT The operation is time out.
- @retval Other Unexpect error happened.
+ @retval Other Unexpected error happened.
**/
EFI_STATUS
@@ -628,8 +628,8 @@ ON_EXIT:
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
- @retval EFI_SUCCESS Switch the IP policy succesfully.
- @retval Others Unexpect error happened.
+ @retval EFI_SUCCESS Switch the IP policy successfully.
+ @retval Others Unexpected error happened.
**/
EFI_STATUS
diff --git a/NetworkPkg/HttpBootDxe/HttpBootDxe.c
b/NetworkPkg/HttpBootDxe/HttpBootDxe.c
index 2efdd9be101a..5d9c24f4a22a 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDxe.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootDxe.c
@@ -382,7 +382,7 @@ HttpBootIp4DxeDriverBindingSupported (
@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
@@ -720,7 +720,7 @@ HttpBootIp4DxeDriverBindingStop (
}
//
- // Destory all child instance and uninstall protocol interface.
+ // Destroy all child instance and uninstall protocol interface.
//
HttpBootDestroyIp4Children (This, Private);
@@ -871,7 +871,7 @@ HttpBootIp6DxeDriverBindingSupported (
@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
@@ -1250,7 +1250,7 @@ HttpBootIp6DxeDriverBindingStop (
}
//
- // Destory all child instance and uninstall protocol interface.
+ // Destroy all child instance and uninstall protocol interface.
//
HttpBootDestroyIp6Children (This, Private);
diff --git a/NetworkPkg/HttpBootDxe/HttpBootImpl.c b/NetworkPkg/HttpBootDxe/HttpBootImpl.c
index 5eeb1ea2b4a7..4a51f35cddbe 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootImpl.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootImpl.c
@@ -14,7 +14,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
@param[in] Private Pointer to HTTP Boot private data.
- @retval EFI_SUCCESS HTTP Boot Callback Protocol installed succesfully.
+ @retval EFI_SUCCESS HTTP Boot Callback Protocol installed
successfully.
@retval Others Failed to install HTTP Boot Callback Protocol.
**/
diff --git a/NetworkPkg/HttpBootDxe/HttpBootSupport.c
b/NetworkPkg/HttpBootDxe/HttpBootSupport.c
index 61814d3b64ff..5b0e054a05eb 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootSupport.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootSupport.c
@@ -494,7 +494,7 @@ Exit:
/**
Create a HTTP_IO_HEADER to hold the HTTP header items.
- @param[in] MaxHeaderCount The maximun number of HTTP header in this holder.
+ @param[in] MaxHeaderCount The maximum number of HTTP header in this
holder.
@return A pointer of the HTTP header holder or NULL if failed.
@@ -522,7 +522,7 @@ HttpBootCreateHeader (
}
/**
- Destroy the HTTP_IO_HEADER and release the resouces.
+ Destroy the HTTP_IO_HEADER and release the resources.
@param[in] HttpIoHeader Point to the HTTP header holder to be destroyed.
@@ -765,7 +765,7 @@ HttpIoCreateIo (
}
//
- // Create events for variuos asynchronous operations.
+ // Create events for various asynchronous operations.
//
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
@@ -817,7 +817,7 @@ ON_ERROR:
}
/**
- Destroy the HTTP_IO and release the resouces.
+ Destroy the HTTP_IO and release the resources.
@param[in] HttpIo The HTTP_IO which wraps the HTTP service to be destroyed.
@@ -878,7 +878,7 @@ HttpIoDestroyIo (
@param[in] BodyLength Length in bytes of the HTTP body.
@param[in] Body Body associated with the HTTP request.
- @retval EFI_SUCCESS The HTTP request is trasmitted.
+ @retval EFI_SUCCESS The HTTP request is transmitted.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_DEVICE_ERROR An unexpected network or system error
occurred.
@@ -1179,7 +1179,7 @@ HttpBootParseFilePath (
@retval EFI_INVALID_PARAMETER ImageType, Uri or UriParser is NULL.
@retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers is NULL.
@retval EFI_NOT_FOUND Failed to identify the image type.
- @retval Others Unexpect error happened.
+ @retval Others Unexpected error happened.
**/
EFI_STATUS
