From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.81]) by mx.groups.io with SMTP id smtpd.web11.2049.1578044518388887150 for ; Fri, 03 Jan 2020 01:41:59 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=NDrHtZXQ; spf=pass (domain: redhat.com, ip: 207.211.31.81, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578044517; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=++BlO97CBz/EmiwHMwX4t4hERuvBLkYKzWBuMNi7rck=; b=NDrHtZXQCdoOFXjiqs3IZWo0Mdf5naNva0OmIRJ3Pj/4SHvy5WZPfAul71GLkp0AB0cgXr 6QtG14YwCQNvIB4xSnrK6mDwkEcPZeAZADN+VDekaHaz4hrSrNjQvKkTN1zYND3inoYYC8 jhnf9+YwLVSuqE6MyuzqAKAb4p02hmU= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-421-k16vNJGzOuSmuhljZ6Y7fg-1; Fri, 03 Jan 2020 04:41:55 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 92BD9800D4C; Fri, 3 Jan 2020 09:41:54 +0000 (UTC) Received: from x1w.redhat.com (ovpn-116-190.ams2.redhat.com [10.36.116.190]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E9B5960BF7; Fri, 3 Jan 2020 09:41:52 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Antoine Coeur , Ray Ni , Zhichao Gao , Philippe Mathieu-Daude Subject: [PATCH v2 67/78] ShellPkg/Application: Fix various typos Date: Fri, 3 Jan 2020 10:08:01 +0100 Message-Id: <20200103090812.10592-68-philmd@redhat.com> In-Reply-To: <20200103090812.10592-1-philmd@redhat.com> References: <20200103090812.10592-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: k16vNJGzOuSmuhljZ6Y7fg-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Antoine Coeur Fix various typos in comments and documentation. Cc: Ray Ni Cc: Zhichao Gao Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Zhichao Gao Signed-off-by: Philippe Mathieu-Daude --- ShellPkg/Application/Shell/ConsoleLogger.h | 4 +-- .../Application/Shell/FileHandleWrappers.h | 6 ++-- ShellPkg/Application/Shell/Shell.h | 2 +- ShellPkg/Application/Shell/ShellEnvVar.h | 36 +++++++++---------- ShellPkg/Application/Shell/ShellManParser.h | 10 +++--- .../Shell/ShellParametersProtocol.h | 20 +++++------ ShellPkg/Application/Shell/ShellProtocol.h | 12 +++---- ShellPkg/Application/Shell/ConsoleLogger.c | 12 +++---- ShellPkg/Application/Shell/ConsoleWrappers.c | 2 +- .../Application/Shell/FileHandleWrappers.c | 8 ++--- ShellPkg/Application/Shell/Shell.c | 8 ++--- ShellPkg/Application/Shell/ShellEnvVar.c | 8 ++--- ShellPkg/Application/Shell/ShellManParser.c | 20 +++++------ .../Shell/ShellParametersProtocol.c | 26 +++++++------- ShellPkg/Application/Shell/ShellProtocol.c | 36 +++++++++---------- ShellPkg/Application/ShellCTestApp/README.txt | 2 +- 16 files changed, 106 insertions(+), 106 deletions(-) diff --git a/ShellPkg/Application/Shell/ConsoleLogger.h b/ShellPkg/Applicat= ion/Shell/ConsoleLogger.h index c2d5a9dcd4e0..0a01bc2ca201 100644 --- a/ShellPkg/Application/Shell/ConsoleLogger.h +++ b/ShellPkg/Application/Shell/ConsoleLogger.h @@ -117,7 +117,7 @@ UpdateDisplayFromHistory( ); =20 /** - Reset the text output device hardware and optionaly run diagnostics + Reset the text output device hardware and optionally run diagnostics =20 @param This Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param ExtendedVerification Indicates that a more extensive test may be = performed @@ -305,7 +305,7 @@ ConsoleLoggerEnableCursor ( =20 @param[in] ConsoleInfo The pointer to the instance of the console logge= r information. =20 - This will be used when a mode has changed or a reset ocurred to verify a= ll + This will be used when a mode has changed or a reset occurred to verify = all history buffers. **/ EFI_STATUS diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.h b/ShellPkg/App= lication/Shell/FileHandleWrappers.h index 3398285d52f8..5d58bfb2f45c 100644 --- a/ShellPkg/Application/Shell/FileHandleWrappers.h +++ b/ShellPkg/Application/Shell/FileHandleWrappers.h @@ -20,17 +20,17 @@ typedef struct { } SHELL_LINE_LOG; =20 /// -/// FILE sytle interfaces for StdIn. +/// FILE styte interfaces for StdIn. /// extern EFI_FILE_PROTOCOL FileInterfaceStdIn; =20 /// -/// FILE sytle interfaces for StdOut. +/// FILE styte interfaces for StdOut. /// extern EFI_FILE_PROTOCOL FileInterfaceStdOut; =20 /// -/// FILE sytle interfaces for StdErr. +/// FILE styte interfaces for StdErr. /// extern EFI_FILE_PROTOCOL FileInterfaceStdErr; =20 diff --git a/ShellPkg/Application/Shell/Shell.h b/ShellPkg/Application/Shel= l/Shell.h index 1227adc1eb63..e6eb150f57a5 100644 --- a/ShellPkg/Application/Shell/Shell.h +++ b/ShellPkg/Application/Shell/Shell.h @@ -135,7 +135,7 @@ typedef struct { extern SHELL_INFO ShellInfoObject; =20 /** - Converts the command line to it's post-processed form. this replaces va= riables and alias' per UEFI Shell spec. + Converts the command line to its post-processed form. this replaces var= iables and alias' per UEFI Shell spec. =20 @param[in,out] CmdLine pointer to the command line to update =20 diff --git a/ShellPkg/Application/Shell/ShellEnvVar.h b/ShellPkg/Applicatio= n/Shell/ShellEnvVar.h index 854a71ad9709..6c8552ee6437 100644 --- a/ShellPkg/Application/Shell/ShellEnvVar.h +++ b/ShellPkg/Application/Shell/ShellEnvVar.h @@ -43,14 +43,14 @@ IsVolatileEnv ( ); =20 /** - Delete a Non-Violatile environment variable. + Delete a Non-Volatile environment variable. =20 - This will use the Runtime Services call SetVariable to remove a non-viol= atile variable. + This will use the Runtime Services call SetVariable to remove a non-vola= tile variable. =20 @param EnvVarName The name of the environment variable in qu= estion =20 - @retval EFI_SUCCESS The variable was deleted sucessfully - @retval other An error ocurred + @retval EFI_SUCCESS The variable was deleted successfully + @retval other An error occurred @sa SetVariable **/ #define SHELL_DELETE_ENVIRONMENT_VARIABLE(EnvVarName) \ @@ -61,16 +61,16 @@ IsVolatileEnv ( NULL)) =20 /** - Set a Non-Violatile environment variable. + Set a Non-Volatile environment variable. =20 - This will use the Runtime Services call SetVariable to set a non-violati= le variable. + This will use the Runtime Services call SetVariable to set a non-volatil= e variable. =20 @param EnvVarName The name of the environment variable in qu= estion @param BufferSize UINTN size of Buffer @param Buffer Pointer to value to set variable to =20 - @retval EFI_SUCCESS The variable was changed sucessfully - @retval other An error ocurred + @retval EFI_SUCCESS The variable was changed successfully + @retval other An error occurred @sa SetVariable **/ #define SHELL_SET_ENVIRONMENT_VARIABLE_NV(EnvVarName,BufferSize,Buffer) \ @@ -89,8 +89,8 @@ IsVolatileEnv ( @param BufferSize Pointer to the UINTN size of Buffer @param Buffer Pointer buffer to get variable value into =20 - @retval EFI_SUCCESS The variable's value was retrieved sucessf= ully - @retval other An error ocurred + @retval EFI_SUCCESS The variable's value was retrieved success= fully + @retval other An error occurred @sa SetVariable **/ #define SHELL_GET_ENVIRONMENT_VARIABLE(EnvVarName,BufferSize,Buffer) \ @@ -110,8 +110,8 @@ IsVolatileEnv ( @param BufferSize Pointer to the UINTN size of Buffer @param Buffer Pointer buffer to get variable value into =20 - @retval EFI_SUCCESS The variable's value was retrieved sucessf= ully - @retval other An error ocurred + @retval EFI_SUCCESS The variable's value was retrieved success= fully + @retval other An error occurred @sa SetVariable **/ #define SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(EnvVarName,Atts,Buff= erSize,Buffer) \ @@ -122,16 +122,16 @@ IsVolatileEnv ( Buffer)) =20 /** - Set a Violatile environment variable. + Set a Volatile environment variable. =20 - This will use the Runtime Services call SetVariable to set a violatile v= ariable. + This will use the Runtime Services call SetVariable to set a volatile va= riable. =20 @param EnvVarName The name of the environment variable in qu= estion @param BufferSize UINTN size of Buffer @param Buffer Pointer to value to set variable to =20 - @retval EFI_SUCCESS The variable was changed sucessfully - @retval other An error ocurred + @retval EFI_SUCCESS The variable was changed successfully + @retval other An error occurred @sa SetVariable **/ #define SHELL_SET_ENVIRONMENT_VARIABLE_V(EnvVarName,BufferSize,Buffer) \ @@ -147,7 +147,7 @@ IsVolatileEnv ( @param[in, out] List The pointer to pointer to LIST_ENTRY obje= ct for storing this list. =20 - @retval EFI_SUCCESS the list was created sucessfully. + @retval EFI_SUCCESS the list was created successfully. **/ EFI_STATUS GetEnvironmentVariableList( @@ -164,7 +164,7 @@ GetEnvironmentVariableList( @param[in] List The pointer to LIST_ENTRY from GetShellEnvVarList(). =20 - @retval EFI_SUCCESS The list was Set sucessfully. + @retval EFI_SUCCESS The list was Set successfully. **/ EFI_STATUS SetEnvironmentVariableList( diff --git a/ShellPkg/Application/Shell/ShellManParser.h b/ShellPkg/Applica= tion/Shell/ShellManParser.h index 6fbad3aaaaec..04031e007fe9 100644 --- a/ShellPkg/Application/Shell/ShellManParser.h +++ b/ShellPkg/Application/Shell/ShellManParser.h @@ -19,7 +19,7 @@ information will be returned. If Sections is NULL, then all help text in= formation available will be returned. =20 - if BriefDesc is NULL, then the breif description will not be savedd sepe= ratly, + if BriefDesc is NULL, then the breif description will not be savedd sepa= rately, but placed first in the main HelpText. =20 @param[in] ManFileName Points to the NULL-terminated UEFI Shell M= AN file name. @@ -49,11 +49,11 @@ ProcessManFile( =20 /** parses through the MAN file specified by SHELL_FILE_HANDLE and returns t= he - detailed help for any sub section specified in the comma seperated list = of + detailed help for any sub section specified in the comma separated list = of sections provided. If the end of the file or a .TH section is found the= n return. =20 - Upon a sucessful return the caller is responsible to free the memory in = *HelpText + Upon a successful return the caller is responsible to free the memory in= *HelpText =20 @param[in] Handle FileHandle to read from @param[in] Sections name of command's sub sections to find @@ -62,8 +62,8 @@ ProcessManFile( @param[in] Ascii TRUE if the file is ASCII, FALSE otherwise= . =20 @retval EFI_OUT_OF_RESOURCES a memory allocation failed. - @retval EFI_SUCCESS the section was found and its description = sotred in - an alloceted buffer. + @retval EFI_SUCCESS the section was found and its description = stored in + an allocated buffer. **/ EFI_STATUS ManFileFindSections( diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPk= g/Application/Shell/ShellParametersProtocol.h index df0316a03091..398147c8bd4c 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -43,7 +43,7 @@ CreatePopulateInstallShellParametersProtocol ( ); =20 /** - frees all memory used by createion and installation of shell parameters = protocol + frees all memory used by creation and installation of shell parameters p= rotocol and if there was an old version installed it will restore that one. =20 @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL= that is @@ -60,7 +60,7 @@ CleanUpShellParametersProtocol ( ); =20 /** - Funcion will replace the current Argc and Argv in the ShellParameters pr= otocol + Function will replace the current Argc and Argv in the ShellParameters p= rotocol structure by parsing NewCommandLine. The current values are returned to= the user. =20 @@ -70,7 +70,7 @@ CleanUpShellParametersProtocol ( @param[out] OldArgv pointer to old list of parameters @param[out] OldArgc pointer to old number of items in = Argv list =20 - @retval EFI_SUCCESS operation was sucessful, Argv and = Argc are valid + @retval EFI_SUCCESS operation was successful, Argv and= Argc are valid @retval EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS @@ -83,7 +83,7 @@ UpdateArgcArgv( ); =20 /** - Funcion will replace the current Argc and Argv in the ShellParameters pr= otocol + Function will replace the current Argc and Argv in the ShellParameters p= rotocol structure with Argv and Argc. The current values are de-allocated and t= he OldArgv must not be deallocated by the caller. =20 @@ -108,7 +108,7 @@ typedef struct { } SYSTEM_TABLE_INFO; =20 /** - Funcion will replace the current StdIn and StdOut in the ShellParameters= protocol + Function will replace the current StdIn and StdOut in the ShellParameter= s protocol structure by parsing NewCommandLine. The current values are returned to= the user. =20 @@ -121,7 +121,7 @@ typedef struct { @param[out] OldStdErr Pointer to old StdErr. @param[out] SystemTableInfo Pointer to old system table infor= mation. =20 - @retval EFI_SUCCESS Operation was sucessful, Argv and = Argc are valid. + @retval EFI_SUCCESS Operation was successful, Argv and= Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. **/ EFI_STATUS @@ -135,7 +135,7 @@ UpdateStdInStdOutStdErr( ); =20 /** - Funcion will replace the current StdIn and StdOut in the ShellParameters= protocol + Function will replace the current StdIn and StdOut in the ShellParameter= s protocol structure with StdIn and StdOut. The current values are de-allocated. =20 @param[in, out] ShellParameters Pointer to parameter structure to m= odify. @@ -166,7 +166,7 @@ RestoreStdInStdOutStdErr ( @param[in, out] Argv pointer to array of strings; one for eac= h parameter @param[in, out] Argc pointer to number of strings in Argv arr= ay =20 - @return EFI_SUCCESS the operation was sucessful + @return EFI_SUCCESS the operation was successful @return EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS @@ -188,13 +188,13 @@ ParseCommandLineToArgs( function. =20 @param[in, out] Walker pointer to string of command line. Adju= sted to - reminaing command line on return + remaining command line on return @param[in, out] TempParameter pointer to string of command line item e= xtracted. @param[in] Length Length of (*TempParameter) in bytes @param[in] StripQuotation if TRUE then strip the quotation marks s= urrounding the parameters. =20 - @return EFI_INALID_PARAMETER A required parameter was NULL or pointed= to a NULL or empty string. + @return EFI_INVALID_PARAMETER A required parameter was NULL or pointed= to a NULL or empty string. @return EFI_NOT_FOUND A closing " could not be found on the sp= ecified string **/ EFI_STATUS diff --git a/ShellPkg/Application/Shell/ShellProtocol.h b/ShellPkg/Applicat= ion/Shell/ShellProtocol.h index dcef16e43748..472d98dba2e7 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.h +++ b/ShellPkg/Application/Shell/ShellProtocol.h @@ -283,8 +283,8 @@ EfiShellBatchIsActive ( @param Attributes the File Attributes to use when creating= a new file =20 @retval EFI_SUCCESS the file is open and FileHandle is valid - @retval EFI_UNSUPPORTED the device path cotained non-path elemen= ts - @retval other an error ocurred. + @retval EFI_UNSUPPORTED the device path contained non-path eleme= nts + @retval other an error occurred. **/ EFI_STATUS InternalOpenFileDevicePath( @@ -309,7 +309,7 @@ InternalOpenFileDevicePath( already exists and is non-volatile then EFI_INVALID_PARAMETER is returne= d. =20 @param FileName Pointer to NULL-terminated file path - @param FileAttribs The new file's attrbiutes. the different attr= ibutes are + @param FileAttribs The new file's attributes. the different attr= ibutes are described in EFI_FILE_PROTOCOL.Open(). @param FileHandle On return, points to the created file handle o= r directory's handle =20 @@ -734,7 +734,7 @@ EfiShellGetCurDir( directory is changed. @param Dir Points to the NULL-terminated directory on= the device specified by FileSystem. =20 - @retval EFI_SUCCESS The operation was sucessful + @retval EFI_SUCCESS The operation was successful **/ EFI_STATUS EFIAPI @@ -818,7 +818,7 @@ EfiShellIsRootShell( If Alias is NULL, ReturnedData points to a= ';' delimited list of alias (e.g. ReturnedData =3D "dir;del;copy;mfp") that = is NULL-terminated. - @retval NULL an error ocurred + @retval NULL an error occurred @retval NULL Alias was not a valid Alias **/ CONST CHAR16 * @@ -915,7 +915,7 @@ InternalEfiShellSetEnv( feature's enabled state was not known when the shell initially launched. =20 @retval EFI_SUCCESS The feature is enabled. - @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available. + @retval EFI_OUT_OF_RESOURCES There is not enough memory available. **/ EFI_STATUS InernalEfiShellStartMonitor( diff --git a/ShellPkg/Application/Shell/ConsoleLogger.c b/ShellPkg/Applicat= ion/Shell/ConsoleLogger.c index 6c4e26265407..36ba3ac2254c 100644 --- a/ShellPkg/Application/Shell/ConsoleLogger.c +++ b/ShellPkg/Application/Shell/ConsoleLogger.c @@ -310,9 +310,9 @@ UpdateDisplayFromHistory( StringSegment =3D &Screen[Column]; =20 // - // Find the first char with a different arrribute and make that te= mporarily NULL + // Find the first char with a different attribute and make that te= mporarily NULL // so we can do fewer printout statements. (later) restore that o= ne and we will - // start at that collumn on the next loop. + // start at that column on the next loop. // StringSegmentEndChar =3D CHAR_NULL; for ( StringSegmentEnd =3D StringSegment @@ -395,7 +395,7 @@ UpdateDisplayFromHistory( } =20 /** - Reset the text output device hardware and optionaly run diagnostics + Reset the text output device hardware and optionally run diagnostics =20 @param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param ExtendedVerification Indicates that a more extensive test may be = performed @@ -723,7 +723,7 @@ ConsoleLoggerPrintWithPageBreak( ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo); =20 // - // restore the temp NULL terminator to it's original character + // restore the temp NULL terminator to its original character // *((CHAR16*)(Walker+1)) =3D TempChar; =20 @@ -770,7 +770,7 @@ ConsoleLoggerPrintWithPageBreak( ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo); =20 // - // restore the temp NULL terminator to it's original character + // restore the temp NULL terminator to its original character // *((CHAR16*)(Walker+1)) =3D TempChar; =20 @@ -1189,7 +1189,7 @@ ConsoleLoggerEnableCursor ( =20 @param[in] ConsoleInfo The pointer to the instance of the console logge= r information. =20 - This will be used when a mode has changed or a reset ocurred to verify a= ll + This will be used when a mode has changed or a reset occurred to verify = all history buffers. **/ EFI_STATUS diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Applic= ation/Shell/ConsoleWrappers.c index b573b53cf4f3..ec340de4e128 100644 --- a/ShellPkg/Application/Shell/ConsoleWrappers.c +++ b/ShellPkg/Application/Shell/ConsoleWrappers.c @@ -220,7 +220,7 @@ CloseSimpleTextInOnFile( } =20 /** - Reset the text output device hardware and optionaly run diagnostics. + Reset the text output device hardware and optionally run diagnostics. =20 @param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param ExtendedVerification Indicates that a more extensive test may be = performed diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c b/ShellPkg/App= lication/Shell/FileHandleWrappers.c index 2d7bd7bec67e..a622a763f85e 100644 --- a/ShellPkg/Application/Shell/FileHandleWrappers.c +++ b/ShellPkg/Application/Shell/FileHandleWrappers.c @@ -517,7 +517,7 @@ FileInterfaceStdInRead( gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &TotalColu= mn, &TotalRow); =20 // - // Limit the line length to the buffer size or the minimun size of the + // Limit the line length to the buffer size or the minimum size of the // screen. (The smaller takes effect) // MaxStr =3D TotalColumn * (TotalRow - 1) - StartColumn; @@ -865,7 +865,7 @@ FileInterfaceStdInRead( // if (Key.UnicodeChar !=3D CHAR_BACKSPACE && !(Key.UnicodeChar =3D=3D = 0 && Key.ScanCode =3D=3D SCAN_DELETE)) { // - // Calulate row and column of the tail of current string + // Calculate row and column of the tail of current string // TailRow =3D Row + (StringLen - StringCurPos + Column + OutputL= ength) / TotalColumn; TailColumn =3D (StringLen - StringCurPos + Column + OutputLength)= % TotalColumn; @@ -932,7 +932,7 @@ FileInterfaceStdInRead( } =20 // -// FILE sytle interfaces for StdIn/StdOut/StdErr +// FILE style interfaces for StdIn/StdOut/StdErr // EFI_FILE_PROTOCOL FileInterfaceStdIn =3D { EFI_FILE_REVISION, @@ -1069,7 +1069,7 @@ FileInterfaceEnvClose( ) { ((CHAR16*)NewBuffer)[TotalSize / sizeof (CHAR16) - 3] =3D CHAR_NUL= L; // - // If the NewBuffer end with \r\n\0, We will repace '\r' by '\0' a= nd then update TotalSize. + // If the NewBuffer end with \r\n\0, We will replace '\r' by '\0' = and then update TotalSize. // TotalSize -=3D sizeof(CHAR16) * 2; } diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shel= l/Shell.c index d16adae0ea30..a5563070972e 100644 --- a/ShellPkg/Application/Shell/Shell.c +++ b/ShellPkg/Application/Shell/Shell.c @@ -1081,7 +1081,7 @@ ProcessCommandLine( } } // - // If an argumnent contains a space, then add double quotes before= the argument + // If an argument contains a space, then add double quotes before = the argument // if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") !=3D= NULL) { StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions, @@ -1102,7 +1102,7 @@ ProcessCommandLine( return (EFI_OUT_OF_RESOURCES); } // - // If an argumnent contains a space, then add double quotes after = the argument + // If an argument contains a space, then add double quotes after t= he argument // if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") !=3D= NULL) { StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions, @@ -1176,7 +1176,7 @@ LocateStartupScript ( } =20 // - // Try to find 'Startup.nsh' in the execution path defined by the envrio= nment variable PATH. + // Try to find 'Startup.nsh' in the execution path defined by the enviro= nment variable PATH. // if ((StartupScriptPath =3D=3D NULL) || EFI_ERROR (ShellIsFile (StartupSc= riptPath))) { SHELL_FREE_NON_NULL (StartupScriptPath); @@ -2251,7 +2251,7 @@ SetLastError( } =20 /** - Converts the command line to it's post-processed form. this replaces va= riables and alias' per UEFI Shell spec. + Converts the command line to its post-processed form. this replaces var= iables and alias' per UEFI Shell spec. =20 @param[in,out] CmdLine pointer to the command line to update =20 diff --git a/ShellPkg/Application/Shell/ShellEnvVar.c b/ShellPkg/Applicatio= n/Shell/ShellEnvVar.c index dbeb8216986a..04fed3bf9141 100644 --- a/ShellPkg/Application/Shell/ShellEnvVar.c +++ b/ShellPkg/Application/Shell/ShellEnvVar.c @@ -118,7 +118,7 @@ FreeEnvironmentVariableList( @param[in, out] ListHead The pointer to pointer to LIST ENTRY obje= ct for storing this list. =20 - @retval EFI_SUCCESS the list was created sucessfully. + @retval EFI_SUCCESS the list was created successfully. **/ EFI_STATUS GetEnvironmentVariableList( @@ -233,7 +233,7 @@ GetEnvironmentVariableList( @param[in] ListHead The pointer to LIST_ENTRY from GetShellEnvVarList(). =20 - @retval EFI_SUCCESS the list was Set sucessfully. + @retval EFI_SUCCESS the list was Set successfully. **/ EFI_STATUS SetEnvironmentVariableList( @@ -266,7 +266,7 @@ SetEnvironmentVariableList( FreeEnvironmentVariableList(&VarList.Link); =20 // - // set all the variables fron the list + // set all the variables from the list // for ( Node =3D (ENV_VAR_LIST*)GetFirstNode(ListHead) ; !IsNull(ListHead, &Node->Link) @@ -479,7 +479,7 @@ ShellAddEnvVarToList ( } =20 // - // If the environment varialbe key doesn't exist in list just insert + // If the environment variable key doesn't exist in list just insert // a new node. // LocalKey =3D AllocateCopyPool (StrSize(Key), Key); diff --git a/ShellPkg/Application/Shell/ShellManParser.c b/ShellPkg/Applica= tion/Shell/ShellManParser.c index 4d5a5668aa15..d5a85cb8cc3f 100644 --- a/ShellPkg/Application/Shell/ShellManParser.c +++ b/ShellPkg/Application/Shell/ShellManParser.c @@ -179,12 +179,12 @@ SearchPathForFile( } =20 /** - parses through the MAN file specified by SHELL_FILE_HANDLE and returns t= he - detailed help for any sub section specified in the comma seperated list = of + Parses through the MAN file specified by SHELL_FILE_HANDLE and returns t= he + detailed help for any sub section specified in the comma separated list = of sections provided. If the end of the file or a .TH section is found the= n return. =20 - Upon a sucessful return the caller is responsible to free the memory in = *HelpText + Upon a successful return the caller is responsible to free the memory in= *HelpText =20 @param[in] Handle FileHandle to read from @param[in] Sections name of command's sub sections to find @@ -193,8 +193,8 @@ SearchPathForFile( @param[in] Ascii TRUE if the file is ASCII, FALSE otherwise= . =20 @retval EFI_OUT_OF_RESOURCES a memory allocation failed. - @retval EFI_SUCCESS the section was found and its description = sotred in - an alloceted buffer. + @retval EFI_SUCCESS the section was found and its description = stored in + an allocated buffer. **/ EFI_STATUS ManFileFindSections( @@ -296,11 +296,11 @@ ManFileFindSections( /** Parses a line from a MAN file to see if it is the Title Header. If it is= , then if the "Brief Description" is desired, allocate a buffer for it and retu= rn a - copy. Upon a sucessful return the caller is responsible to free the memo= ry in + copy. Upon a successful return the caller is responsible to free the mem= ory in *BriefDesc =20 Uses a simple state machine that allows "unlimited" whitespace before an= d after the - ".TH", compares Command and the MAN file commnd name without respect to = case, and + ".TH", compares Command and the MAN file command name without respect to= case, and allows "unlimited" whitespace and '0' and '1' characters before the Shor= t Description. The PCRE regex describing this functionality is: ^\s*\.TH\s+(\S)\s[\s01]= *(.*)$ where group 1 is the Command Name and group 2 is the Short Description. @@ -421,11 +421,11 @@ IsTitleHeader( } =20 /** - parses through the MAN file specified by SHELL_FILE_HANDLE and returns t= he + Parses through the MAN file specified by SHELL_FILE_HANDLE and returns t= he "Brief Description" for the .TH section as specified by Command. If the command section is not found return EFI_NOT_FOUND. =20 - Upon a sucessful return the caller is responsible to free the memory in = *BriefDesc + Upon a successful return the caller is responsible to free the memory in= *BriefDesc =20 @param[in] Handle FileHandle to read from @param[in] Command name of command's section to find as ente= red on the @@ -512,7 +512,7 @@ ManFileFindTitleSection( information will be returned. If Sections is NULL, then all help text in= formation available will be returned. =20 - if BriefDesc is NULL, then the breif description will not be savedd sepe= ratly, + if BriefDesc is NULL, then the breif description will not be saved separ= ately, but placed first in the main HelpText. =20 @param[in] ManFileName Points to the NULL-terminated UEFI Shell M= AN file name. diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPk= g/Application/Shell/ShellParametersProtocol.c index bcd8f0ae2112..ef3966d3b08f 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -69,13 +69,13 @@ FindEndOfParameter( This will also remove all remaining ^ characters after processing. =20 @param[in, out] Walker pointer to string of command line. Adju= sted to - reminaing command line on return + remaining command line on return @param[in, out] TempParameter pointer to string of command line item e= xtracted. @param[in] Length buffer size of TempParameter. @param[in] StripQuotation if TRUE then strip the quotation marks s= urrounding the parameters. =20 - @return EFI_INALID_PARAMETER A required parameter was NULL or pointed= to a NULL or empty string. + @return EFI_INVALID_PARAMETER A required parameter was NULL or pointed= to a NULL or empty string. @return EFI_NOT_FOUND A closing " could not be found on the sp= ecified string **/ EFI_STATUS @@ -126,7 +126,7 @@ DEBUG_CODE_END(); StrnCpyS(*TempParameter, Length / sizeof(CHAR16), (*Walker), NextDelim -= *Walker); =20 // - // Add a CHAR_NULL if we didnt get one via the copy + // Add a CHAR_NULL if we didn't get one via the copy // if (*NextDelim !=3D CHAR_NULL) { (*TempParameter)[NextDelim - *Walker] =3D CHAR_NULL; @@ -184,7 +184,7 @@ DEBUG_CODE_END(); @param[in, out] Argv pointer to array of strings; one for eac= h parameter @param[in, out] Argc pointer to number of strings in Argv arr= ay =20 - @return EFI_SUCCESS the operation was sucessful + @return EFI_SUCCESS the operation was successful @return EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS @@ -416,7 +416,7 @@ CreatePopulateInstallShellParametersProtocol ( } =20 /** - frees all memory used by createion and installation of shell parameters = protocol + frees all memory used by creation and installation of shell parameters p= rotocol and if there was an old version installed it will restore that one. =20 @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL= that is @@ -466,7 +466,7 @@ CleanUpShellParametersProtocol ( } =20 /** - Determin if a file name represents a unicode file. + Determine if a file name represents a unicode file. =20 @param[in] FileName Pointer to the filename to open. =20 @@ -526,7 +526,7 @@ StripQuotes ( } =20 /** - Calcualte the 32-bit CRC in a EFI table using the service provided by th= e + Calculate the 32-bit CRC in a EFI table using the service provided by th= e gRuntime service. =20 @param Hdr Pointer to an EFI standard header @@ -651,7 +651,7 @@ WriteFileTag ( =20 =20 /** - Funcion will replace the current StdIn and StdOut in the ShellParameters= protocol + Function will replace the current StdIn and StdOut in the ShellParameter= s protocol structure by parsing NewCommandLine. The current values are returned to= the user. =20 @@ -664,7 +664,7 @@ WriteFileTag ( @param[out] OldStdErr Pointer to old StdErr. @param[out] SystemTableInfo Pointer to old system table infor= mation. =20 - @retval EFI_SUCCESS Operation was sucessful, Argv and = Argc are valid. + @retval EFI_SUCCESS Operation was successful, Argv and= Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. **/ EFI_STATUS @@ -1257,7 +1257,7 @@ UpdateStdInStdOutStdErr( } =20 /** - Funcion will replace the current StdIn and StdOut in the ShellParameters= protocol + Function will replace the current StdIn and StdOut in the ShellParameter= s protocol structure with StdIn and StdOut. The current values are de-allocated. =20 @param[in, out] ShellParameters Pointer to parameter structure to m= odify. @@ -1327,7 +1327,7 @@ RestoreStdInStdOutStdErr ( return (EFI_SUCCESS); } /** - Funcion will replace the current Argc and Argv in the ShellParameters pr= otocol + Function will replace the current Argc and Argv in the ShellParameters p= rotocol structure by parsing NewCommandLine. The current values are returned to= the user. =20 @@ -1339,7 +1339,7 @@ RestoreStdInStdOutStdErr ( @param[out] OldArgv Pointer to old list of parameters= . @param[out] OldArgc Pointer to old number of items in= Argv list. =20 - @retval EFI_SUCCESS Operation was sucessful, Argv and = Argc are valid. + @retval EFI_SUCCESS Operation was successful, Argv and= Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. **/ EFI_STATUS @@ -1375,7 +1375,7 @@ UpdateArgcArgv( } =20 /** - Funcion will replace the current Argc and Argv in the ShellParameters pr= otocol + Function will replace the current Argc and Argv in the ShellParameters p= rotocol structure with Argv and Argc. The current values are de-allocated and t= he OldArgv must not be deallocated by the caller. =20 diff --git a/ShellPkg/Application/Shell/ShellProtocol.c b/ShellPkg/Applicat= ion/Shell/ShellProtocol.c index f0362a42d893..4e639fe35e4f 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.c +++ b/ShellPkg/Application/Shell/ShellProtocol.c @@ -96,7 +96,7 @@ InternalShellProtocolIsSimpleFileSystemPresent( /** This function creates a mapping for a device path. =20 - If both DeviecPath and Mapping are NULL, this will reset the mapping to = default values. + If both DevicePath and Mapping are NULL, this will reset the mapping to = default values. =20 @param DevicePath Points to the device path. If this is NULL= and Mapping points to a valid mapping, then the mapping will be deleted. @@ -152,7 +152,7 @@ EfiShellSetMap( } // for loop =20 // - // We didnt find one to delete + // We didn't find one to delete // return (EFI_NOT_FOUND); } @@ -232,7 +232,7 @@ EfiShellGetDevicePathFromMap( device path. If there is an exact match, the mapping is returned and *De= vicePath points to the end-of-device-path node. =20 - If there are multiple map names they will be semi-colon seperated in the + If there are multiple map names they will be semi-colon separated in the NULL-terminated string. =20 @param DevicePath On entry, points to a device path pointer.= On @@ -910,8 +910,8 @@ EfiShellBatchIsActive ( @param Attributes the File Attributes to use when creating= a new file. =20 @retval EFI_SUCCESS the file is open and FileHandle is valid - @retval EFI_UNSUPPORTED the device path cotained non-path elemen= ts - @retval other an error ocurred. + @retval EFI_UNSUPPORTED the device path contained non-path eleme= nts + @retval other an error occurred. **/ EFI_STATUS InternalOpenFileDevicePath( @@ -946,7 +946,7 @@ InternalOpenFileDevicePath( Handle1 =3D ConvertShellHandleToEfiFileProtocol(ShellHandle); if (Handle1 !=3D NULL) { // - // chop off the begining part before the file system part... + // chop off the beginning part before the file system part... // ///@todo BlockIo? Status =3D gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, @@ -1064,14 +1064,14 @@ InternalOpenFileDevicePath( already exists and is non-volatile then EFI_INVALID_PARAMETER is returne= d. =20 @param FileName Pointer to NULL-terminated file path - @param FileAttribs The new file's attrbiutes. the different attr= ibutes are + @param FileAttribs The new file's attributes. the different attr= ibutes are described in EFI_FILE_PROTOCOL.Open(). @param FileHandle On return, points to the created file handle o= r directory's handle =20 @retval EFI_SUCCESS The file was opened. FileHandle points to the= new file's handle. @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value= . @retval EFI_UNSUPPORTED could not open the file path - @retval EFI_NOT_FOUND the specified file could not be found on the d= evide, or could not + @retval EFI_NOT_FOUND the specified file could not be found on the d= evice, or could not file the file system on the device. @retval EFI_NO_MEDIA the device has no medium. @retval EFI_MEDIA_CHANGED The device has a different medium in it or the= medium is no @@ -1908,7 +1908,7 @@ typedef struct { @param[in] Node The node to copy from. @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise. =20 - @retval NULL a memory allocation error ocurred + @retval NULL a memory allocation error occurred @return !=3D NULL a pointer to the new node **/ EFI_SHELL_FILE_INFO* @@ -1960,7 +1960,7 @@ InternalDuplicateShellFileInfo( @param[in] Handle Handle member initial value. @param[in] Info Info struct to copy. =20 - @retval NULL An error ocurred. + @retval NULL An error occurred. @return a pointer to the newly allocated structure. **/ EFI_SHELL_FILE_INFO * @@ -2120,7 +2120,7 @@ EfiShellFindFilesInDir( // ShellFileListItem =3D CreateAndPopulateShellFileInfo( BasePath, - EFI_SUCCESS, // success since we didnt fail to open it... + EFI_SUCCESS, // success since we didn't fail to open it... FileInfo->FileName, NULL, // no handle since not open FileInfo); @@ -2706,7 +2706,7 @@ EfiShellGetEnvEx( Status =3D SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Att= ributes, &Size, Buffer); } // - // we didnt get it (might not exist) + // we didn't get it (might not exist) // free the memory if we allocated any and return NULL // if (EFI_ERROR(Status)) { @@ -2927,7 +2927,7 @@ EfiShellGetCurDir( directory is changed. @param Dir Points to the NULL-terminated directory on= the device specified by FileSystem. =20 - @retval EFI_SUCCESS The operation was sucessful + @retval EFI_SUCCESS The operation was successful @retval EFI_NOT_FOUND The file system could not be found **/ EFI_STATUS @@ -3179,12 +3179,12 @@ EfiShellIsRootShell( } =20 /** - function to return a semi-colon delimeted list of all alias' in the curr= ent shell + function to return a semi-colon delimited list of all alias' in the curr= ent shell =20 up to caller to free the memory. =20 @retval NULL No alias' were found - @retval NULL An error ocurred getting alias' + @retval NULL An error occurred getting alias' @return !NULL a list of all alias' **/ CHAR16 * @@ -3287,7 +3287,7 @@ ToLower ( If Alias is NULL, ReturnedData points to a= ';' delimited list of alias (e.g. ReturnedData =3D "dir;del;copy;mfp") that = is NULL-terminated. - @retval NULL an error ocurred + @retval NULL an error occurred @retval NULL Alias was not a valid Alias **/ CONST CHAR16 * @@ -3612,7 +3612,7 @@ CreatePopulateInstallShellProtocol ( (VOID*)(&mShellProtocol)); if (!EFI_ERROR(Status)) { // - // we reinstalled sucessfully. log this so we can reverse it la= ter. + // we reinstalled successfully. log this so we can reverse it l= ater. // =20 // @@ -3759,7 +3759,7 @@ NotificationFunction( feature's enabled state was not known when the shell initially launched. =20 @retval EFI_SUCCESS The feature is enabled. - @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available. + @retval EFI_OUT_OF_RESOURCES There is not enough memory available. **/ EFI_STATUS InernalEfiShellStartMonitor( diff --git a/ShellPkg/Application/ShellCTestApp/README.txt b/ShellPkg/Appli= cation/ShellCTestApp/README.txt index 02594e0d1208..d788d3ef62a9 100644 --- a/ShellPkg/Application/ShellCTestApp/README.txt +++ b/ShellPkg/Application/ShellCTestApp/README.txt @@ -1,5 +1,5 @@ TestArgv.nsh is a very simple shell script to test how the interpreter par= ses the parameters. It uses ShellCTestApp.efi to dump the parameters passed fr= om the -intepreter. +interpreter. =20 TestArgv.log is the desired output created using "TestArgv.nsh > TestArgv.= log". --=20 2.21.0