sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SourceLevelDebugPkg: Fix typos in comments

Browse Source 
- descrption -> description
- Libary -> Library
- funciton -> function
- paramter -> parameter
- triggerred -> triggered
- hanlde -> handle

Cc: Jeff Fan <jeff.fan@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Gary Lin <glin@suse.com>
Reviewed-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Jeff Fan <jeff.fan@intel.com>
This commit is contained in:
Gary Lin
2016-10-19 15:01:36 +08:00
committed by Jeff Fan
parent 438f17665c
commit 74cdb367ad
6 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
View File

@ -20,10 +20,10 @@ typedef VOID * DEBUG_PORT_HANDLE;
/** /**
Caller provided function to be invoked at the end of DebugPortInitialize(). 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] 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 typedef
@ -41,9 +41,9 @@ VOID
stack, this function must work on the mode that doesn't return to the caller, then 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 the caller needs to wrap up all rest of logic after DebugPortInitialize() into one
function and pass it into DebugPortInitialize(). DebugPortInitialize() is 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 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 Library instance could create one debug port handle to be the second parameter
passing into the Function. Debug Communication Library instance also could pass passing into the Function. Debug Communication Library instance also could pass

6
SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c
View File

@ -343,7 +343,7 @@ DebugAgentCallbackMemoryDiscoveredPpi (
function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is
responsible to invoke the passing-in function at the end of InitializeDebugAgent(). 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. passing in the Context to be its parameter.
If Function() is NULL, Debug Agent Library instance will return after setup debug 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(). 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] 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 VOID

4
SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h
View File

@ -30,10 +30,10 @@ typedef struct {
/** /**
Caller provided function to be invoked at the end of DebugPortInitialize(). 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] 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 VOID

4
SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c
View File

@ -26,9 +26,9 @@
stack, this function must work on the mode that doesn't return to the caller, then 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 the caller needs to wrap up all rest of logic after DebugPortInitialize() into one
function and pass it into DebugPortInitialize(). DebugPortInitialize() is 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 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 Library instance could create one debug port handle to be the second parameter
passing into the Function. Debug Communication Library instance also could pass passing into the Function. Debug Communication Library instance also could pass

4
SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c
View File

@ -511,7 +511,7 @@ UsbDebugPortControlTransfer (
Check if it needs to re-initialize usb debug port hardware. 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 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. Pci bus resource allocation and so on.
@param Handle Debug port handle. @param Handle Debug port handle.
@ -1007,7 +1007,7 @@ DebugPortPollBuffer (
/** /**
Initialize the debug port. 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 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 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 calling the Function, otherwise it will pass NULL to be the second argument of

6
SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
View File

@ -300,7 +300,7 @@ Done:
Check if it needs to re-initialize usb debug port hardware. 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 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. Pci bus resource allocation and so on.
@param Handle Debug port handle. @param Handle Debug port handle.
@ -989,7 +989,7 @@ DebugPortPollBuffer (
/** /**
Initialize the debug port. 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 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 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 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 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). 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 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. created a new handle if needed and return it, otherwise it will return NULL.