sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

NetworkPkg/HttpBootDxe: Fix various typos

Browse Source 
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>
This commit is contained in:
Antoine Coeur
2020-02-07 02:07:50 +01:00
committed by mergify[bot]
parent cd72b6cfd1
commit c36b7b5114
9 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
NetworkPkg/HttpBootDxe/HttpBootDhcp4.c
View File

@ -94,7 +94,7 @@ HttpBootBuildDhcp4Options (
OptEnt.Uuid->Type = 0; OptEnt.Uuid->Type = 0;
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) { 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)); ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));
} }

2
NetworkPkg/HttpBootDxe/HttpBootDhcp4.h
View File

@ -41,7 +41,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
/// DHCP offer types among HTTP boot. /// DHCP offer types among HTTP boot.
/// Dhcp4 and Dhcp6 share this definition, and corresponding /// Dhcp4 and Dhcp6 share this definition, and corresponding
/// relatioinship is as follows: /// relationship is as follows:
/// Dhcp4Discover <> Dhcp6Solicit /// Dhcp4Discover <> Dhcp6Solicit
/// Dhcp4Offer <> Dhcp6Advertise /// Dhcp4Offer <> Dhcp6Advertise
/// Dhcp4Request <> Dhcp6Request /// Dhcp4Request <> Dhcp6Request

10
NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
View File

@ -126,7 +126,7 @@ HttpBootBuildDhcp6Options (
@param[in] OptTag The required option tag. @param[in] OptTag The required option tag.
@retval NULL Failed to parse the required option. @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 * EFI_DHCP6_PACKET_OPTION *
@ -225,7 +225,7 @@ HttpBootParseDhcp6Packet (
} }
// //
// The offer with assigned client address is NOT a proxy offer. // 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]; Option = Options[HTTP_BOOT_DHCP6_IDX_IA_NA];
if (Option != NULL) { if (Option != NULL) {
@ -514,7 +514,7 @@ HttpBootDhcp6CallBack (
@retval EFI_SUCCESS Found a valid gateway address successfully. @retval EFI_SUCCESS Found a valid gateway address successfully.
@retval EFI_TIMEOUT The operation is time out. @retval EFI_TIMEOUT The operation is time out.
@retval Other Unexpect error happened. @retval Other Unexpected error happened.
**/ **/
EFI_STATUS EFI_STATUS
@ -628,8 +628,8 @@ ON_EXIT:
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA. @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
@retval EFI_SUCCESS Switch the IP policy succesfully. @retval EFI_SUCCESS Switch the IP policy successfully.
@retval Others Unexpect error happened. @retval Others Unexpected error happened.
**/ **/
EFI_STATUS EFI_STATUS

4
NetworkPkg/HttpBootDxe/HttpBootDhcp6.h
View File

@ -110,8 +110,8 @@ HttpBootDhcp6Sarr (
@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA. @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
@retval EFI_SUCCESS Switch the IP policy succesfully. @retval EFI_SUCCESS Switch the IP policy successfully.
@retval Others Unexpect error happened. @retval Others Unexpected error happened.
**/ **/
EFI_STATUS EFI_STATUS

8
NetworkPkg/HttpBootDxe/HttpBootDxe.c
View File

@ -382,7 +382,7 @@ HttpBootIp4DxeDriverBindingSupported (
@retval EFI_SUCCESS The device was started. @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_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 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 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); HttpBootDestroyIp4Children (This, Private);
@ -871,7 +871,7 @@ HttpBootIp6DxeDriverBindingSupported (
@retval EFI_SUCCESS The device was started. @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_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 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 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); HttpBootDestroyIp6Children (This, Private);

6
NetworkPkg/HttpBootDxe/HttpBootDxe.h
View File

@ -147,7 +147,7 @@ struct _HTTP_BOOT_PRIVATE_DATA {
HTTP_BOOT_VIRTUAL_NIC *Ip6Nic; HTTP_BOOT_VIRTUAL_NIC *Ip6Nic;
// //
// Cousumed children // Consumed children
// //
EFI_HANDLE Ip6Child; EFI_HANDLE Ip6Child;
EFI_HANDLE Dhcp4Child; EFI_HANDLE Dhcp4Child;
@ -348,7 +348,7 @@ HttpBootIp4DxeDriverBindingSupported (
@retval EFI_SUCCESS The device was started. @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_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 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 EFI_STATUS
@ -476,7 +476,7 @@ HttpBootIp6DxeDriverBindingSupported (
@retval EFI_SUCCESS The device was started. @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_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 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 EFI_STATUS

2
NetworkPkg/HttpBootDxe/HttpBootImpl.c
View File

@ -14,7 +14,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
@param[in] Private Pointer to HTTP Boot private data. @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. @retval Others Failed to install HTTP Boot Callback Protocol.
**/ **/

12
NetworkPkg/HttpBootDxe/HttpBootSupport.c
View File

@ -494,7 +494,7 @@ Exit:
/** /**
Create a HTTP_IO_HEADER to hold the HTTP header items. 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. @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. @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 ( Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL, 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. @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] BodyLength Length in bytes of the HTTP body.
@param[in] Body Body associated with the HTTP request. @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_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred. @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 ImageType, Uri or UriParser is NULL.
@retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers 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 EFI_NOT_FOUND Failed to identify the image type.
@retval Others Unexpect error happened. @retval Others Unexpected error happened.
**/ **/
EFI_STATUS EFI_STATUS

10
NetworkPkg/HttpBootDxe/HttpBootSupport.h
View File

@ -98,7 +98,7 @@ typedef struct {
/** /**
Create a HTTP_IO_HEADER to hold the HTTP header items. 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. @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. @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. @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] BodyLength Length in bytes of the HTTP body.
@param[in] Body Body associated with the HTTP request. @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_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred. @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 ImageType, Uri or UriParser is NULL.
@retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers 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 EFI_NOT_FOUND Failed to identify the image type.
@retval Others Unexpect error happened. @retval Others Unexpected error happened.
**/ **/
EFI_STATUS EFI_STATUS