Re: [edk2-devel] [PATCH 31/79] NetworkPkg: Fix a typo

Philippe Mathieu-Daudé Tue, 03 Dec 2019 09:23:05 -0800

On 12/3/19 6:18 PM, Leif Lindholm wrote:

Hi Phil,


On Tue, Dec 03, 2019 at 17:15:14 +0100, Philippe Mathieu-Daude wrote:

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

Cc: Andrew Fish <af...@apple.com>
Cc: Laszlo Ersek <ler...@redhat.com>
Cc: Leif Lindholm <leif.lindh...@linaro.org>
Cc: Michael D Kinney <michael.d.kin...@intel.com>


I would have expected:
   Jiaxin Wu <jiaxin...@intel.com>
   Siyuan Fu <siyuan...@intel.com>
   Maciej Rabeda <maciej.rab...@intel.com>
to be cc:d on NetworkPkg patches (added here).
Was there a GetMaintainer.py failure?


Human failure due to manual edition :S

Thanks for caring to Cc to correct maintainers.

/
     Leif

Signed-off-by: Philippe Mathieu-Daude <phi...@redhat.com>
---
  NetworkPkg/Dhcp4Dxe/Dhcp4Option.h        |  6 +++---
  NetworkPkg/Ip4Dxe/Ip4Icmp.h              |  2 +-
  NetworkPkg/Ip4Dxe/Ip4Igmp.h              |  2 +-
  NetworkPkg/Ip4Dxe/Ip4Option.h            |  4 ++--
  NetworkPkg/Ip6Dxe/Ip6Icmp.h              |  4 ++--
  NetworkPkg/Mtftp4Dxe/Mtftp4Option.h      |  4 ++--
  NetworkPkg/Dhcp4Dxe/Dhcp4Option.c        | 10 +++++-----
  NetworkPkg/Ip4Dxe/Ip4Icmp.c              |  2 +-
  NetworkPkg/Ip4Dxe/Ip4Igmp.c              |  2 +-
  NetworkPkg/Ip4Dxe/Ip4Option.c            |  2 +-
  NetworkPkg/Ip6Dxe/Ip6Icmp.c              |  4 ++--
  NetworkPkg/Library/DxeNetLib/DxeNetLib.c | 10 +++++-----
  NetworkPkg/Mtftp4Dxe/Mtftp4Option.c      |  6 +++---
  NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c         |  2 +-
  NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c         |  2 +-
  NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c         |  2 +-
  NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c         |  2 +-
  17 files changed, 33 insertions(+), 33 deletions(-)

diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h 
b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
index 9e25386507ed..393176c8996d 100644
--- a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
+++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
@@ -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.

**/

diff --git a/NetworkPkg/Ip4Dxe/Ip4Icmp.h b/NetworkPkg/Ip4Dxe/Ip4Icmp.h
index 922886a96e67..a52200176f5a 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Icmp.h
+++ b/NetworkPkg/Ip4Dxe/Ip4Icmp.h
@@ -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.

diff --git a/NetworkPkg/Ip4Dxe/Ip4Igmp.h b/NetworkPkg/Ip4Dxe/Ip4Igmp.h

index 0cc944594441..49c13ba3a7a0 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Igmp.h
+++ b/NetworkPkg/Ip4Dxe/Ip4Igmp.h
@@ -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.

**/

diff --git a/NetworkPkg/Ip4Dxe/Ip4Option.h b/NetworkPkg/Ip4Dxe/Ip4Option.h
index 57a5a58725f0..a39fd2b4c69d 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Option.h
+++ b/NetworkPkg/Ip4Dxe/Ip4Option.h
@@ -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
diff --git a/NetworkPkg/Ip6Dxe/Ip6Icmp.h b/NetworkPkg/Ip6Dxe/Ip6Icmp.h
index 49a65f296adb..c63adb009519 100644
--- a/NetworkPkg/Ip6Dxe/Ip6Icmp.h
+++ b/NetworkPkg/Ip6Dxe/Ip6Icmp.h
@@ -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.
diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h 
b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h
index fcc4cbe8fdef..7bfe706f88c6 100644
--- a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h
+++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h
@@ -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.

diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c

index 3adbf55d0612..3b077de11177 100644
--- a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c
+++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c
@@ -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.

**/

diff --git a/NetworkPkg/Ip4Dxe/Ip4Icmp.c b/NetworkPkg/Ip4Dxe/Ip4Icmp.c
index 052d6b77f79a..833ffa74ff0d 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Icmp.c
+++ b/NetworkPkg/Ip4Dxe/Ip4Icmp.c
@@ -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.

diff --git a/NetworkPkg/Ip4Dxe/Ip4Igmp.c b/NetworkPkg/Ip4Dxe/Ip4Igmp.c

index 41d9bce9717e..e69b2fe7fc08 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Igmp.c
+++ b/NetworkPkg/Ip4Dxe/Ip4Igmp.c
@@ -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.

**/

diff --git a/NetworkPkg/Ip4Dxe/Ip4Option.c b/NetworkPkg/Ip4Dxe/Ip4Option.c
index f1c10014e85c..b3c598c64a38 100644
--- a/NetworkPkg/Ip4Dxe/Ip4Option.c
+++ b/NetworkPkg/Ip4Dxe/Ip4Option.c
@@ -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
diff --git a/NetworkPkg/Ip6Dxe/Ip6Icmp.c b/NetworkPkg/Ip6Dxe/Ip6Icmp.c
index 79fa34e0413f..bf9b17d907ef 100644
--- a/NetworkPkg/Ip6Dxe/Ip6Icmp.c
+++ b/NetworkPkg/Ip6Dxe/Ip6Icmp.c
@@ -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.
diff --git a/NetworkPkg/Library/DxeNetLib/DxeNetLib.c 
b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
index a39c20be3d34..4f8a1226dae7 100644
--- a/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
+++ b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
@@ -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
diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c 
b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c
index d97f157f1744..013fe008eee8 100644
--- a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c
+++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c
@@ -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.

diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c

index 24c965afb580..8e1338221b12 100644
--- a/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c
+++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c
@@ -533,7 +533,7 @@ Mtftp4RrqHandleOack (
        Mtftp4SendError (
          Instance,
          EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,
-        (UINT8 *) "Mal-formated OACK packet"
+        (UINT8 *) "Malformatted OACK packet"
          );
      }

diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c

index 14156b801ee6..bd13244b999b 100644
--- a/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c
+++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c
@@ -291,7 +291,7 @@ Mtftp4WrqHandleOack (
        Mtftp4SendError (
          Instance,
          EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,
-        (UINT8 *) "Mal-formated OACK packet"
+        (UINT8 *) "Malformatted OACK packet"
          );
      }

diff --git a/NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c b/NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c

index 897358e5f133..a830d432916c 100644
--- a/NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c
+++ b/NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c
@@ -517,7 +517,7 @@ Mtftp6RrqHandleOack (
        Mtftp6SendError (
          Instance,
          EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,
-        (UINT8 *) "Mal-formated OACK packet"
+        (UINT8 *) "Malformatted OACK packet"
          );
      }

diff --git a/NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c b/NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c

index 2860f3870206..ce3315cc2c26 100644
--- a/NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c
+++ b/NetworkPkg/Mtftp6Dxe/Mtftp6Wrq.c
@@ -332,7 +332,7 @@ Mtftp6WrqHandleOack (
        Mtftp6SendError (
          Instance,
          EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION,
-        (UINT8 *) "Mal-formated OACK packet"
+        (UINT8 *) "Malformatted OACK packet"
          );
      }

--

2.21.0



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#51652): https://edk2.groups.io/g/devel/message/51652
Mute This Topic: https://groups.io/mt/65773783/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 31/79] NetworkPkg: Fix a typo

Reply via email to