tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NetworkPkg/Library: Fix various typos 

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-43-philmd@redhat.com>
This commit is contained in:
Antoine Coeur 2020-02-07 02:07:55 +01:00 committed by mergify[bot]
parent efb5659334
commit 6deb4baa1f
11 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NetworkPkg/Include/Library/HttpLib.h
View File

@ -425,7 +425,7 @@ HttpFreeHeaderFields (
the HTTP request message.
@param[in] Url The URL of a remote host.
@param[out] RequestMsg Pointer to the created HTTP request message.
NULL if any error occured.
NULL if any error occurred.
@param[out] RequestMsgSize Size of the RequestMsg (in bytes).
@retval EFI_SUCCESS If HTTP request string was created successfully.

4
NetworkPkg/Include/Library/IpIoLib.h
View File

@ -403,7 +403,7 @@ IpIoOpen (
This function is called after IpIoOpen(). The data to be sent is wrapped in
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
overriden by Sender. Other sending configs, like source address and gateway
overridden by Sender. Other sending configs, like source address and gateway
address etc., are specified in OverrideData.
@param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
@ -508,7 +508,7 @@ IpIoConfigIp (
This function pairs with IpIoAddIp(). The IpInfo is previously created by
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
will be dstroyed if the RefCnt is zero.
will be destroyed if the RefCnt is zero.
@param[in] IpIo The pointer to the IP_IO instance.
@param[in] IpInfo The pointer to the IpInfo to be removed.

2
NetworkPkg/Include/Library/NetLib.h
View File

@ -748,7 +748,7 @@ EFI_STATUS
If it has been removed, then restart the traversal from the head.
If it hasn't been removed, then continue with the next node directly.
This function will end the iterate and return the CallBack's last return value if error happens,
or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
or return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
@param[in] List The head of the list.
@param[in] CallBack Pointer to the callback function to destroy one node in the list.

6
NetworkPkg/Include/Library/TcpIoLib.h
View File

@ -200,7 +200,7 @@ TcpIoReset (
@param[in] TcpIo The TcpIo wrapping the TCP socket.
@param[in] Packet The packet to transmit.
@retval EFI_SUCCESS The packet is trasmitted.
@retval EFI_SUCCESS The packet is transmitted.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more of the control options are not
supported in the implementation.
@ -221,14 +221,14 @@ TcpIoTransmit (
@param[in, out] TcpIo The TcpIo which wraps the socket to be destroyed.
@param[in] Packet The buffer to hold the data copy from the socket rx buffer.
@param[in] AsyncMode Is this receive asyncronous or not.
@param[in] AsyncMode Is this receive asynchronous or not.
@param[in] Timeout The time to wait for receiving the amount of data the Packet
can hold. Set to NULL for infinite wait.
@retval EFI_SUCCESS The required amount of data is received from the socket.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
@retval EFI_OUT_OF_RESOURCES Failed to allocate momery.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_TIMEOUT Failed to receive the required amount of data in the
specified time period.
@retval Others Other errors as indicated.

6
NetworkPkg/Include/Library/UdpIoLib.h
View File

@ -43,7 +43,7 @@ typedef struct {
This prototype is used by both receive and sending when calling
UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the
UDP access point and released by the user. When sending, the user allocates the the NetBuf,
UDP access point and released by the user. When sending, the user allocates the NetBuf,
which is then provided to the callback as a reference.
@param[in] Packet The packet received or sent.
@ -197,7 +197,7 @@ BOOLEAN
@param[in] UdpIo The UDP_IO to cancel packet.
@param[in] IoStatus The IoStatus to return to the packet owners.
@param[in] ToCancel The select funtion to test whether to cancel this
@param[in] ToCancel The select function to test whether to cancel this
packet or not.
@param[in] Context The opaque parameter to the ToCancel.
@ -228,7 +228,7 @@ UdpIoCancelDgrams (
@param[in] ImageHandle The image handle for the driver.
@param[in] Configure The function to configure the created UDP child.
@param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.
@param[in] Context The opaque parameter for the Configure funtion.
@param[in] Context The opaque parameter for the Configure function.
@return The newly-created UDP_IO, or NULL if failed.

4
NetworkPkg/Library/DxeHttpLib/DxeHttpLib.c
View File

@ -1677,7 +1677,7 @@ HttpGetFieldNameAndValue (
/**
Free existing HeaderFields.
@param[in] HeaderFields Pointer to array of key/value header pairs waitting for free.
@param[in] HeaderFields Pointer to array of key/value header pairs waiting for free.
@param[in] FieldCount The number of header pairs in HeaderFields.
**/
@ -1717,7 +1717,7 @@ HttpFreeHeaderFields (
the HTTP request message.
@param[in] Url The URL of a remote host.
@param[out] RequestMsg Pointer to the created HTTP request message.
NULL if any error occured.
NULL if any error occurred.
@param[out] RequestMsgSize Size of the RequestMsg (in bytes).
@retval EFI_SUCCESS If HTTP request string was created successfully.

16
NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.c
View File

@ -123,7 +123,7 @@ IpIoTransmitHandler (
@retval EFI_SUCCESS The IP child is created and the IP protocol
interface is retrieved.
@retval EFI_UNSUPPORTED Upsupported IpVersion.
@retval EFI_UNSUPPORTED Unsupported IpVersion.
@retval Others The required operation failed.
**/
@ -191,7 +191,7 @@ IpIoCreateIpChildOpenProtocol (
/**
This function close the previously openned IP protocol and destroy the IP child.
This function close the previously opened IP protocol and destroy the IP child.
@param[in] ControllerHandle The controller handle.
@param[in] ImageHandle The image handle.
@ -201,7 +201,7 @@ IpIoCreateIpChildOpenProtocol (
@retval EFI_SUCCESS The IP protocol is closed and the relevant IP child
is destroyed.
@retval EFI_UNSUPPORTED Upsupported IpVersion.
@retval EFI_UNSUPPORTED Unsupported IpVersion.
@retval Others The required operation failed.
**/
@ -228,7 +228,7 @@ IpIoCloseProtocolDestroyIpChild (
}
//
// Close the previously openned IP protocol.
// Close the previously opened IP protocol.
//
Status = gBS->CloseProtocol (
ChildHandle,
@ -626,7 +626,7 @@ IpIoExtFree (
@param[in] Context Pointer to the context.
@param[in] NotifyData Pointer to the notify data.
@param[in] Dest Pointer to the destination IP address.
@param[in] Override Pointer to the overriden IP_IO data.
@param[in] Override Pointer to the overridden IP_IO data.
@return Pointer to the data structure created to wrap the packet. If any error occurs,
then return NULL.
@ -1497,7 +1497,7 @@ IpIoStop (
IpIo->IsConfigured = FALSE;
//
// Detroy the Ip List used by IpIo
// Destroy the Ip List used by IpIo
//
while (!IsListEmpty (&(IpIo->IpList))) {
@ -1577,7 +1577,7 @@ IpIoDestroy (
This function is called after IpIoOpen(). The data to be sent is wrapped in
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
overriden by Sender. Other sending configs, like source address and gateway
overridden by Sender. Other sending configs, like source address and gateway
address etc., are specified in OverrideData.
@param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
@ -1991,7 +1991,7 @@ IpIoConfigIp (
This function pairs with IpIoAddIp(). The IpInfo is previously created by
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
will be dstroyed if the RefCnt is zero.
will be destroyed if the RefCnt is zero.
@param[in] IpIo Pointer to the IP_IO instance.
@param[in] IpInfo Pointer to the IpInfo to be removed.

16
NetworkPkg/Library/DxeNetLib/DxeNetLib.c
View File

@ -36,7 +36,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
#define DEFAULT_ZERO_START ((UINTN) ~0)
//
// All the supported IP4 maskes in host byte order.
// All the supported IP4 masks in host byte order.
//
GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks[IP4_MASK_NUM] = {
0x00000000,
@ -130,7 +130,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate = {
to send the syslog packets. The caller isn't required to close
the SNP after use because the SNP is opened by HandleProtocol.
@return The point to SNP if one is properly openned. Otherwise NULL
@return The point to SNP if one is properly opened. Otherwise NULL
**/
EFI_SIMPLE_NETWORK_PROTOCOL *
@ -304,7 +304,7 @@ ON_EXIT:
@param[in] File The file that contains the current log
@param[in] Line The line of code in the File that contains the current log
@param[in] Message The log message
@param[in] BufLen The lenght of the Buf
@param[in] BufLen The length of the Buf
@param[out] Buf The buffer to put the packet data
@return The length of the syslog packet built, 0 represents no packet is built.
@ -480,7 +480,7 @@ NetDebugASPrint (
Because it isn't open the SNP BY_DRIVER, apply caution when using it.
@param Level The severity level of the message.
@param Module The Moudle that generates the log.
@param Module The Module that generates the log.
@param File The file that contains the log.
@param Line The exact line that contains the log.
@param Message The user message to log.
@ -518,7 +518,7 @@ NetDebugOutput (
}
//
// Allocate a maxium of 1024 bytes, the caller should ensure
// Allocate a maximum of 1024 bytes, the caller should ensure
// that the message plus the ethernet/ip/udp header is shorter
// than this
//
@ -1129,7 +1129,7 @@ NetListInsertBefore (
If it has been removed, then restart the traversal from the head.
If it hasn't been removed, then continue with the next node directly.
This function will end the iterate and return the CallBack's last return value if error happens,
or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
or return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
@param[in] List The head of the list.
@param[in] CallBack Pointer to the callback function to destroy one node in the list.
@ -1353,7 +1353,7 @@ NetMapGetCount (
Return one allocated item.
If the Recycled doubly linked list of the netmap is empty, it will try to allocate
a batch of items if there are enough resources and add corresponding nodes to the begining
a batch of items if there are enough resources and add corresponding nodes to the beginning
of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove
the fist node entry of the Recycled doubly linked list and return the corresponding item.
@ -3299,7 +3299,7 @@ NetLibGetSystemGuid (
String = (CHAR8 *) (Smbios.Raw + Smbios.Hdr->Length);
//
// Step 2: Skip over unformated string section.
// Step 2: Skip over unformatted string section.
//
do {
//

4
NetworkPkg/Library/DxeNetLib/NetBuffer.c
View File

@ -602,7 +602,7 @@ NetbufGetFragment (
if (HeadSpace != 0) {
//
// Allocate an extra block to accomdate the head space.
// Allocate an extra block to accommodate the head space.
//
BlockOpNum++;
@ -791,7 +791,7 @@ NetbufFromExt (
if (Len == 0) {
//
// Increament the index number to point to the next
// Increment the index number to point to the next
// non-empty fragment.
//
Index++;

10
NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
View File

@ -304,7 +304,7 @@ TcpIoCreateSocket (
}
//
// Create events for variuos asynchronous operations.
// Create events for various asynchronous operations.
//
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
@ -745,7 +745,7 @@ TcpIoReset (
@param[in] TcpIo The TcpIo wrapping the TCP socket.
@param[in] Packet The packet to transmit.
@retval EFI_SUCCESS The packet is trasmitted.
@retval EFI_SUCCESS The packet is transmitted.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more of the control options are not
supported in the implementation.
@ -807,7 +807,7 @@ TcpIoTransmit (
Status = EFI_DEVICE_ERROR;
//
// Trasnmit the packet.
// Transmit the packet.
//
if (TcpIo->TcpVersion == TCP_VERSION_4) {
TcpIo->TxToken.Tcp4Token.Packet.TxData = (EFI_TCP4_TRANSMIT_DATA *) Data;
@ -862,14 +862,14 @@ ON_EXIT:
@param[in, out] TcpIo The TcpIo which wraps the socket to be destroyed.
@param[in] Packet The buffer to hold the data copy from the socket rx buffer.
@param[in] AsyncMode Is this receive asyncronous or not.
@param[in] AsyncMode Is this receive asynchronous or not.
@param[in] Timeout The time to wait for receiving the amount of data the Packet
can hold. Set to NULL for infinite wait.
@retval EFI_SUCCESS The required amount of data is received from the socket.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
@retval EFI_OUT_OF_RESOURCES Failed to allocate momery.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_TIMEOUT Failed to receive the required amount of data in the
specified time period.
@retval Others Other errors as indicated.

10
NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.c
View File

@ -147,7 +147,7 @@ UdpIoRecycleDgram (
/**
The event handle for UDP receive request.
It will build a NET_BUF from the recieved UDP data, then deliver it
It will build a NET_BUF from the received UDP data, then deliver it
to the receiver.
@param[in] Context The UDP RX token.
@ -335,7 +335,7 @@ UdpIoOnDgramRcvd (
@param[in] UdpIo The UdpIo to receive packets from.
@param[in] CallBack The function to call when receive finished.
@param[in] Context The opaque parameter to the CallBack.
@param[in] HeadLen The head length to reserver for the packet.
@param[in] HeadLen The head length to reserve for the packet.
@return The Wrapped request or NULL if failed to allocate resources or some errors happened.
@ -410,7 +410,7 @@ UdpIoCreateRxToken (
@param[in] UdpIo The UdpIo to send packet to.
@param[in] Packet The user's packet.
@param[in] EndPoint The local and remote access point.
@param[in] Gateway The overrided next hop.
@param[in] Gateway The overridden next hop.
@param[in] CallBack The function to call when transmission completed.
@param[in] Context The opaque parameter to the call back.
@ -590,7 +590,7 @@ UdpIoCreateTxToken (
@param[in] ImageHandle The image handle for the driver.
@param[in] Configure The function to configure the created UDP child.
@param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.
@param[in] Context The opaque parameter for the Configure funtion.
@param[in] Context The opaque parameter for the Configure function.
@return Newly-created UDP_IO or NULL if failed.
@ -755,7 +755,7 @@ FREE_MEM:
@param[in] UdpIo The UDP_IO to cancel packet.
@param[in] IoStatus The IoStatus to return to the packet owners.
@param[in] ToCancel The select funtion to test whether to cancel this
@param[in] ToCancel The select function to test whether to cancel this
packet or not.
@param[in] Context The opaque parameter to the ToCancel.