]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Shellpkg: Fix spelling errors in Shell.c/Shell.h comments
authorJoe Peterson <joe.peterson@intel.com>
Fri, 6 Feb 2015 22:25:05 +0000 (22:25 +0000)
committerjcarsey <jcarsey@Edk2>
Fri, 6 Feb 2015 22:25:05 +0000 (22:25 +0000)
This patch fixes spelling errors in comments. No functional change.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Joe Peterson <joe.peterson@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16816 6f19259b-4bc3-4df7-8a09-765794883524

ShellPkg/Application/Shell/Shell.c
ShellPkg/Application/Shell/Shell.h

index 3061f8fcbc7e22b155b6c77c8460bad8e0fc6796..153234974d4ee714c21d8e3687987a6aad35364b 100644 (file)
@@ -123,7 +123,7 @@ FindNextInstance(
   Temp = StrStr(SourceString, FindString);\r
 \r
   //\r
-  // If nothing found, or we dont care about escape characters\r
+  // If nothing found, or we don't care about escape characters\r
   //\r
   if (Temp == NULL || !CheckForEscapeCharacter) {\r
     return (Temp);\r
@@ -143,7 +143,7 @@ FindNextInstance(
 }\r
 \r
 /**\r
-  Check whether the string between a pair of % is a valid envifronment variable name.\r
+  Check whether the string between a pair of % is a valid environment variable name.\r
 \r
   @param[in] BeginPercent       pointer to the first percent.\r
   @param[in] EndPercent          pointer to the last percent.\r
@@ -245,7 +245,7 @@ ContainsSplit(
   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
 EFIAPI\r
@@ -684,7 +684,7 @@ FreeResources:
 /**\r
   Sets all the alias' that were registered with the ShellCommandLib library.\r
 \r
-  @retval EFI_SUCCESS           all init commands were run sucessfully.\r
+  @retval EFI_SUCCESS           all init commands were run successfully.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -769,10 +769,10 @@ IsScriptOnlyCommand(
   loaded image protocol installed on it.  The FilePath will point to the device path\r
   for the file that was loaded.\r
 \r
-  @param[in, out] DevPath       On a sucessful return the device path to the loaded image.\r
-  @param[in, out] FilePath      On a sucessful return the device path to the file.\r
+  @param[in, out] DevPath       On a successful return the device path to the loaded image.\r
+  @param[in, out] FilePath      On a successful return the device path to the file.\r
 \r
-  @retval EFI_SUCCESS           The 2 device paths were sucessfully returned.\r
+  @retval EFI_SUCCESS           The 2 device paths were successfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r
 \r
   @sa HandleProtocol\r
@@ -979,7 +979,7 @@ ProcessCommandLine(
                                    ) == 0) {\r
       ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit         = TRUE;\r
     } else if (StrnCmp (L"-", CurrentArg, 1) == 0) {\r
-      // Unrecognised option\r
+      // Unrecognized option\r
       ShellPrintHiiEx(-1, -1, NULL,\r
         STRING_TOKEN (STR_GEN_PROBLEM),\r
         ShellInfoObject.HiiHandle,\r
@@ -1167,7 +1167,7 @@ DoStartupScript(
     FileStringPath = ShellFindFilePath(mStartupScript);\r
     if (FileStringPath == NULL) {\r
       //\r
-      // we return success since we dont need to have a startup script\r
+      // we return success since we don't need to have a startup script\r
       //\r
       Status = EFI_SUCCESS;\r
       ASSERT(FileHandle == NULL);\r
@@ -1349,7 +1349,7 @@ StripUnreplacedEnvironmentVariables(
     SecondPercent = FirstPercent!=NULL?FindNextInstance(FirstPercent+1, L"%", TRUE):NULL;\r
     if (FirstPercent == NULL || SecondPercent == NULL) {\r
       //\r
-      // If we ever dont have 2 % we are done.\r
+      // If we ever don't have 2 % we are done.\r
       //\r
       break;\r
     }\r
@@ -1381,7 +1381,7 @@ StripUnreplacedEnvironmentVariables(
         //\r
         CopyMem(FirstPercent, SecondPercent + 1, StrSize(SecondPercent + 1));\r
         //\r
-        // dont need to update the locator.  both % characters are gone.\r
+        // don't need to update the locator.  both % characters are gone.\r
         //\r
       } else {\r
         CurrentLocator = SecondPercent + 1;\r
@@ -1401,7 +1401,7 @@ StripUnreplacedEnvironmentVariables(
 \r
   @param[in] OriginalCommandLine    The original command line\r
 \r
-  @retval NULL                      An error ocurred.\r
+  @retval NULL                      An error occurred.\r
   @return                           The new command line with no environment variables present.\r
 **/\r
 CHAR16*\r
@@ -1442,7 +1442,7 @@ ShellConvertVariables (
         ;  Temp = StrStr(Temp+1, AliasListNode->Alias)\r
        ){\r
         //\r
-        // we need a preceeding and if there is space no ^ preceeding (if no space ignore)\r
+        // we need a preceding and if there is space no ^ preceding (if no space ignore)\r
         //\r
         if ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2)) {\r
           NewSize += StrSize(AliasListNode->CommandString);\r
@@ -1463,7 +1463,7 @@ ShellConvertVariables (
       ;  Temp = StrStr(Temp+1, MasterEnvList)\r
      ){\r
       //\r
-      // we need a preceeding and following % and if there is space no ^ preceeding (if no space ignore)\r
+      // we need a preceding and following % and if there is space no ^ preceding (if no space ignore)\r
       //\r
       if (*(Temp-1) == L'%' && *(Temp+StrLen(MasterEnvList)) == L'%' &&\r
         ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2))) {\r
@@ -1505,7 +1505,7 @@ ShellConvertVariables (
   }\r
 \r
   //\r
-  // Remove non-existant environment variables\r
+  // Remove non-existent environment variables\r
   //\r
   StripUnreplacedEnvironmentVariables(NewCommandLine1);\r
 \r
@@ -1902,7 +1902,7 @@ VerifySplit(
   @param[in] CmdLine    pointer to the command line to process\r
 \r
   @retval EFI_SUCCESS   The operation was successful\r
-  @return               an error occured.\r
+  @return               an error occurred.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -2058,7 +2058,7 @@ SetLastError(
 \r
   @retval EFI_SUCCESS           The operation was successful\r
   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
-  @return                       some other error occured\r
+  @return                       some other error occurred\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -2103,7 +2103,7 @@ ProcessCommandLineToFinal(
 /**\r
   Run an internal shell command.\r
 \r
-  This API will upadate the shell's environment since these commands are libraries.\r
+  This API will update the shell's environment since these commands are libraries.\r
   \r
   @param[in] CmdLine          the command line to run.\r
   @param[in] FirstParameter   the first parameter on the command line\r
@@ -2181,13 +2181,13 @@ RunInternalCommand(
   }\r
 \r
   //\r
-  // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.\r
+  // This is guaranteed to be called after UpdateArgcArgv no matter what else happened.\r
   // This is safe even if the update API failed.  In this case, it may be a no-op.\r
   //\r
   RestoreArgcArgv(ParamProtocol, &Argv, &Argc);\r
 \r
   //\r
-  // If a script is running and the command is not a scipt only command, then\r
+  // If a script is running and the command is not a script only command, then\r
   // change return value to success so the script won't halt (unless aborted).\r
   //\r
   // Script only commands have to be able halt the script since the script will\r
@@ -2425,7 +2425,7 @@ RunCommand(
   // NULL out comments (leveraged from RunScriptFileHandle() ).\r
   // The # character on a line is used to denote that all characters on the same line\r
   // and to the right of the # are to be ignored by the shell.\r
-  // Afterward, again remove spaces, in case any were between the last command-parameter and '#'.\r
+  // Afterwards, again remove spaces, in case any were between the last command-parameter and '#'.\r
   //\r
   for (TempWalker = CleanOriginal; TempWalker != NULL && *TempWalker != CHAR_NULL; TempWalker++) {\r
     if (*TempWalker == L'^') {\r
@@ -2454,7 +2454,7 @@ RunCommand(
   }\r
 \r
   //\r
-  // We dont do normal processing with a split command line (output from one command input to another)\r
+  // We don't do normal processing with a split command line (output from one command input to another)\r
   //\r
   if (ContainsSplit(CleanOriginal)) {\r
     Status = ProcessNewSplitCommandLine(CleanOriginal);\r
@@ -2505,7 +2505,7 @@ RunCommand(
 \r
 STATIC CONST UINT16 InvalidChars[] = {L'*', L'?', L'<', L'>', L'\\', L'/', L'\"', 0x0001, 0x0002};\r
 /**\r
-  Function determins if the CommandName COULD be a valid command.  It does not determine whether\r
+  Function determines if the CommandName COULD be a valid command.  It does not determine whether\r
   this is a valid command.  It only checks for invalid characters.\r
 \r
   @param[in] CommandName    The name to check\r
@@ -2541,7 +2541,7 @@ IsValidCommandName(
   @param[in] Handle             The handle to the already opened file.\r
   @param[in] Name               The name of the script file.\r
 \r
-  @retval EFI_SUCCESS           the script completed sucessfully\r
+  @retval EFI_SUCCESS           the script completed successfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -2837,7 +2837,7 @@ RunScriptFileHandle (
   @param[in] CmdLine            the command line to run.\r
   @param[in] ParamProtocol      the shell parameters protocol pointer\r
 \r
-  @retval EFI_SUCCESS           the script completed sucessfully\r
+  @retval EFI_SUCCESS           the script completed successfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -2885,7 +2885,7 @@ RunScriptFile (
   }\r
 \r
   //\r
-  // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.\r
+  // This is guaranteed to be called after UpdateArgcArgv no matter what else happened.\r
   // This is safe even if the update API failed.  In this case, it may be a no-op.\r
   //\r
   RestoreArgcArgv(ParamProtocol, &Argv, &Argc);\r
@@ -2894,7 +2894,7 @@ RunScriptFile (
 }\r
 \r
 /**\r
-  Return the pointer to the first occurance of any character from a list of characters.\r
+  Return the pointer to the first occurrence of any character from a list of characters.\r
 \r
   @param[in] String           the string to parse\r
   @param[in] CharacterList    the list of character to look for\r
index 51368f6ffa9d41fda5fd279b4449948131b55577..4d804fc45bb3add38c2d60e960be26f677434602 100644 (file)
@@ -139,7 +139,7 @@ typedef enum {
 \r
   @retval EFI_SUCCESS           The operation was successful\r
   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
-  @return                       some other error occured\r
+  @return                       some other error occurred\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -161,7 +161,7 @@ SetLastError(
 /**\r
   Sets all the alias' that were registered with the ShellCommandLib library.\r
 \r
-  @retval EFI_SUCCESS           all init commands were run sucessfully.\r
+  @retval EFI_SUCCESS           all init commands were run successfully.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -175,10 +175,10 @@ SetBuiltInAlias(
   loaded image protocol installed on it.  the FilePath will point to the device path\r
   for the file that was loaded.\r
 \r
-  @param[in, out] DevPath       on a sucessful return the device path to the loaded image\r
-  @param[in, out] FilePath      on a sucessful return the device path to the file\r
+  @param[in, out] DevPath       on a successful return the device path to the loaded image\r
+  @param[in, out] FilePath      on a successful return the device path to the file\r
 \r
-  @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.\r
+  @retval EFI_SUCCESS           the 2 device paths were successfully returned.\r
   @return other                 a error from gBS->HandleProtocol\r
 \r
   @sa HandleProtocol\r
@@ -294,7 +294,7 @@ RunCommand(
   );\r
 \r
 /**\r
-  Function determins if the CommandName COULD be a valid command.  It does not determine whether\r
+  Function determines if the CommandName COULD be a valid command.  It does not determine whether\r
   this is a valid command.  It only checks for invalid characters.\r
 \r
   @param[in] CommandName    The name to check\r
@@ -314,7 +314,7 @@ IsValidCommandName(
   @param[in] Handle             The handle to the already opened file.\r
   @param[in] Name               The name of the script file.\r
 \r
-  @retval EFI_SUCCESS           the script completed sucessfully\r
+  @retval EFI_SUCCESS           the script completed successfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -331,7 +331,7 @@ RunScriptFileHandle (
   @param[in] CmdLine            the command line to run.\r
   @param[in] ParamProtocol      the shell parameters protocol pointer\r
 \r
-  @retval EFI_SUCCESS           the script completed sucessfully\r
+  @retval EFI_SUCCESS           the script completed successfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -343,7 +343,7 @@ RunScriptFile (
   );\r
 \r
 /**\r
-  Return the pointer to the first occurance of any character from a list of characters.\r
+  Return the pointer to the first occurrence of any character from a list of characters.\r
 \r
   @param[in] String           the string to parse\r
   @param[in] CharacterList    the list of character to look for\r