]> git.proxmox.com Git - mirror_edk2.git/commitdiff
NetworkPkg: Fix a typo
authorPhilippe Mathieu-Daudé <philmd@redhat.com>
Fri, 7 Feb 2020 01:07:42 +0000 (02:07 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
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>

17 files changed:
NetworkPkg/Dhcp4Dxe/Dhcp4Option.c
NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
NetworkPkg/Ip4Dxe/Ip4Icmp.c
NetworkPkg/Ip4Dxe/Ip4Icmp.h
NetworkPkg/Ip4Dxe/Ip4Igmp.c
NetworkPkg/Ip4Dxe/Ip4Igmp.h
NetworkPkg/Ip4Dxe/Ip4Option.c
NetworkPkg/Ip4Dxe/Ip4Option.h
NetworkPkg/Ip6Dxe/Ip6Icmp.c
NetworkPkg/Ip6Dxe/Ip6Icmp.h
NetworkPkg/Library/DxeNetLib/DxeNetLib.c
NetworkPkg/Mtftp4Dxe/Mtftp4Option.c
NetworkPkg/Mtftp4Dxe/Mtftp4Option.h
NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c
NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c
NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c
NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c

index 3adbf55d06124ddd0c104b1b0a957ea7bd752b80..3b077de111779d4e79bb806ef6c86c631b66d6c5 100644 (file)
@@ -230,7 +230,7 @@ DhcpOptionIsValid (
   @param[out] Para                   The variable to save the interested parameter\r
 \r
   @retval EFI_SUCCESS            The DHCP option is successfully extracted.\r
-  @retval EFI_INVALID_PARAMETER  The DHCP option is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The DHCP option is malformatted\r
 \r
 **/\r
 EFI_STATUS\r
@@ -303,7 +303,7 @@ DhcpGetParameter (
                                      option.\r
 \r
   @retval EFI_SUCCESS            All the options are valid\r
-  @retval EFI_INVALID_PARAMETER  The options are mal-formated.\r
+  @retval EFI_INVALID_PARAMETER  The options are malformatted.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -538,7 +538,7 @@ DhcpFillOption (
 \r
   @retval EFI_NOT_FOUND          Cannot find any option.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to parse the packet.\r
-  @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options are malformatted\r
   @retval EFI_SUCCESS            The options are parsed into OptionPoint\r
 \r
 **/\r
@@ -639,7 +639,7 @@ ON_EXIT:
   @param[out] Para                   The variable to save the DHCP parameters.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to validate the packet.\r
-  @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options are malformatted\r
   @retval EFI_SUCCESS            The options are parsed into OptionPoint\r
 \r
 **/\r
@@ -770,7 +770,7 @@ DhcpAppendOption (
                                      function.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory\r
-  @retval EFI_INVALID_PARAMETER  The options in SeekPacket are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options in SeekPacket are malformatted\r
   @retval EFI_SUCCESS            The packet is build.\r
 \r
 **/\r
index 9e25386507edb4ffe81a035e5294f38424b992d1..393176c8996d48c0c135f65065383748b32f2d31 100644 (file)
@@ -133,7 +133,7 @@ DhcpIterateOptions (
   @param[out] Para                   The variable to save the DHCP parameters.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to validate the packet.\r
-  @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options are malformatted\r
   @retval EFI_SUCCESS            The options are parsed into OptionPoint\r
 \r
 **/\r
@@ -167,7 +167,7 @@ DhcpValidateOptions (
 \r
   @retval EFI_NOT_FOUND          Cannot find any option.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to parse the packet.\r
-  @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options are malformatted\r
   @retval EFI_SUCCESS            The options are parsed into OptionPoint\r
 \r
 **/\r
@@ -211,7 +211,7 @@ DhcpAppendOption (
                                      function.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory\r
-  @retval EFI_INVALID_PARAMETER  The options in SeekPacket are mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The options in SeekPacket are malformatted\r
   @retval EFI_SUCCESS            The packet is build.\r
 \r
 **/\r
index 052d6b77f79a08186f11c65f79df674049259760..833ffa74ff0dd25199cc6076f67de65bf21adf0b 100644 (file)
@@ -319,7 +319,7 @@ Ip4ProcessIcmpQuery (
   @param[in]  Packet             The content of the ICMP query with IP4 head\r
                                  removed.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_SUCCESS            The ICMP message is successfully processed.\r
   @retval Others                 Failed to handle ICMP packet.\r
 \r
index 922886a96e67a61886405779b77bb4c3631885f6..a52200176f5ad5b002046742932dba5d1cdfb4d2 100644 (file)
@@ -83,7 +83,7 @@ extern EFI_IP4_ICMP_TYPE  mIp4SupportedIcmp[];
   @param[in]  Packet             The content of the ICMP query with IP4 head\r
                                  removed.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_SUCCESS            The ICMP message is successfully processed.\r
   @retval Others                 Failed to handle ICMP packet.\r
 \r
index 41d9bce9717ef4a2749df2a558e66eddd4832765..e69b2fe7fc0868c0d4600a63c48755d30995af0a 100644 (file)
@@ -401,7 +401,7 @@ Ip4LeaveGroup (
   @param[in]  Head               The IP4 header of the received message.\r
   @param[in]  Packet             The IGMP message, without IP4 header.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The IGMP message is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The IGMP message is malformatted.\r
   @retval EFI_SUCCESS            The IGMP message is successfully processed.\r
 \r
 **/\r
index 0cc9445944415a0fbf041693d2fd1c4ee8a11c37..49c13ba3a7a0f80a78af3d7a295d9d2769e96567 100644 (file)
@@ -111,7 +111,7 @@ Ip4LeaveGroup (
   @param[in]  Head               The IP4 header of the received message.\r
   @param[in]  Packet             The IGMP message, without IP4 header.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The IGMP message is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The IGMP message is malformatted.\r
   @retval EFI_SUCCESS            The IGMP message is successfully processed.\r
 \r
 **/\r
index f1c10014e85c35f35e65e00849eff4eb1635fef3..b3c598c64a38c7887e1ea68922f7fae288955962 100644 (file)
@@ -19,7 +19,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
                                 otherwise the option we wants to transmit.\r
 \r
   @retval TRUE     The option is properly formatted\r
-  @retval FALSE    The option is mal-formated\r
+  @retval FALSE    The option is malformatted\r
 \r
 **/\r
 BOOLEAN\r
index 57a5a58725f0e8ed417417f3fb7e2533a1423977..a39fd2b4c69d338909e835881f84a7fead5ad280 100644 (file)
@@ -20,7 +20,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 /**\r
   Validate the IP4 option format for both the packets we received\r
   and will transmit. It will compute the ICMP error message fields\r
-  if the option is mal-formated. But this information isn't used.\r
+  if the option is malformatted. But this information isn't used.\r
 \r
   @param[in]  Option            The first byte of the option\r
   @param[in]  OptionLen         The length of the whole option\r
@@ -28,7 +28,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
                                 otherwise the option we wants to transmit.\r
 \r
   @retval TRUE     The option is properly formatted\r
-  @retval FALSE    The option is mal-formated\r
+  @retval FALSE    The option is malformatted\r
 \r
 **/\r
 BOOLEAN\r
index 79fa34e0413fa3b02ef9e1973e7af2fdc397075d..bf9b17d907ef1521bc592aa219dd42925943418f 100644 (file)
@@ -393,7 +393,7 @@ Ip6ProcessIcmpInformation (
   @param[in]  Packet             The content of the ICMPv6 packet with IP head\r
                                  removed.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_SUCCESS            The ICMPv6 message successfully processed.\r
   @retval Others                 Failed to handle the ICMPv6 packet.\r
 \r
@@ -554,7 +554,7 @@ Ip6IsAnycast (
   @param[in]  Pointer            If not NULL, identifies the octet offset within\r
                                  the invoking packet where the error was detected.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to complete the\r
                                  operation.\r
   @retval EFI_SUCCESS            The ICMPv6 message was successfully sent out.\r
index 49a65f296adb5ec62c406932e69bdded6e7176e8..c63adb00951958cc30b5623f91052c9f5c6f82b3 100644 (file)
@@ -35,7 +35,7 @@ extern EFI_IP6_ICMP_TYPE  mIp6SupportedIcmp[];
   @param[in]  Packet             The content of the ICMPv6 packet with IP head\r
                                  removed.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_SUCCESS            The ICMPv6 message successfully processed.\r
   @retval Others                 Failed to handle the ICMPv6 packet.\r
 \r
@@ -80,7 +80,7 @@ Ip6IsAnycast (
   @param[in]  Pointer            If not NULL, identifies the octet offset within\r
                                  the invoking packet where the error was detected.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
   @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to complete the\r
                                  operation.\r
   @retval EFI_SUCCESS            The ICMPv6 message was successfully sent out.\r
index a39c20be3d348dc87078fd4a227e6312bd7cfddd..4f8a1226dae7bdd9c988164cdef0b41fb2540fcd 100644 (file)
@@ -2983,7 +2983,7 @@ NetLibGetNicHandle (
   @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
 \r
   @retval EFI_SUCCESS            Convert to IPv4 address successfully.\r
-  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The string is malformatted or Ip4Address is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3013,7 +3013,7 @@ NetLibAsciiStrToIp4 (
   @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
 \r
   @retval EFI_SUCCESS            Convert to IPv6 address successfully.\r
-  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The string is malformatted or Ip6Address is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3042,7 +3042,7 @@ NetLibAsciiStrToIp6 (
   @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
 \r
   @retval EFI_SUCCESS            Convert to IPv4 address successfully.\r
-  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The string is malformatted or Ip4Address is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3072,7 +3072,7 @@ NetLibStrToIp4 (
   @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
 \r
   @retval EFI_SUCCESS            Convert to IPv6 address successfully.\r
-  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The string is malformatted or Ip6Address is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -3103,7 +3103,7 @@ NetLibStrToIp6 (
   @param[out]     PrefixLength   The pointer to the converted prefix length.\r
 \r
   @retval EFI_SUCCESS            Convert to IPv6 address successfully.\r
-  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_INVALID_PARAMETER  The string is malformatted or Ip6Address is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
index d97f157f174472811bfc6cedf3c1727628e7801c..013fe008eee8a4802692c0e8ccdb7562bd7f34f0 100644 (file)
@@ -155,7 +155,7 @@ NetStringToIp (
                                  options on output\r
   @param  Options                The option array to fill in\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The packet is malformatted\r
   @retval EFI_BUFFER_TOO_SMALL   The Options array is too small\r
   @retval EFI_SUCCESS            The packet has been parsed into the Options array.\r
 \r
@@ -398,7 +398,7 @@ Mtftp4ExtractMcast (
   @param  Operation              The current performed operation.\r
   @param  MtftpOption            The MTFTP4_OPTION for easy access.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The option is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The option is malformatted\r
   @retval EFI_UNSUPPORTED        Some option isn't supported\r
   @retval EFI_SUCCESS            The option are OK and has been parsed.\r
 \r
@@ -516,7 +516,7 @@ Mtftp4ParseOption (
   @param  Operation              The current performed operation.\r
   @param  MtftpOption            The MTFTP_OPTION for easy access.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet option is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The packet option is malformatted\r
   @retval EFI_UNSUPPORTED        Some option isn't supported\r
   @retval EFI_SUCCESS            The option are OK and has been parsed.\r
 \r
index fcc4cbe8fdefc6cf5ebde9b096ae73abecd58fcf..7bfe706f88c673efafefa8d16e56a344a75c385d 100644 (file)
@@ -70,7 +70,7 @@ Mtftp4ExtractOptions (
   @param  Operation              The current performed operation.\r
   @param  MtftpOption            The MTFTP4_OPTION for easy access.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The option is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The option is malformatted\r
   @retval EFI_UNSUPPORTED        Some option isn't supported\r
   @retval EFI_SUCCESS            The option are OK and has been parsed.\r
 \r
@@ -93,7 +93,7 @@ Mtftp4ParseOption (
   @param  Operation              The current performed operation.\r
   @param  MtftpOption            The MTFTP_OPTION for easy access.\r
 \r
-  @retval EFI_INVALID_PARAMETER  The packet option is mal-formated\r
+  @retval EFI_INVALID_PARAMETER  The packet option is malformatted\r
   @retval EFI_UNSUPPORTED        Some option isn't supported\r
   @retval EFI_SUCCESS            The option are OK and has been parsed.\r
 \r
index 24c965afb5807771b1bbb8b520d0fce5189171ef..8e1338221b122e9f14de8cf78184477929087282 100644 (file)
@@ -533,7 +533,7 @@ Mtftp4RrqHandleOack (
       Mtftp4SendError (\r
         Instance,\r
         EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
-        (UINT8 *) "Mal-formated OACK packet"\r
+        (UINT8 *) "Malformatted OACK packet"\r
         );\r
     }\r
 \r
index 14156b801ee6dbbb7e56550cc3d0d310d580e41c..bd13244b999b0230fa77bafba038418fe0f89600 100644 (file)
@@ -291,7 +291,7 @@ Mtftp4WrqHandleOack (
       Mtftp4SendError (\r
         Instance,\r
         EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
-        (UINT8 *) "Mal-formated OACK packet"\r
+        (UINT8 *) "Malformatted OACK packet"\r
         );\r
     }\r
 \r
index 897358e5f13378740820549eceedf875807c5ff7..a830d432916cd2e29858bb9d22afcf9ae76d2b6a 100644 (file)
@@ -517,7 +517,7 @@ Mtftp6RrqHandleOack (
       Mtftp6SendError (\r
         Instance,\r
         EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,\r
-        (UINT8 *) "Mal-formated OACK packet"\r
+        (UINT8 *) "Malformatted OACK packet"\r
         );\r
     }\r
 \r
index 2860f38702060fff7a1469bb57222388a36c8a1d..ce3315cc2c26b3ace023c0b2fb58bfe615dff7ce 100644 (file)
@@ -332,7 +332,7 @@ Mtftp6WrqHandleOack (
       Mtftp6SendError (\r
         Instance,\r
         EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,\r
-        (UINT8 *) "Mal-formated OACK packet"\r
+        (UINT8 *) "Malformatted OACK packet"\r
         );\r
     }\r
 \r