From 86ac8fb256fe0716f6d06c1f6a4a7f93483b4837 Mon Sep 17 00:00:00 2001 From: Gary Lin Date: Wed, 19 Oct 2016 15:01:24 +0800 Subject: [PATCH] MdeModulePkg/Include: Fix typos in comments - opints -> points - sucessfully -> successfully - suported -> supported - hexidecimal -> hexadecimal - TURE -> TRUE - servity -> severity - Moudle -> Module - contiue -> continue - infomation -> information - malformated -> malformatted - Pepresentation -> Representation - opeque -> opaque - assocated -> associated - Libary -> Library - descrption -> description - paramter -> parameter - chracter -> character Cc: Feng Tian Cc: Star Zeng Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Gary Lin Reviewed-by: Feng Tian Reviewed-by: Star Zeng --- .../Include/Library/CustomizedDisplayLib.h | 2 +- MdeModulePkg/Include/Library/DebugAgentLib.h | 4 +-- MdeModulePkg/Include/Library/HiiLib.h | 16 +++++----- MdeModulePkg/Include/Library/NetLib.h | 32 +++++++++---------- MdeModulePkg/Include/Ppi/AtaController.h | 2 +- 5 files changed, 28 insertions(+), 28 deletions(-) diff --git a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h index 31e1091e88..1689e2c4f6 100644 --- a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h +++ b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h @@ -202,7 +202,7 @@ PrintStringAtWithWidth ( ); /** - Prints a chracter to the default console, at + Prints a character to the default console, at the supplied cursor position, using L"%c" format. @param Column The cursor position to print the string at. When it is -1, use current Position. diff --git a/MdeModulePkg/Include/Library/DebugAgentLib.h b/MdeModulePkg/Include/Library/DebugAgentLib.h index 01b06a73fb..63d1c8f180 100644 --- a/MdeModulePkg/Include/Library/DebugAgentLib.h +++ b/MdeModulePkg/Include/Library/DebugAgentLib.h @@ -39,7 +39,7 @@ typedef struct { /** Caller provided function to be invoked at the end of InitializeDebugAgent(). - Refer to the descrption for InitializeDebugAgent() for more details. + Refer to the description for InitializeDebugAgent() for more details. @param[in] Context The first input parameter of InitializeDebugAgent(). @@ -61,7 +61,7 @@ VOID function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is responsible to invoke the passing-in function at the end of InitializeDebugAgent(). - If the parameter Function is not NULL, Debug Agent Libary instance will invoke it by + If the parameter Function is not NULL, Debug Agent Library instance will invoke it by passing in the Context to be its parameter. If Function() is NULL, Debug Agent Library instance will return after setup debug diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h index 4ad4cf133f..3d87677b2f 100644 --- a/MdeModulePkg/Include/Library/HiiLib.h +++ b/MdeModulePkg/Include/Library/HiiLib.h @@ -230,13 +230,13 @@ HiiGetHiiHandles ( for freeing the allocated buffer using FreePool(). @param Handle The HII handle. - @param Buffer On return, opints to a pointer which point to the buffer that contain the formset opcode. + @param Buffer On return, points to a pointer which point to the buffer that contain the formset opcode. @param BufferSize On return, points to the length of the buffer. @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated. @retval EFI_NOT_FOUND Can't find the package data for the input Handle. @retval EFI_INVALID_PARAMETER The input parameters are not correct. - @retval EFI_SUCCESS Get the formset opcode from the hii handle sucessfully. + @retval EFI_SUCCESS Get the formset opcode from the hii handle successfully. **/ EFI_STATUS @@ -259,9 +259,9 @@ HiiGetFormSetFromHiiHandle( @param[in] HiiHandle A handle that was previously registered in the HII Database. @retval NULL HiiHandle is not registered in the HII database - @retval NULL There are not enough resources available to retrieve the suported + @retval NULL There are not enough resources available to retrieve the supported languages. - @retval NULL The list of suported languages could not be retrieved. + @retval NULL The list of supported languages could not be retrieved. @retval Other A pointer to the Null-terminated ASCII string of supported languages. **/ @@ -284,17 +284,17 @@ HiiGetSupportedLanguages ( @param[in] Guid The pointer to an EFI_GUID that is the routing information GUID. Each of the 16 bytes in Guid is converted to - a 2 Unicode character hexidecimal string. This is + a 2 Unicode character hexadecimal string. This is an optional parameter that may be NULL. @param[in] Name The pointer to a Null-terminated Unicode string that is the routing information NAME. This is an optional parameter that may be NULL. Each 16-bit Unicode character in Name is converted to a 4 character Unicode - hexidecimal string. + hexadecimal string. @param[in] DriverHandle The driver handle that supports a Device Path Protocol that is the routing information PATH. Each byte of the Device Path associated with DriverHandle is converted - to a two (Unicode) character hexidecimal string. + to a two (Unicode) character hexadecimal string. @retval NULL DriverHandle does not support the Device Path Protocol. @retval NULL DriverHandle does not support the Device Path Protocol. @@ -322,7 +322,7 @@ HiiConstructConfigHdr ( entirety of the current HII database will be reset. @param DefaultId Specifies the type of defaults to retrieve. - @retval TURE The default value was set successfully. + @retval TRUE The default value was set successfully. @retval FALSE The default value was not found. **/ BOOLEAN diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h index 87f393e2de..c5c0fc212b 100644 --- a/MdeModulePkg/Include/Library/NetLib.h +++ b/MdeModulePkg/Include/Library/NetLib.h @@ -252,7 +252,7 @@ typedef struct { // // The debug level definition. This value is also used as the -// syslog's servity level. Don't change it. +// syslog's severity level. Don't change it. // #define NETDEBUG_LEVEL_TRACE 5 #define NETDEBUG_LEVEL_WARNING 4 @@ -335,8 +335,8 @@ NetDebugASPrint ( This function will locate a instance of SNP then send the message through it. Because it isn't open the SNP BY_DRIVER, apply caution when using it. - @param Level The servity level of the message. - @param Module The Moudle that generates the log. + @param Level The severity level of the message. + @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. @@ -750,7 +750,7 @@ NetDestroyLinkList ( @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL if NumberOfChildren is 0. - @retval TURE Found the input Handle in ChildHandleBuffer. + @retval TRUE Found the input Handle in ChildHandleBuffer. @retval FALSE Can't find the input Handle in ChildHandleBuffer. **/ @@ -1008,7 +1008,7 @@ EFI_STATUS /** Iterate through the netmap and call CallBack for each item. - It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break + It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break from the loop. It returns the CallBack's last return value. This function is delete safe for the current item. @@ -1308,7 +1308,7 @@ NetLibCreateIPv6DPathNode ( needs to find its own private data that is related the IP's service binding instance that is installed on the UNDI/SNP handle. The controller is then either an MNP or an ARP child handle. Note that - IP opens these handles using BY_DRIVER. Use that infomation to get the + IP opens these handles using BY_DRIVER. Use that information to get the UNDI/SNP handle. @param[in] Controller The protocol handle to check. @@ -1349,7 +1349,7 @@ NetLibDefaultUnload ( @param[out] Ip4Address The pointer to the converted IPv4 address. @retval EFI_SUCCESS Converted to an IPv4 address successfully. - @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL. + @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL. **/ EFI_STATUS @@ -1361,13 +1361,13 @@ NetLibAsciiStrToIp4 ( /** Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the - string is defined in RFC 4291 - Text Pepresentation of Addresses. + string is defined in RFC 4291 - Text Representation of Addresses. @param[in] String The pointer to the Ascii string. @param[out] Ip6Address The pointer to the converted IPv6 address. @retval EFI_SUCCESS Converted to an IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL. + @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL. **/ EFI_STATUS @@ -1384,7 +1384,7 @@ NetLibAsciiStrToIp6 ( @param[out] Ip4Address The pointer to the converted IPv4 address. @retval EFI_SUCCESS Converted to an IPv4 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL. + @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL. @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources. **/ @@ -1397,13 +1397,13 @@ NetLibStrToIp4 ( /** Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of - the string is defined in RFC 4291 - Text Pepresentation of Addresses. + the string is defined in RFC 4291 - Text Representation of Addresses. @param[in] String The pointer to the Ascii string. @param[out] Ip6Address The pointer to the converted IPv6 address. @retval EFI_SUCCESS Converted to an IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL. + @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL. @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources. **/ @@ -1416,7 +1416,7 @@ NetLibStrToIp6 ( /** Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. - The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses + The format of the string is defined in RFC 4291 - Text Representation of Addresses Prefixes: ipv6-address/prefix-length. @param[in] String The pointer to the Ascii string. @@ -1424,7 +1424,7 @@ NetLibStrToIp6 ( @param[out] PrefixLength The pointer to the converted prefix length. @retval EFI_SUCCESS Converted to an IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL. + @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL. @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources. **/ @@ -1493,9 +1493,9 @@ typedef struct { UINT32 Signature; INTN RefCnt; // Reference count to share NET_VECTOR. NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR - VOID *Arg; // opeque argument to Free + VOID *Arg; // opaque argument to Free UINT32 Flag; // Flags, NET_VECTOR_OWN_FIRST - UINT32 Len; // Total length of the assocated BLOCKs + UINT32 Len; // Total length of the associated BLOCKs UINT32 BlockNum; NET_BLOCK Block[1]; diff --git a/MdeModulePkg/Include/Ppi/AtaController.h b/MdeModulePkg/Include/Ppi/AtaController.h index aa4ae56d04..2333bef6aa 100644 --- a/MdeModulePkg/Include/Ppi/AtaController.h +++ b/MdeModulePkg/Include/Ppi/AtaController.h @@ -106,7 +106,7 @@ typedef struct { @param[in] PeiServices The pointer to the PEI Services Table. @param[in] This The pointer to this instance of the PEI_ATA_CONTROLLER_PPI. @param[in] ChannelMask The bitmask that identifies the IDE and SATA channels to - enable or disable. This paramter is optional. + enable or disable. This parameter is optional. @retval EFI_SUCCESS The IDE or SATA channels were enabled or disabled successfully. @retval EFI_DEVICE_ERROR The IDE or SATA channels could not be enabled or disabled. -- 2.39.2