From 74cdb367addc883595359c57c38d7cc465c88ea1 Mon Sep 17 00:00:00 2001 From: Gary Lin Date: Wed, 19 Oct 2016 15:01:36 +0800 Subject: [PATCH] SourceLevelDebugPkg: Fix typos in comments - descrption -> description - Libary -> Library - funciton -> function - paramter -> parameter - triggerred -> triggered - hanlde -> handle Cc: Jeff Fan Cc: Hao Wu Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Gary Lin Reviewed-by: Hao Wu Reviewed-by: Jeff Fan --- .../Include/Library/DebugCommunicationLib.h | 8 ++++---- .../DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c | 6 +++--- .../DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h | 4 ++-- .../DebugCommunicationLibSerialPort.c | 4 ++-- .../DebugCommunicationLibUsb/DebugCommunicationLibUsb.c | 4 ++-- .../DebugCommunicationLibUsb3Common.c | 6 +++--- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h index 0c1a7b0260..b2042841d2 100644 --- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h +++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h @@ -20,10 +20,10 @@ typedef VOID * DEBUG_PORT_HANDLE; /** Caller provided function to be invoked at the end of DebugPortInitialize(). - Refer to the descrption for DebugPortInitialize() for more details. + Refer to the description for DebugPortInitialize() for more details. @param[in] Context The first input argument of DebugPortInitialize(). - @param[in] DebugPortHandle Debug port handle created by Debug Communication Libary. + @param[in] DebugPortHandle Debug port handle created by Debug Communication Library. **/ typedef @@ -41,9 +41,9 @@ VOID stack, this function must work on the mode that doesn't return to the caller, then the caller needs to wrap up all rest of logic after DebugPortInitialize() into one function and pass it into DebugPortInitialize(). DebugPortInitialize() is - responsible to invoke the passing-in funciton at the end of DebugPortInitialize(). + responsible to invoke the passing-in function at the end of DebugPortInitialize(). - If the paramter Function is not NULL, Debug Communication Libary instance will + If the parameter Function is not NULL, Debug Communication Library instance will invoke it by passing in the Context to be the first parameter. Debug Communication Library instance could create one debug port handle to be the second parameter passing into the Function. Debug Communication Library instance also could pass diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c index faec574fa4..128c69f60c 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c +++ b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c @@ -343,7 +343,7 @@ DebugAgentCallbackMemoryDiscoveredPpi ( 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 @@ -648,10 +648,10 @@ InitializeDebugAgent ( /** Caller provided function to be invoked at the end of DebugPortInitialize(). - Refer to the descrption for DebugPortInitialize() for more details. + Refer to the description for DebugPortInitialize() for more details. @param[in] Context The first input argument of DebugPortInitialize(). - @param[in] DebugPortHandle Debug port handle created by Debug Communication Libary. + @param[in] DebugPortHandle Debug port handle created by Debug Communication Library. **/ VOID diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h index a0687fa173..300bc35c40 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h +++ b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h @@ -30,10 +30,10 @@ typedef struct { /** Caller provided function to be invoked at the end of DebugPortInitialize(). - Refer to the descrption for DebugPortInitialize() for more details. + Refer to the description for DebugPortInitialize() for more details. @param[in] Context The first input argument of DebugPortInitialize(). - @param[in] DebugPortHandle Debug port handle created by Debug Communication Libary. + @param[in] DebugPortHandle Debug port handle created by Debug Communication Library. **/ VOID diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c index 388286b406..6a854ff2a2 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c @@ -26,9 +26,9 @@ stack, this function must work on the mode that doesn't return to the caller, then the caller needs to wrap up all rest of logic after DebugPortInitialize() into one function and pass it into DebugPortInitialize(). DebugPortInitialize() is - responsible to invoke the passing-in funciton at the end of DebugPortInitialize(). + responsible to invoke the passing-in function at the end of DebugPortInitialize(). - If the paramter Function is not NULL, Debug Communication Libary instance will + If the parameter Function is not NULL, Debug Communication Library instance will invoke it by passing in the Context to be the first parameter. Debug Communication Library instance could create one debug port handle to be the second parameter passing into the Function. Debug Communication Library instance also could pass diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c index a08a260359..d7829c2110 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c @@ -511,7 +511,7 @@ UsbDebugPortControlTransfer ( Check if it needs to re-initialize usb debug port hardware. During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check - whether the usb debug port hardware configuration is changed. Such case can be triggerred by + whether the usb debug port hardware configuration is changed. Such case can be triggered by Pci bus resource allocation and so on. @param Handle Debug port handle. @@ -1007,7 +1007,7 @@ DebugPortPollBuffer ( /** Initialize the debug port. - If Function is not NULL, Debug Communication Libary will call this function + If Function is not NULL, Debug Communication Library will call this function by passing in the Context to be the first parameter. If needed, Debug Communication Library will create one debug port handle to be the second argument passing in calling the Function, otherwise it will pass NULL to be the second argument of diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c index 7c62bdadfb..04e25e3ec2 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c @@ -300,7 +300,7 @@ Done: Check if it needs to re-initialize usb debug port hardware. During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check - whether the usb debug port hardware configuration is changed. Such case can be triggerred by + whether the usb debug port hardware configuration is changed. Such case can be triggered by Pci bus resource allocation and so on. @param Handle Debug port handle. @@ -989,7 +989,7 @@ DebugPortPollBuffer ( /** Initialize the debug port. - If Function is not NULL, Debug Communication Libary will call this function + If Function is not NULL, Debug Communication Library will call this function by passing in the Context to be the first parameter. If needed, Debug Communication Library will create one debug port handle to be the second argument passing in calling the Function, otherwise it will pass NULL to be the second argument of @@ -997,7 +997,7 @@ DebugPortPollBuffer ( If Function is NULL, and Context is not NULL, the Debug Communication Library could a) Return the same handle as passed in (as Context parameter). - b) Ignore the input Context parameter and create new hanlde to be returned. + b) Ignore the input Context parameter and create new handle to be returned. If parameter Function is NULL and Context is NULL, Debug Communication Library could created a new handle if needed and return it, otherwise it will return NULL. -- 2.39.2