]> git.proxmox.com Git - mirror_edk2.git/commitdiff
ShellPkg/Application: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:08:20 +0000 (02:08 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
Fix various typos in comments and documentation.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-68-philmd@redhat.com>

16 files changed:
ShellPkg/Application/Shell/ConsoleLogger.c
ShellPkg/Application/Shell/ConsoleLogger.h
ShellPkg/Application/Shell/ConsoleWrappers.c
ShellPkg/Application/Shell/FileHandleWrappers.c
ShellPkg/Application/Shell/FileHandleWrappers.h
ShellPkg/Application/Shell/Shell.c
ShellPkg/Application/Shell/Shell.h
ShellPkg/Application/Shell/ShellEnvVar.c
ShellPkg/Application/Shell/ShellEnvVar.h
ShellPkg/Application/Shell/ShellManParser.c
ShellPkg/Application/Shell/ShellManParser.h
ShellPkg/Application/Shell/ShellParametersProtocol.c
ShellPkg/Application/Shell/ShellParametersProtocol.h
ShellPkg/Application/Shell/ShellProtocol.c
ShellPkg/Application/Shell/ShellProtocol.h
ShellPkg/Application/ShellCTestApp/README.txt

index 6c4e26265407a8daf72ed286e6183eded0ec9fe3..36ba3ac2254ce44bdc7b814a2cc2dee16dcecd85 100644 (file)
@@ -310,9 +310,9 @@ UpdateDisplayFromHistory(
         StringSegment = &Screen[Column];\r
 \r
         //\r
-        // Find the first char with a different arrribute and make that temporarily NULL\r
+        // Find the first char with a different attribute and make that temporarily NULL\r
         // so we can do fewer printout statements.  (later) restore that one and we will\r
-        // start at that collumn on the next loop.\r
+        // start at that column on the next loop.\r
         //\r
         StringSegmentEndChar = CHAR_NULL;\r
         for ( StringSegmentEnd = StringSegment\r
@@ -395,7 +395,7 @@ UpdateDisplayFromHistory(
 }\r
 \r
 /**\r
-  Reset the text output device hardware and optionaly run diagnostics\r
+  Reset the text output device hardware and optionally run diagnostics\r
 \r
   @param  This                pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
   @param ExtendedVerification Indicates that a more extensive test may be performed\r
@@ -723,7 +723,7 @@ ConsoleLoggerPrintWithPageBreak(
       ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);\r
 \r
       //\r
-      // restore the temp NULL terminator to it's original character\r
+      // restore the temp NULL terminator to its original character\r
       //\r
       *((CHAR16*)(Walker+1)) = TempChar;\r
 \r
@@ -770,7 +770,7 @@ ConsoleLoggerPrintWithPageBreak(
         ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);\r
 \r
         //\r
-        // restore the temp NULL terminator to it's original character\r
+        // restore the temp NULL terminator to its original character\r
         //\r
         *((CHAR16*)(Walker+1)) = TempChar;\r
 \r
@@ -1189,7 +1189,7 @@ ConsoleLoggerEnableCursor (
 \r
   @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
 \r
-  This will be used when a mode has changed or a reset ocurred to verify all\r
+  This will be used when a mode has changed or a reset occurred to verify all\r
   history buffers.\r
 **/\r
 EFI_STATUS\r
index c2d5a9dcd4e0236b1e87d912a598c9fcf3fc2c0d..0a01bc2ca201223759925839cc14010456e38e7e 100644 (file)
@@ -117,7 +117,7 @@ UpdateDisplayFromHistory(
   );\r
 \r
 /**\r
-  Reset the text output device hardware and optionaly run diagnostics\r
+  Reset the text output device hardware and optionally run diagnostics\r
 \r
   @param This                 Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
   @param ExtendedVerification Indicates that a more extensive test may be performed\r
@@ -305,7 +305,7 @@ ConsoleLoggerEnableCursor (
 \r
   @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
 \r
-  This will be used when a mode has changed or a reset ocurred to verify all\r
+  This will be used when a mode has changed or a reset occurred to verify all\r
   history buffers.\r
 **/\r
 EFI_STATUS\r
index b573b53cf4f3e33d341d66a8a362fdf737ef3ca8..ec340de4e1288e5f9b30d0723ee7e5413611b758 100644 (file)
@@ -220,7 +220,7 @@ CloseSimpleTextInOnFile(
 }\r
 \r
 /**\r
-  Reset the text output device hardware and optionaly run diagnostics.\r
+  Reset the text output device hardware and optionally run diagnostics.\r
 \r
   @param  This                pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
   @param ExtendedVerification Indicates that a more extensive test may be performed\r
index 2d7bd7bec67e2cbcbd4e94a86757ddca7d700b7a..a622a763f85e6fc8e7588d3b2e655fd543c6cfee 100644 (file)
@@ -517,7 +517,7 @@ FileInterfaceStdInRead(
   gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &TotalColumn, &TotalRow);\r
 \r
   //\r
-  // Limit the line length to the buffer size or the minimun size of the\r
+  // Limit the line length to the buffer size or the minimum size of the\r
   // screen. (The smaller takes effect)\r
   //\r
   MaxStr = TotalColumn * (TotalRow - 1) - StartColumn;\r
@@ -865,7 +865,7 @@ FileInterfaceStdInRead(
       //\r
       if (Key.UnicodeChar != CHAR_BACKSPACE && !(Key.UnicodeChar == 0 && Key.ScanCode == SCAN_DELETE)) {\r
         //\r
-        // Calulate row and column of the tail of current string\r
+        // Calculate row and column of the tail of current string\r
         //\r
         TailRow     = Row + (StringLen - StringCurPos + Column + OutputLength) / TotalColumn;\r
         TailColumn  = (StringLen - StringCurPos + Column + OutputLength) % TotalColumn;\r
@@ -932,7 +932,7 @@ FileInterfaceStdInRead(
 }\r
 \r
 //\r
-// FILE sytle interfaces for StdIn/StdOut/StdErr\r
+// FILE style interfaces for StdIn/StdOut/StdErr\r
 //\r
 EFI_FILE_PROTOCOL FileInterfaceStdIn = {\r
   EFI_FILE_REVISION,\r
@@ -1069,7 +1069,7 @@ FileInterfaceEnvClose(
          ) {\r
         ((CHAR16*)NewBuffer)[TotalSize / sizeof (CHAR16) - 3] = CHAR_NULL;\r
         //\r
-        // If the NewBuffer end with \r\n\0, We will repace '\r' by '\0' and then update TotalSize.\r
+        // If the NewBuffer end with \r\n\0, We will replace '\r' by '\0' and then update TotalSize.\r
         //\r
         TotalSize -= sizeof(CHAR16) * 2;\r
       }\r
index 3398285d52f85d29262ee32b8542fed2db305180..5d58bfb2f45c1afe82728541c4a89e27e178284a 100644 (file)
@@ -20,17 +20,17 @@ typedef struct {
 } SHELL_LINE_LOG;\r
 \r
 ///\r
-/// FILE sytle interfaces for StdIn.\r
+/// FILE styte interfaces for StdIn.\r
 ///\r
 extern EFI_FILE_PROTOCOL FileInterfaceStdIn;\r
 \r
 ///\r
-/// FILE sytle interfaces for StdOut.\r
+/// FILE styte interfaces for StdOut.\r
 ///\r
 extern EFI_FILE_PROTOCOL FileInterfaceStdOut;\r
 \r
 ///\r
-/// FILE sytle interfaces for StdErr.\r
+/// FILE styte interfaces for StdErr.\r
 ///\r
 extern EFI_FILE_PROTOCOL FileInterfaceStdErr;\r
 \r
index d16adae0ea307677ee33ea1b8ef4687565d33c39..a5563070972ed1aaba020f99ef5f26751b9ae53e 100644 (file)
@@ -1081,7 +1081,7 @@ ProcessCommandLine(
           }\r
         }\r
         //\r
-        // If an argumnent contains a space, then add double quotes before the argument\r
+        // If an argument contains a space, then add double quotes before the argument\r
         //\r
         if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") != NULL) {\r
           StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,\r
@@ -1102,7 +1102,7 @@ ProcessCommandLine(
           return (EFI_OUT_OF_RESOURCES);\r
         }\r
         //\r
-        // If an argumnent contains a space, then add double quotes after the argument\r
+        // If an argument contains a space, then add double quotes after the argument\r
         //\r
         if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") != NULL) {\r
           StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,\r
@@ -1176,7 +1176,7 @@ LocateStartupScript (
   }\r
 \r
   //\r
-  // Try to find 'Startup.nsh' in the execution path defined by the envrionment variable PATH.\r
+  // Try to find 'Startup.nsh' in the execution path defined by the environment variable PATH.\r
   //\r
   if ((StartupScriptPath == NULL) || EFI_ERROR (ShellIsFile (StartupScriptPath))) {\r
     SHELL_FREE_NON_NULL (StartupScriptPath);\r
@@ -2251,7 +2251,7 @@ SetLastError(
 }\r
 \r
 /**\r
-  Converts the command line to it's post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
+  Converts the command line to its post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
 \r
   @param[in,out] CmdLine        pointer to the command line to update\r
 \r
index 1227adc1eb63063964ffecffd0c4f5850d4a84de..e6eb150f57a525fbf75974c2752ac0f67f3b17db 100644 (file)
@@ -135,7 +135,7 @@ typedef struct {
 extern SHELL_INFO ShellInfoObject;\r
 \r
 /**\r
-  Converts the command line to it's post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
+  Converts the command line to its post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
 \r
   @param[in,out] CmdLine        pointer to the command line to update\r
 \r
index dbeb8216986a0fd70f936e5ba386ace954451f2c..04fed3bf9141b02ae74b7e8d5f0d91e599b46eb3 100644 (file)
@@ -118,7 +118,7 @@ FreeEnvironmentVariableList(
   @param[in, out] ListHead       The pointer to pointer to LIST ENTRY object for\r
                                  storing this list.\r
 \r
-  @retval EFI_SUCCESS           the list was created sucessfully.\r
+  @retval EFI_SUCCESS           the list was created successfully.\r
 **/\r
 EFI_STATUS\r
 GetEnvironmentVariableList(\r
@@ -233,7 +233,7 @@ GetEnvironmentVariableList(
   @param[in] ListHead           The pointer to LIST_ENTRY from\r
                                 GetShellEnvVarList().\r
 \r
-  @retval EFI_SUCCESS           the list was Set sucessfully.\r
+  @retval EFI_SUCCESS           the list was Set successfully.\r
 **/\r
 EFI_STATUS\r
 SetEnvironmentVariableList(\r
@@ -266,7 +266,7 @@ SetEnvironmentVariableList(
   FreeEnvironmentVariableList(&VarList.Link);\r
 \r
   //\r
-  // set all the variables fron the list\r
+  // set all the variables from the list\r
   //\r
   for ( Node = (ENV_VAR_LIST*)GetFirstNode(ListHead)\r
       ; !IsNull(ListHead, &Node->Link)\r
@@ -479,7 +479,7 @@ ShellAddEnvVarToList (
   }\r
 \r
   //\r
-  // If the environment varialbe key doesn't exist in list just insert\r
+  // If the environment variable key doesn't exist in list just insert\r
   // a new node.\r
   //\r
   LocalKey = AllocateCopyPool (StrSize(Key), Key);\r
index 854a71ad9709faba655361d7e063c2656a02bc9b..6c8552ee6437385212b6693418c533efc7020c48 100644 (file)
@@ -43,14 +43,14 @@ IsVolatileEnv (
   );\r
 \r
 /**\r
-  Delete a Non-Violatile environment variable.\r
+  Delete a Non-Volatile environment variable.\r
 \r
-  This will use the Runtime Services call SetVariable to remove a non-violatile variable.\r
+  This will use the Runtime Services call SetVariable to remove a non-volatile variable.\r
 \r
   @param EnvVarName             The name of the environment variable in question\r
 \r
-  @retval EFI_SUCCESS           The variable was deleted sucessfully\r
-  @retval other                 An error ocurred\r
+  @retval EFI_SUCCESS           The variable was deleted successfully\r
+  @retval other                 An error occurred\r
   @sa SetVariable\r
 **/\r
 #define SHELL_DELETE_ENVIRONMENT_VARIABLE(EnvVarName) \\r
@@ -61,16 +61,16 @@ IsVolatileEnv (
   NULL))\r
 \r
 /**\r
-  Set a Non-Violatile environment variable.\r
+  Set a Non-Volatile environment variable.\r
 \r
-  This will use the Runtime Services call SetVariable to set a non-violatile variable.\r
+  This will use the Runtime Services call SetVariable to set a non-volatile variable.\r
 \r
   @param EnvVarName             The name of the environment variable in question\r
   @param BufferSize             UINTN size of Buffer\r
   @param Buffer                 Pointer to value to set variable to\r
 \r
-  @retval EFI_SUCCESS           The variable was changed sucessfully\r
-  @retval other                 An error ocurred\r
+  @retval EFI_SUCCESS           The variable was changed successfully\r
+  @retval other                 An error occurred\r
   @sa SetVariable\r
 **/\r
 #define SHELL_SET_ENVIRONMENT_VARIABLE_NV(EnvVarName,BufferSize,Buffer)  \\r
@@ -89,8 +89,8 @@ IsVolatileEnv (
   @param BufferSize             Pointer to the UINTN size of Buffer\r
   @param Buffer                 Pointer buffer to get variable value into\r
 \r
-  @retval EFI_SUCCESS           The variable's value was retrieved sucessfully\r
-  @retval other                 An error ocurred\r
+  @retval EFI_SUCCESS           The variable's value was retrieved successfully\r
+  @retval other                 An error occurred\r
   @sa SetVariable\r
 **/\r
 #define SHELL_GET_ENVIRONMENT_VARIABLE(EnvVarName,BufferSize,Buffer)    \\r
@@ -110,8 +110,8 @@ IsVolatileEnv (
   @param BufferSize             Pointer to the UINTN size of Buffer\r
   @param Buffer                 Pointer buffer to get variable value into\r
 \r
-  @retval EFI_SUCCESS           The variable's value was retrieved sucessfully\r
-  @retval other                 An error ocurred\r
+  @retval EFI_SUCCESS           The variable's value was retrieved successfully\r
+  @retval other                 An error occurred\r
   @sa SetVariable\r
 **/\r
 #define SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(EnvVarName,Atts,BufferSize,Buffer)    \\r
@@ -122,16 +122,16 @@ IsVolatileEnv (
   Buffer))\r
 \r
 /**\r
-  Set a Violatile environment variable.\r
+  Set a Volatile environment variable.\r
 \r
-  This will use the Runtime Services call SetVariable to set a violatile variable.\r
+  This will use the Runtime Services call SetVariable to set a volatile variable.\r
 \r
   @param EnvVarName             The name of the environment variable in question\r
   @param BufferSize             UINTN size of Buffer\r
   @param Buffer                 Pointer to value to set variable to\r
 \r
-  @retval EFI_SUCCESS           The variable was changed sucessfully\r
-  @retval other                 An error ocurred\r
+  @retval EFI_SUCCESS           The variable was changed successfully\r
+  @retval other                 An error occurred\r
   @sa SetVariable\r
 **/\r
 #define SHELL_SET_ENVIRONMENT_VARIABLE_V(EnvVarName,BufferSize,Buffer) \\r
@@ -147,7 +147,7 @@ IsVolatileEnv (
   @param[in, out] List           The pointer to pointer to LIST_ENTRY object for\r
                                  storing this list.\r
 \r
-  @retval EFI_SUCCESS           the list was created sucessfully.\r
+  @retval EFI_SUCCESS           the list was created successfully.\r
 **/\r
 EFI_STATUS\r
 GetEnvironmentVariableList(\r
@@ -164,7 +164,7 @@ GetEnvironmentVariableList(
   @param[in] List               The pointer to LIST_ENTRY from\r
                                 GetShellEnvVarList().\r
 \r
-  @retval EFI_SUCCESS           The list was Set sucessfully.\r
+  @retval EFI_SUCCESS           The list was Set successfully.\r
 **/\r
 EFI_STATUS\r
 SetEnvironmentVariableList(\r
index 4d5a5668aa1560584171a3a40615ccc029f29725..d5a85cb8cc3f8b5543445aa63efb88793f2d3d10 100644 (file)
@@ -179,12 +179,12 @@ SearchPathForFile(
 }\r
 \r
 /**\r
-  parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
-  detailed help for any sub section specified in the comma seperated list of\r
+  Parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
+  detailed help for any sub section specified in the comma separated list of\r
   sections provided.  If the end of the file or a .TH section is found then\r
   return.\r
 \r
-  Upon a sucessful return the caller is responsible to free the memory in *HelpText\r
+  Upon a successful return the caller is responsible to free the memory in *HelpText\r
 \r
   @param[in] Handle             FileHandle to read from\r
   @param[in] Sections           name of command's sub sections to find\r
@@ -193,8 +193,8 @@ SearchPathForFile(
   @param[in] Ascii              TRUE if the file is ASCII, FALSE otherwise.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
-  @retval EFI_SUCCESS           the section was found and its description sotred in\r
-                                an alloceted buffer.\r
+  @retval EFI_SUCCESS           the section was found and its description stored in\r
+                                an allocated buffer.\r
 **/\r
 EFI_STATUS\r
 ManFileFindSections(\r
@@ -296,11 +296,11 @@ ManFileFindSections(
 /**\r
   Parses a line from a MAN file to see if it is the Title Header. If it is, then\r
   if the "Brief Description" is desired, allocate a buffer for it and return a\r
-  copy. Upon a sucessful return the caller is responsible to free the memory in\r
+  copy. Upon a successful return the caller is responsible to free the memory in\r
   *BriefDesc\r
 \r
   Uses a simple state machine that allows "unlimited" whitespace before and after the\r
-  ".TH", compares Command and the MAN file commnd name without respect to case, and\r
+  ".TH", compares Command and the MAN file command name without respect to case, and\r
   allows "unlimited" whitespace and '0' and '1' characters before the Short Description.\r
   The PCRE regex describing this functionality is: ^\s*\.TH\s+(\S)\s[\s01]*(.*)$\r
   where group 1 is the Command Name and group 2 is the Short Description.\r
@@ -421,11 +421,11 @@ IsTitleHeader(
 }\r
 \r
 /**\r
-  parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
+  Parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
   "Brief Description" for the .TH section as specified by Command.  If the\r
   command section is not found return EFI_NOT_FOUND.\r
 \r
-  Upon a sucessful return the caller is responsible to free the memory in *BriefDesc\r
+  Upon a successful return the caller is responsible to free the memory in *BriefDesc\r
 \r
   @param[in] Handle              FileHandle to read from\r
   @param[in] Command             name of command's section to find as entered on the\r
@@ -512,7 +512,7 @@ ManFileFindTitleSection(
   information will be returned. If Sections is NULL, then all help text information\r
   available will be returned.\r
 \r
-  if BriefDesc is NULL, then the breif description will not be savedd seperatly,\r
+  if BriefDesc is NULL, then the breif description will not be saved separately,\r
   but placed first in the main HelpText.\r
 \r
   @param[in] ManFileName        Points to the NULL-terminated UEFI Shell MAN file name.\r
index 6fbad3aaaaec555565b2a91817d3adf8fbf25ecd..04031e007fe931dcf8a7a14fcc04e5a9ca20cd0e 100644 (file)
@@ -19,7 +19,7 @@
   information will be returned. If Sections is NULL, then all help text information\r
   available will be returned.\r
 \r
-  if BriefDesc is NULL, then the breif description will not be savedd seperatly,\r
+  if BriefDesc is NULL, then the breif description will not be savedd separately,\r
   but placed first in the main HelpText.\r
 \r
   @param[in] ManFileName        Points to the NULL-terminated UEFI Shell MAN file name.\r
@@ -49,11 +49,11 @@ ProcessManFile(
 \r
 /**\r
   parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
-  detailed help for any sub section specified in the comma seperated list of\r
+  detailed help for any sub section specified in the comma separated list of\r
   sections provided.  If the end of the file or a .TH section is found then\r
   return.\r
 \r
-  Upon a sucessful return the caller is responsible to free the memory in *HelpText\r
+  Upon a successful return the caller is responsible to free the memory in *HelpText\r
 \r
   @param[in] Handle             FileHandle to read from\r
   @param[in] Sections           name of command's sub sections to find\r
@@ -62,8 +62,8 @@ ProcessManFile(
   @param[in] Ascii              TRUE if the file is ASCII, FALSE otherwise.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
-  @retval EFI_SUCCESS           the section was found and its description sotred in\r
-                                an alloceted buffer.\r
+  @retval EFI_SUCCESS           the section was found and its description stored in\r
+                                an allocated buffer.\r
 **/\r
 EFI_STATUS\r
 ManFileFindSections(\r
index bcd8f0ae21121fded04ea5c23a003bf84cdc94b4..ef3966d3b08f123c3da988275491eb791e531e9d 100644 (file)
@@ -69,13 +69,13 @@ FindEndOfParameter(
   This will also remove all remaining ^ characters after processing.\r
 \r
   @param[in, out] Walker          pointer to string of command line.  Adjusted to\r
-                                  reminaing command line on return\r
+                                  remaining command line on return\r
   @param[in, out] TempParameter   pointer to string of command line item extracted.\r
   @param[in]      Length          buffer size of TempParameter.\r
   @param[in]      StripQuotation  if TRUE then strip the quotation marks surrounding\r
                                   the parameters.\r
 \r
-  @return   EFI_INALID_PARAMETER  A required parameter was NULL or pointed to a NULL or empty string.\r
+  @return   EFI_INVALID_PARAMETER A required parameter was NULL or pointed to a NULL or empty string.\r
   @return   EFI_NOT_FOUND         A closing " could not be found on the specified string\r
 **/\r
 EFI_STATUS\r
@@ -126,7 +126,7 @@ DEBUG_CODE_END();
   StrnCpyS(*TempParameter, Length / sizeof(CHAR16), (*Walker), NextDelim - *Walker);\r
 \r
   //\r
-  // Add a CHAR_NULL if we didnt get one via the copy\r
+  // Add a CHAR_NULL if we didn't get one via the copy\r
   //\r
   if (*NextDelim != CHAR_NULL) {\r
     (*TempParameter)[NextDelim - *Walker] = CHAR_NULL;\r
@@ -184,7 +184,7 @@ DEBUG_CODE_END();
   @param[in, out] Argv            pointer to array of strings; one for each parameter\r
   @param[in, out] Argc            pointer to number of strings in Argv array\r
 \r
-  @return EFI_SUCCESS           the operation was sucessful\r
+  @return EFI_SUCCESS           the operation was successful\r
   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -416,7 +416,7 @@ CreatePopulateInstallShellParametersProtocol (
 }\r
 \r
 /**\r
-  frees all memory used by createion and installation of shell parameters protocol\r
+  frees all memory used by creation and installation of shell parameters protocol\r
   and if there was an old version installed it will restore that one.\r
 \r
   @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is\r
@@ -466,7 +466,7 @@ CleanUpShellParametersProtocol (
 }\r
 \r
 /**\r
-  Determin if a file name represents a unicode file.\r
+  Determine if a file name represents a unicode file.\r
 \r
   @param[in] FileName     Pointer to the filename to open.\r
 \r
@@ -526,7 +526,7 @@ StripQuotes (
 }\r
 \r
 /**\r
-  Calcualte the 32-bit CRC in a EFI table using the service provided by the\r
+  Calculate the 32-bit CRC in a EFI table using the service provided by the\r
   gRuntime service.\r
 \r
   @param  Hdr                    Pointer to an EFI standard header\r
@@ -651,7 +651,7 @@ WriteFileTag (
 \r
 \r
 /**\r
-  Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
+  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure by parsing NewCommandLine.  The current values are returned to the\r
   user.\r
 \r
@@ -664,7 +664,7 @@ WriteFileTag (
   @param[out] OldStdErr                  Pointer to old StdErr.\r
   @param[out] SystemTableInfo            Pointer to old system table information.\r
 \r
-  @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
+  @retval   EFI_SUCCESS                 Operation was successful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -1257,7 +1257,7 @@ UpdateStdInStdOutStdErr(
 }\r
 \r
 /**\r
-  Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
+  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure with StdIn and StdOut.  The current values are de-allocated.\r
 \r
   @param[in, out] ShellParameters      Pointer to parameter structure to modify.\r
@@ -1327,7 +1327,7 @@ RestoreStdInStdOutStdErr (
   return (EFI_SUCCESS);\r
 }\r
 /**\r
-  Funcion will replace the current Argc and Argv in the ShellParameters protocol\r
+  Function will replace the current Argc and Argv in the ShellParameters protocol\r
   structure by parsing NewCommandLine.  The current values are returned to the\r
   user.\r
 \r
@@ -1339,7 +1339,7 @@ RestoreStdInStdOutStdErr (
   @param[out] OldArgv                    Pointer to old list of parameters.\r
   @param[out] OldArgc                    Pointer to old number of items in Argv list.\r
 \r
-  @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
+  @retval   EFI_SUCCESS                 Operation was successful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -1375,7 +1375,7 @@ UpdateArgcArgv(
 }\r
 \r
 /**\r
-  Funcion will replace the current Argc and Argv in the ShellParameters protocol\r
+  Function will replace the current Argc and Argv in the ShellParameters protocol\r
   structure with Argv and Argc.  The current values are de-allocated and the\r
   OldArgv must not be deallocated by the caller.\r
 \r
index df0316a03091d1a811b5551021b7d5882debf70f..398147c8bd4c31292581eebd15d150134d6abf06 100644 (file)
@@ -43,7 +43,7 @@ CreatePopulateInstallShellParametersProtocol (
   );\r
 \r
 /**\r
-  frees all memory used by createion and installation of shell parameters protocol\r
+  frees all memory used by creation and installation of shell parameters protocol\r
   and if there was an old version installed it will restore that one.\r
 \r
   @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is\r
@@ -60,7 +60,7 @@ CleanUpShellParametersProtocol (
   );\r
 \r
 /**\r
-  Funcion will replace the current Argc and Argv in the ShellParameters protocol\r
+  Function will replace the current Argc and Argv in the ShellParameters protocol\r
   structure by parsing NewCommandLine.  The current values are returned to the\r
   user.\r
 \r
@@ -70,7 +70,7 @@ CleanUpShellParametersProtocol (
   @param[out] OldArgv                   pointer to old list of parameters\r
   @param[out] OldArgc                   pointer to old number of items in Argv list\r
 \r
-  @retval   EFI_SUCCESS                 operation was sucessful, Argv and Argc are valid\r
+  @retval   EFI_SUCCESS                 operation was successful, Argv and Argc are valid\r
   @retval   EFI_OUT_OF_RESOURCES        a memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -83,7 +83,7 @@ UpdateArgcArgv(
   );\r
 \r
 /**\r
-  Funcion will replace the current Argc and Argv in the ShellParameters protocol\r
+  Function will replace the current Argc and Argv in the ShellParameters protocol\r
   structure with Argv and Argc.  The current values are de-allocated and the\r
   OldArgv must not be deallocated by the caller.\r
 \r
@@ -108,7 +108,7 @@ typedef struct {
 } SYSTEM_TABLE_INFO;\r
 \r
 /**\r
-  Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
+  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure by parsing NewCommandLine.  The current values are returned to the\r
   user.\r
 \r
@@ -121,7 +121,7 @@ typedef struct {
   @param[out] OldStdErr                  Pointer to old StdErr.\r
   @param[out] SystemTableInfo            Pointer to old system table information.\r
 \r
-  @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
+  @retval   EFI_SUCCESS                 Operation was successful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -135,7 +135,7 @@ UpdateStdInStdOutStdErr(
   );\r
 \r
 /**\r
-  Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
+  Function will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure with StdIn and StdOut.  The current values are de-allocated.\r
 \r
   @param[in, out] ShellParameters      Pointer to parameter structure to modify.\r
@@ -166,7 +166,7 @@ RestoreStdInStdOutStdErr (
   @param[in, out] Argv            pointer to array of strings; one for each parameter\r
   @param[in, out] Argc            pointer to number of strings in Argv array\r
 \r
-  @return EFI_SUCCESS           the operation was sucessful\r
+  @return EFI_SUCCESS           the operation was successful\r
   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
 **/\r
 EFI_STATUS\r
@@ -188,13 +188,13 @@ ParseCommandLineToArgs(
   function.\r
 \r
   @param[in, out] Walker          pointer to string of command line.  Adjusted to\r
-                                  reminaing command line on return\r
+                                  remaining command line on return\r
   @param[in, out] TempParameter   pointer to string of command line item extracted.\r
   @param[in]      Length          Length of (*TempParameter) in bytes\r
   @param[in]      StripQuotation  if TRUE then strip the quotation marks surrounding\r
                                   the parameters.\r
 \r
-  @return   EFI_INALID_PARAMETER  A required parameter was NULL or pointed to a NULL or empty string.\r
+  @return   EFI_INVALID_PARAMETER A required parameter was NULL or pointed to a NULL or empty string.\r
   @return   EFI_NOT_FOUND         A closing " could not be found on the specified string\r
 **/\r
 EFI_STATUS\r
index f0362a42d893ea24daf7e32989841a1589ee0ec6..4e639fe35e4f289f3ea0401d981646cd15c63555 100644 (file)
@@ -96,7 +96,7 @@ InternalShellProtocolIsSimpleFileSystemPresent(
 /**\r
   This function creates a mapping for a device path.\r
 \r
-  If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.\r
+  If both DevicePath and Mapping are NULL, this will reset the mapping to default values.\r
 \r
   @param DevicePath             Points to the device path. If this is NULL and Mapping points to a valid mapping,\r
                                 then the mapping will be deleted.\r
@@ -152,7 +152,7 @@ EfiShellSetMap(
     } // for loop\r
 \r
     //\r
-    // We didnt find one to delete\r
+    // We didn't find one to delete\r
     //\r
     return (EFI_NOT_FOUND);\r
   }\r
@@ -232,7 +232,7 @@ EfiShellGetDevicePathFromMap(
   device path. If there is an exact match, the mapping is returned and *DevicePath\r
   points to the end-of-device-path node.\r
 \r
-  If there are multiple map names they will be semi-colon seperated in the\r
+  If there are multiple map names they will be semi-colon separated in the\r
   NULL-terminated string.\r
 \r
   @param DevicePath             On entry, points to a device path pointer. On\r
@@ -910,8 +910,8 @@ EfiShellBatchIsActive (
   @param Attributes               the File Attributes to use when creating a new file.\r
 \r
   @retval EFI_SUCCESS             the file is open and FileHandle is valid\r
-  @retval EFI_UNSUPPORTED         the device path cotained non-path elements\r
-  @retval other                   an error ocurred.\r
+  @retval EFI_UNSUPPORTED         the device path contained non-path elements\r
+  @retval other                   an error occurred.\r
 **/\r
 EFI_STATUS\r
 InternalOpenFileDevicePath(\r
@@ -946,7 +946,7 @@ InternalOpenFileDevicePath(
     Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle);\r
     if (Handle1 != NULL) {\r
       //\r
-      // chop off the begining part before the file system part...\r
+      // chop off the beginning part before the file system part...\r
       //\r
       ///@todo BlockIo?\r
       Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,\r
@@ -1064,14 +1064,14 @@ InternalOpenFileDevicePath(
   already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r
 \r
   @param FileName           Pointer to NULL-terminated file path\r
-  @param FileAttribs        The new file's attrbiutes.  the different attributes are\r
+  @param FileAttribs        The new file's attributes.  the different attributes are\r
                             described in EFI_FILE_PROTOCOL.Open().\r
   @param FileHandle         On return, points to the created file handle or directory's handle\r
 \r
   @retval EFI_SUCCESS       The file was opened.  FileHandle points to the new file's handle.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
   @retval EFI_UNSUPPORTED   could not open the file path\r
-  @retval EFI_NOT_FOUND     the specified file could not be found on the devide, or could not\r
+  @retval EFI_NOT_FOUND     the specified file could not be found on the device, or could not\r
                             file the file system on the device.\r
   @retval EFI_NO_MEDIA      the device has no medium.\r
   @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r
@@ -1908,7 +1908,7 @@ typedef struct {
   @param[in] Node     The node to copy from.\r
   @param[in] Save     TRUE to set Node->Handle to NULL, FALSE otherwise.\r
 \r
-  @retval NULL        a memory allocation error ocurred\r
+  @retval NULL        a memory allocation error occurred\r
   @return != NULL     a pointer to the new node\r
 **/\r
 EFI_SHELL_FILE_INFO*\r
@@ -1960,7 +1960,7 @@ InternalDuplicateShellFileInfo(
   @param[in] Handle           Handle member initial value.\r
   @param[in] Info             Info struct to copy.\r
 \r
-  @retval NULL                An error ocurred.\r
+  @retval NULL                An error occurred.\r
   @return                     a pointer to the newly allocated structure.\r
 **/\r
 EFI_SHELL_FILE_INFO *\r
@@ -2120,7 +2120,7 @@ EfiShellFindFilesInDir(
     //\r
     ShellFileListItem = CreateAndPopulateShellFileInfo(\r
       BasePath,\r
-      EFI_SUCCESS,  // success since we didnt fail to open it...\r
+      EFI_SUCCESS,  // success since we didn't fail to open it...\r
       FileInfo->FileName,\r
       NULL,         // no handle since not open\r
       FileInfo);\r
@@ -2706,7 +2706,7 @@ EfiShellGetEnvEx(
         Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer);\r
       }\r
       //\r
-      // we didnt get it (might not exist)\r
+      // we didn't get it (might not exist)\r
       // free the memory if we allocated any and return NULL\r
       //\r
       if (EFI_ERROR(Status)) {\r
@@ -2927,7 +2927,7 @@ EfiShellGetCurDir(
                                 directory is changed.\r
   @param Dir                    Points to the NULL-terminated directory on the device specified by FileSystem.\r
 \r
-  @retval EFI_SUCCESS           The operation was sucessful\r
+  @retval EFI_SUCCESS           The operation was successful\r
   @retval EFI_NOT_FOUND         The file system could not be found\r
 **/\r
 EFI_STATUS\r
@@ -3179,12 +3179,12 @@ EfiShellIsRootShell(
 }\r
 \r
 /**\r
-  function to return a semi-colon delimeted list of all alias' in the current shell\r
+  function to return a semi-colon delimited list of all alias' in the current shell\r
 \r
   up to caller to free the memory.\r
 \r
   @retval NULL    No alias' were found\r
-  @retval NULL    An error ocurred getting alias'\r
+  @retval NULL    An error occurred getting alias'\r
   @return !NULL   a list of all alias'\r
 **/\r
 CHAR16 *\r
@@ -3287,7 +3287,7 @@ ToLower (
                                 If Alias is NULL, ReturnedData points to a ';'\r
                                 delimited list of alias (e.g.\r
                                 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.\r
-  @retval NULL                  an error ocurred\r
+  @retval NULL                  an error occurred\r
   @retval NULL                  Alias was not a valid Alias\r
 **/\r
 CONST CHAR16 *\r
@@ -3612,7 +3612,7 @@ CreatePopulateInstallShellProtocol (
                             (VOID*)(&mShellProtocol));\r
         if (!EFI_ERROR(Status)) {\r
           //\r
-          // we reinstalled sucessfully.  log this so we can reverse it later.\r
+          // we reinstalled successfully.  log this so we can reverse it later.\r
           //\r
 \r
           //\r
@@ -3759,7 +3759,7 @@ NotificationFunction(
   feature's enabled state was not known when the shell initially launched.\r
 \r
   @retval EFI_SUCCESS           The feature is enabled.\r
-  @retval EFI_OUT_OF_RESOURCES  There is not enough mnemory available.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough memory available.\r
 **/\r
 EFI_STATUS\r
 InernalEfiShellStartMonitor(\r
index dcef16e437482231aae9ee1f9b24beb27517e8ed..472d98dba2e7dbf694a41920b5e1e418d814b6a4 100644 (file)
@@ -283,8 +283,8 @@ EfiShellBatchIsActive (
   @param Attributes               the File Attributes to use when creating a new file\r
 \r
   @retval EFI_SUCCESS             the file is open and FileHandle is valid\r
-  @retval EFI_UNSUPPORTED         the device path cotained non-path elements\r
-  @retval other                   an error ocurred.\r
+  @retval EFI_UNSUPPORTED         the device path contained non-path elements\r
+  @retval other                   an error occurred.\r
 **/\r
 EFI_STATUS\r
 InternalOpenFileDevicePath(\r
@@ -309,7 +309,7 @@ InternalOpenFileDevicePath(
   already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r
 \r
   @param FileName           Pointer to NULL-terminated file path\r
-  @param FileAttribs        The new file's attrbiutes.  the different attributes are\r
+  @param FileAttribs        The new file's attributes.  the different attributes are\r
                             described in EFI_FILE_PROTOCOL.Open().\r
   @param FileHandle         On return, points to the created file handle or directory's handle\r
 \r
@@ -734,7 +734,7 @@ EfiShellGetCurDir(
                                 directory is changed.\r
   @param Dir                    Points to the NULL-terminated directory on the device specified by FileSystem.\r
 \r
-  @retval EFI_SUCCESS           The operation was sucessful\r
+  @retval EFI_SUCCESS           The operation was successful\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -818,7 +818,7 @@ EfiShellIsRootShell(
                                 If Alias is NULL, ReturnedData points to a ';'\r
                                 delimited list of alias (e.g.\r
                                 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.\r
-  @retval NULL                  an error ocurred\r
+  @retval NULL                  an error occurred\r
   @retval NULL                  Alias was not a valid Alias\r
 **/\r
 CONST CHAR16 *\r
@@ -915,7 +915,7 @@ InternalEfiShellSetEnv(
   feature's enabled state was not known when the shell initially launched.\r
 \r
   @retval EFI_SUCCESS           The feature is enabled.\r
-  @retval EFI_OUT_OF_RESOURCES  There is not enough mnemory available.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough memory available.\r
 **/\r
 EFI_STATUS\r
 InernalEfiShellStartMonitor(\r
index 02594e0d12082fb9da357968323aac43beb615bb..d788d3ef62a922d2ade10ea3e45570395727b916 100644 (file)
@@ -1,5 +1,5 @@
 TestArgv.nsh is a very simple shell script to test how the interpreter parses\r
 the parameters. It uses ShellCTestApp.efi to dump the parameters passed from the\r
-intepreter.\r
+interpreter.\r
 \r
 TestArgv.log is the desired output created using "TestArgv.nsh > TestArgv.log".\r