SourceLevelDebugPkg: Fix typos in comments

- 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>

diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
index 0c1a7b0260f9c2c855340515855d722b5913a146..b2042841d28e7c0d1d949a05e2142f8122ed4ca1 100644 (file)
--- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
+++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
@@ -20,10 +20,10 @@ typedef VOID *    DEBUG_PORT_HANDLE;
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r

-  Refer to the descrption for DebugPortInitialize() for more details.\r
+  Refer to the description for DebugPortInitialize() for more details.\r

 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r
 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r

-  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Libary.\r
+  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Library.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -41,9 +41,9 @@ VOID
   stack, this function must work on the mode that doesn't return to the caller, then\r
   the caller needs to wrap up all rest of logic after DebugPortInitialize() into one\r
   function and pass it into DebugPortInitialize(). DebugPortInitialize() is\r
   stack, this function must work on the mode that doesn't return to the caller, then\r
   the caller needs to wrap up all rest of logic after DebugPortInitialize() into one\r
   function and pass it into DebugPortInitialize(). DebugPortInitialize() is\r

-  responsible to invoke the passing-in funciton at the end of DebugPortInitialize().\r
+  responsible to invoke the passing-in function at the end of DebugPortInitialize().\r

 \r
 \r

-  If the paramter Function is not NULL, Debug Communication Libary instance will\r
+  If the parameter Function is not NULL, Debug Communication Library instance will\r

   invoke it by passing in the Context to be the first parameter. Debug Communication\r
   Library instance could create one debug port handle to be the second parameter\r
   passing into the Function. Debug Communication Library instance also could pass\r
   invoke it by passing in the Context to be the first parameter. Debug Communication\r
   Library instance could create one debug port handle to be the second parameter\r
   passing into the Function. Debug Communication Library instance also could pass\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c
index faec574fa4171d585ea6b9587c5455a73a821ada..128c69f60cb24901724c6b642a1cb46b90047e98 100644 (file)
--- 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\r
   responsible to invoke the passing-in function at the end of InitializeDebugAgent().\r
 \r
   function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is\r
   responsible to invoke the passing-in function at the end of InitializeDebugAgent().\r
 \r

-  If the parameter Function is not NULL, Debug Agent Libary instance will invoke it by\r
+  If the parameter Function is not NULL, Debug Agent Library instance will invoke it by\r

   passing in the Context to be its parameter.\r
 \r
   If Function() is NULL, Debug Agent Library instance will return after setup debug\r
   passing in the Context to be its parameter.\r
 \r
   If Function() is NULL, Debug Agent Library instance will return after setup debug\r


@@ -648,10 +648,10 @@ InitializeDebugAgent (
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r

-  Refer to the descrption for DebugPortInitialize() for more details.\r
+  Refer to the description for DebugPortInitialize() for more details.\r

 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r
 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r

-  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Libary.\r
+  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Library.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h
index a0687fa173a166319239b35924cc9cc10ef5c214..300bc35c40616a5fea0fef2ed017dd9ac64d779d 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h
+++ b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.h
@@ -30,10 +30,10 @@ typedef struct {
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r
 /**\r
   Caller provided function to be invoked at the end of DebugPortInitialize().\r
 \r

-  Refer to the descrption for DebugPortInitialize() for more details.\r
+  Refer to the description for DebugPortInitialize() for more details.\r

 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r
 \r
   @param[in] Context           The first input argument of DebugPortInitialize().\r

-  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Libary.\r
+  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Library.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c
index 388286b406c4a235b5b6bb52486e0ca3d2ade9cd..6a854ff2a217b2bcb0b1a1fa6cbcb3aadca45df9 100644 (file)
--- 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\r
   the caller needs to wrap up all rest of logic after DebugPortInitialize() into one\r
   function and pass it into DebugPortInitialize(). DebugPortInitialize() is\r
   stack, this function must work on the mode that doesn't return to the caller, then\r
   the caller needs to wrap up all rest of logic after DebugPortInitialize() into one\r
   function and pass it into DebugPortInitialize(). DebugPortInitialize() is\r

-  responsible to invoke the passing-in funciton at the end of DebugPortInitialize().\r
+  responsible to invoke the passing-in function at the end of DebugPortInitialize().\r

 \r
 \r

-  If the paramter Function is not NULL, Debug Communication Libary instance will\r
+  If the parameter Function is not NULL, Debug Communication Library instance will\r

   invoke it by passing in the Context to be the first parameter. Debug Communication\r
   Library instance could create one debug port handle to be the second parameter\r
   passing into the Function. Debug Communication Library instance also could pass\r
   invoke it by passing in the Context to be the first parameter. Debug Communication\r
   Library instance could create one debug port handle to be the second parameter\r
   passing into the Function. Debug Communication Library instance also could pass\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c
index a08a26035937377bf3462b1a522283fd29bea0e8..d7829c211077e16d1a4e37d8f09bbe23810a92a2 100644 (file)
--- 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.\r
 \r
   During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check\r
   Check if it needs to re-initialize usb debug port hardware.\r
 \r
   During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check\r

-  whether the usb debug port hardware configuration is changed. Such case can be triggerred by\r
+  whether the usb debug port hardware configuration is changed. Such case can be triggered by\r

   Pci bus resource allocation and so on.\r
 \r
   @param  Handle           Debug port handle.\r
   Pci bus resource allocation and so on.\r
 \r
   @param  Handle           Debug port handle.\r


@@ -1007,7 +1007,7 @@ DebugPortPollBuffer (
 /**\r
   Initialize the debug port.\r
 \r
 /**\r
   Initialize the debug port.\r
 \r

-  If Function is not NULL, Debug Communication Libary will call this function\r
+  If Function is not NULL, Debug Communication Library will call this function\r

   by passing in the Context to be the first parameter. If needed, Debug Communication\r
   Library will create one debug port handle to be the second argument passing in\r
   calling the Function, otherwise it will pass NULL to be the second argument of\r
   by passing in the Context to be the first parameter. If needed, Debug Communication\r
   Library will create one debug port handle to be the second argument passing in\r
   calling the Function, otherwise it will pass NULL to be the second argument of\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c
index 7c62bdadfbf255dca50f313f6da623de8355ca4d..04e25e3ec2cf8bb753a667436f8415a6bcdf2421 100644 (file)
--- 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.\r
 \r
   During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check\r
   Check if it needs to re-initialize usb debug port hardware.\r
 \r
   During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check\r

-  whether the usb debug port hardware configuration is changed. Such case can be triggerred by\r
+  whether the usb debug port hardware configuration is changed. Such case can be triggered by\r

   Pci bus resource allocation and so on.\r
 \r
   @param  Handle           Debug port handle.\r
   Pci bus resource allocation and so on.\r
 \r
   @param  Handle           Debug port handle.\r


@@ -989,7 +989,7 @@ DebugPortPollBuffer (
 /**\r
   Initialize the debug port.\r
 \r
 /**\r
   Initialize the debug port.\r
 \r

-  If Function is not NULL, Debug Communication Libary will call this function\r
+  If Function is not NULL, Debug Communication Library will call this function\r

   by passing in the Context to be the first parameter. If needed, Debug Communication\r
   Library will create one debug port handle to be the second argument passing in\r
   calling the Function, otherwise it will pass NULL to be the second argument of\r
   by passing in the Context to be the first parameter. If needed, Debug Communication\r
   Library will create one debug port handle to be the second argument passing in\r
   calling the Function, otherwise it will pass NULL to be the second argument of\r


@@ -997,7 +997,7 @@ DebugPortPollBuffer (
 \r
   If Function is NULL, and Context is not NULL, the Debug Communication Library could\r
     a) Return the same handle as passed in (as Context parameter).\r
 \r
   If Function is NULL, and Context is not NULL, the Debug Communication Library could\r
     a) Return the same handle as passed in (as Context parameter).\r

-    b) Ignore the input Context parameter and create new hanlde to be returned.\r
+    b) Ignore the input Context parameter and create new handle to be returned.\r

 \r
   If parameter Function is NULL and Context is NULL, Debug Communication Library could\r
   created a new handle if needed and return it, otherwise it will return NULL.\r
 \r
   If parameter Function is NULL and Context is NULL, Debug Communication Library could\r
   created a new handle if needed and return it, otherwise it will return NULL.\r