NetworkPkg: Fix a typo

Correctly write 'malformatted' in documentation, comments and
debug strings.

Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-30-philmd@redhat.com>
This commit is contained in:
Philippe Mathieu-Daudé 2020-02-07 02:07:42 +01:00 committed by mergify[bot]
parent 788421d5a7
commit 8d774c745c
17 changed files with 33 additions and 33 deletions

View File

@ -230,7 +230,7 @@ DhcpOptionIsValid (
@param[out] Para The variable to save the interested parameter
@retval EFI_SUCCESS The DHCP option is successfully extracted.
@retval EFI_INVALID_PARAMETER The DHCP option is mal-formated
@retval EFI_INVALID_PARAMETER The DHCP option is malformatted
**/
EFI_STATUS
@ -303,7 +303,7 @@ DhcpGetParameter (
option.
@retval EFI_SUCCESS All the options are valid
@retval EFI_INVALID_PARAMETER The options are mal-formated.
@retval EFI_INVALID_PARAMETER The options are malformatted.
**/
EFI_STATUS
@ -538,7 +538,7 @@ DhcpFillOption (
@retval EFI_NOT_FOUND Cannot find any option.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet.
@retval EFI_INVALID_PARAMETER The options are mal-formated
@retval EFI_INVALID_PARAMETER The options are malformatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@ -639,7 +639,7 @@ ON_EXIT:
@param[out] Para The variable to save the DHCP parameters.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet.
@retval EFI_INVALID_PARAMETER The options are mal-formated
@retval EFI_INVALID_PARAMETER The options are malformatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@ -770,7 +770,7 @@ DhcpAppendOption (
function.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory
@retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated
@retval EFI_INVALID_PARAMETER The options in SeekPacket are malformatted
@retval EFI_SUCCESS The packet is build.
**/

View File

@ -133,7 +133,7 @@ DhcpIterateOptions (
@param[out] Para The variable to save the DHCP parameters.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet.
@retval EFI_INVALID_PARAMETER The options are mal-formated
@retval EFI_INVALID_PARAMETER The options are malformatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@ -167,7 +167,7 @@ DhcpValidateOptions (
@retval EFI_NOT_FOUND Cannot find any option.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet.
@retval EFI_INVALID_PARAMETER The options are mal-formated
@retval EFI_INVALID_PARAMETER The options are malformatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@ -211,7 +211,7 @@ DhcpAppendOption (
function.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory
@retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated
@retval EFI_INVALID_PARAMETER The options in SeekPacket are malformatted
@retval EFI_SUCCESS The packet is build.
**/

View File

@ -319,7 +319,7 @@ Ip4ProcessIcmpQuery (
@param[in] Packet The content of the ICMP query with IP4 head
removed.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_SUCCESS The ICMP message is successfully processed.
@retval Others Failed to handle ICMP packet.

View File

@ -83,7 +83,7 @@ extern EFI_IP4_ICMP_TYPE mIp4SupportedIcmp[];
@param[in] Packet The content of the ICMP query with IP4 head
removed.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_SUCCESS The ICMP message is successfully processed.
@retval Others Failed to handle ICMP packet.

View File

@ -401,7 +401,7 @@ Ip4LeaveGroup (
@param[in] Head The IP4 header of the received message.
@param[in] Packet The IGMP message, without IP4 header.
@retval EFI_INVALID_PARAMETER The IGMP message is malformated.
@retval EFI_INVALID_PARAMETER The IGMP message is malformatted.
@retval EFI_SUCCESS The IGMP message is successfully processed.
**/

View File

@ -111,7 +111,7 @@ Ip4LeaveGroup (
@param[in] Head The IP4 header of the received message.
@param[in] Packet The IGMP message, without IP4 header.
@retval EFI_INVALID_PARAMETER The IGMP message is malformated.
@retval EFI_INVALID_PARAMETER The IGMP message is malformatted.
@retval EFI_SUCCESS The IGMP message is successfully processed.
**/

View File

@ -19,7 +19,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
otherwise the option we wants to transmit.
@retval TRUE The option is properly formatted
@retval FALSE The option is mal-formated
@retval FALSE The option is malformatted
**/
BOOLEAN

View File

@ -20,7 +20,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
/**
Validate the IP4 option format for both the packets we received
and will transmit. It will compute the ICMP error message fields
if the option is mal-formated. But this information isn't used.
if the option is malformatted. But this information isn't used.
@param[in] Option The first byte of the option
@param[in] OptionLen The length of the whole option
@ -28,7 +28,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
otherwise the option we wants to transmit.
@retval TRUE The option is properly formatted
@retval FALSE The option is mal-formated
@retval FALSE The option is malformatted
**/
BOOLEAN

View File

@ -393,7 +393,7 @@ Ip6ProcessIcmpInformation (
@param[in] Packet The content of the ICMPv6 packet with IP head
removed.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_SUCCESS The ICMPv6 message successfully processed.
@retval Others Failed to handle the ICMPv6 packet.
@ -554,7 +554,7 @@ Ip6IsAnycast (
@param[in] Pointer If not NULL, identifies the octet offset within
the invoking packet where the error was detected.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_OUT_OF_RESOURCES There is no sufficient resource to complete the
operation.
@retval EFI_SUCCESS The ICMPv6 message was successfully sent out.

View File

@ -35,7 +35,7 @@ extern EFI_IP6_ICMP_TYPE mIp6SupportedIcmp[];
@param[in] Packet The content of the ICMPv6 packet with IP head
removed.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_SUCCESS The ICMPv6 message successfully processed.
@retval Others Failed to handle the ICMPv6 packet.
@ -80,7 +80,7 @@ Ip6IsAnycast (
@param[in] Pointer If not NULL, identifies the octet offset within
the invoking packet where the error was detected.
@retval EFI_INVALID_PARAMETER The packet is malformated.
@retval EFI_INVALID_PARAMETER The packet is malformatted.
@retval EFI_OUT_OF_RESOURCES There is no sufficient resource to complete the
operation.
@retval EFI_SUCCESS The ICMPv6 message was successfully sent out.

View File

@ -2983,7 +2983,7 @@ NetLibGetNicHandle (
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Convert to IPv4 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
@retval EFI_INVALID_PARAMETER The string is malformatted or Ip4Address is NULL.
**/
EFI_STATUS
@ -3013,7 +3013,7 @@ NetLibAsciiStrToIp4 (
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
**/
EFI_STATUS
@ -3042,7 +3042,7 @@ NetLibAsciiStrToIp6 (
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Convert to IPv4 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
@retval EFI_INVALID_PARAMETER The string is malformatted or Ip4Address is NULL.
**/
EFI_STATUS
@ -3072,7 +3072,7 @@ NetLibStrToIp4 (
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
**/
EFI_STATUS
@ -3103,7 +3103,7 @@ NetLibStrToIp6 (
@param[out] PrefixLength The pointer to the converted prefix length.
@retval EFI_SUCCESS Convert to IPv6 address successfully.
@retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
@retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
**/
EFI_STATUS

View File

@ -155,7 +155,7 @@ NetStringToIp (
options on output
@param Options The option array to fill in
@retval EFI_INVALID_PARAMETER The packet is mal-formated
@retval EFI_INVALID_PARAMETER The packet is malformatted
@retval EFI_BUFFER_TOO_SMALL The Options array is too small
@retval EFI_SUCCESS The packet has been parsed into the Options array.
@ -398,7 +398,7 @@ Mtftp4ExtractMcast (
@param Operation The current performed operation.
@param MtftpOption The MTFTP4_OPTION for easy access.
@retval EFI_INVALID_PARAMETER The option is mal-formated
@retval EFI_INVALID_PARAMETER The option is malformatted
@retval EFI_UNSUPPORTED Some option isn't supported
@retval EFI_SUCCESS The option are OK and has been parsed.
@ -516,7 +516,7 @@ Mtftp4ParseOption (
@param Operation The current performed operation.
@param MtftpOption The MTFTP_OPTION for easy access.
@retval EFI_INVALID_PARAMETER The packet option is mal-formated
@retval EFI_INVALID_PARAMETER The packet option is malformatted
@retval EFI_UNSUPPORTED Some option isn't supported
@retval EFI_SUCCESS The option are OK and has been parsed.

View File

@ -70,7 +70,7 @@ Mtftp4ExtractOptions (
@param Operation The current performed operation.
@param MtftpOption The MTFTP4_OPTION for easy access.
@retval EFI_INVALID_PARAMETER The option is mal-formated
@retval EFI_INVALID_PARAMETER The option is malformatted
@retval EFI_UNSUPPORTED Some option isn't supported
@retval EFI_SUCCESS The option are OK and has been parsed.
@ -93,7 +93,7 @@ Mtftp4ParseOption (
@param Operation The current performed operation.
@param MtftpOption The MTFTP_OPTION for easy access.
@retval EFI_INVALID_PARAMETER The packet option is mal-formated
@retval EFI_INVALID_PARAMETER The packet option is malformatted
@retval EFI_UNSUPPORTED Some option isn't supported
@retval EFI_SUCCESS The option are OK and has been parsed.

View File

@ -533,7 +533,7 @@ Mtftp4RrqHandleOack (
Mtftp4SendError (
Instance,
EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,
(UINT8 *) "Mal-formated OACK packet"
(UINT8 *) "Malformatted OACK packet"
);
}

View File

@ -291,7 +291,7 @@ Mtftp4WrqHandleOack (
Mtftp4SendError (
Instance,
EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,
(UINT8 *) "Mal-formated OACK packet"
(UINT8 *) "Malformatted OACK packet"
);
}

View File

@ -517,7 +517,7 @@ Mtftp6RrqHandleOack (
Mtftp6SendError (
Instance,
EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,
(UINT8 *) "Mal-formated OACK packet"
(UINT8 *) "Malformatted OACK packet"
);
}

View File

@ -332,7 +332,7 @@ Mtftp6WrqHandleOack (
Mtftp6SendError (
Instance,
EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,
(UINT8 *) "Mal-formated OACK packet"
(UINT8 *) "Malformatted OACK packet"
);
}