tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ShellPkg/Application: Fix various typos 

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>
This commit is contained in:
Antoine Coeur 2020-02-07 02:08:20 +01:00 committed by mergify[bot]
parent ba562ca040
commit 6a5033ca3e
16 changed files with 106 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ShellPkg/Application/Shell/ConsoleLogger.c
View File

@ -310,9 +310,9 @@ UpdateDisplayFromHistory(
StringSegment = &Screen[Column]; StringSegment = &Screen[Column];
// //
// Find the first char with a different arrribute and make that temporarily NULL // Find the first char with a different attribute and make that temporarily NULL
// so we can do fewer printout statements. (later) restore that one and we will // so we can do fewer printout statements. (later) restore that one and we will
// start at that collumn on the next loop. // start at that column on the next loop.
// //
StringSegmentEndChar = CHAR_NULL; StringSegmentEndChar = CHAR_NULL;
for ( StringSegmentEnd = StringSegment for ( StringSegmentEnd = StringSegment
@ -395,7 +395,7 @@ UpdateDisplayFromHistory(
} }
/** /**
Reset the text output device hardware and optionaly run diagnostics Reset the text output device hardware and optionally run diagnostics
@param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
@param ExtendedVerification Indicates that a more extensive test may be performed @param ExtendedVerification Indicates that a more extensive test may be performed
@ -723,7 +723,7 @@ ConsoleLoggerPrintWithPageBreak(
ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo); ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);
// //
// restore the temp NULL terminator to it's original character // restore the temp NULL terminator to its original character
// //
*((CHAR16*)(Walker+1)) = TempChar; *((CHAR16*)(Walker+1)) = TempChar;
@ -770,7 +770,7 @@ ConsoleLoggerPrintWithPageBreak(
ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo); ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);
// //
// restore the temp NULL terminator to it's original character // restore the temp NULL terminator to its original character
// //
*((CHAR16*)(Walker+1)) = TempChar; *((CHAR16*)(Walker+1)) = TempChar;
@ -1189,7 +1189,7 @@ ConsoleLoggerEnableCursor (
@param[in] ConsoleInfo The pointer to the instance of the console logger information. @param[in] ConsoleInfo The pointer to the instance of the console logger information.
This will be used when a mode has changed or a reset ocurred to verify all This will be used when a mode has changed or a reset occurred to verify all
history buffers. history buffers.
**/ **/
EFI_STATUS EFI_STATUS

4
ShellPkg/Application/Shell/ConsoleLogger.h
View File

@ -117,7 +117,7 @@ UpdateDisplayFromHistory(
); );
/** /**
Reset the text output device hardware and optionaly run diagnostics Reset the text output device hardware and optionally run diagnostics
@param This Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param This Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
@param ExtendedVerification Indicates that a more extensive test may be performed @param ExtendedVerification Indicates that a more extensive test may be performed
@ -305,7 +305,7 @@ ConsoleLoggerEnableCursor (
@param[in] ConsoleInfo The pointer to the instance of the console logger information. @param[in] ConsoleInfo The pointer to the instance of the console logger information.
This will be used when a mode has changed or a reset ocurred to verify all This will be used when a mode has changed or a reset occurred to verify all
history buffers. history buffers.
**/ **/
EFI_STATUS EFI_STATUS

2
ShellPkg/Application/Shell/ConsoleWrappers.c
View File

@ -220,7 +220,7 @@ CloseSimpleTextInOnFile(
} }
/** /**
Reset the text output device hardware and optionaly run diagnostics. Reset the text output device hardware and optionally run diagnostics.
@param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL @param This pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
@param ExtendedVerification Indicates that a more extensive test may be performed @param ExtendedVerification Indicates that a more extensive test may be performed

8
ShellPkg/Application/Shell/FileHandleWrappers.c
View File

@ -517,7 +517,7 @@ FileInterfaceStdInRead(
gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &TotalColumn, &TotalRow); gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &TotalColumn, &TotalRow);
// //
// 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) // screen. (The smaller takes effect)
// //
MaxStr = TotalColumn * (TotalRow - 1) - StartColumn; MaxStr = TotalColumn * (TotalRow - 1) - StartColumn;
@ -865,7 +865,7 @@ FileInterfaceStdInRead(
// //
if (Key.UnicodeChar != CHAR_BACKSPACE && !(Key.UnicodeChar == 0 && Key.ScanCode == SCAN_DELETE)) { if (Key.UnicodeChar != CHAR_BACKSPACE && !(Key.UnicodeChar == 0 && Key.ScanCode == SCAN_DELETE)) {
// //
// Calulate row and column of the tail of current string // Calculate row and column of the tail of current string
// //
TailRow = Row + (StringLen - StringCurPos + Column + OutputLength) / TotalColumn; TailRow = Row + (StringLen - StringCurPos + Column + OutputLength) / TotalColumn;
TailColumn = (StringLen - StringCurPos + Column + OutputLength) % TotalColumn; TailColumn = (StringLen - StringCurPos + Column + OutputLength) % TotalColumn;
@ -932,7 +932,7 @@ FileInterfaceStdInRead(
} }
// //
// FILE sytle interfaces for StdIn/StdOut/StdErr // FILE style interfaces for StdIn/StdOut/StdErr
// //
EFI_FILE_PROTOCOL FileInterfaceStdIn = { EFI_FILE_PROTOCOL FileInterfaceStdIn = {
EFI_FILE_REVISION, EFI_FILE_REVISION,
@ -1069,7 +1069,7 @@ FileInterfaceEnvClose(
) { ) {
((CHAR16*)NewBuffer)[TotalSize / sizeof (CHAR16) - 3] = CHAR_NULL; ((CHAR16*)NewBuffer)[TotalSize / sizeof (CHAR16) - 3] = CHAR_NULL;
// //
// If the NewBuffer end with \r\n\0, We will repace '\r' by '\0' and then update TotalSize. // If the NewBuffer end with \r\n\0, We will replace '\r' by '\0' and then update TotalSize.
// //
TotalSize -= sizeof(CHAR16) * 2; TotalSize -= sizeof(CHAR16) * 2;
} }

6
ShellPkg/Application/Shell/FileHandleWrappers.h
View File

@ -20,17 +20,17 @@ typedef struct {
} SHELL_LINE_LOG; } SHELL_LINE_LOG;
/// ///
/// FILE sytle interfaces for StdIn. /// FILE styte interfaces for StdIn.
/// ///
extern EFI_FILE_PROTOCOL FileInterfaceStdIn; extern EFI_FILE_PROTOCOL FileInterfaceStdIn;
/// ///
/// FILE sytle interfaces for StdOut. /// FILE styte interfaces for StdOut.
/// ///
extern EFI_FILE_PROTOCOL FileInterfaceStdOut; extern EFI_FILE_PROTOCOL FileInterfaceStdOut;
/// ///
/// FILE sytle interfaces for StdErr. /// FILE styte interfaces for StdErr.
/// ///
extern EFI_FILE_PROTOCOL FileInterfaceStdErr; extern EFI_FILE_PROTOCOL FileInterfaceStdErr;

8
ShellPkg/Application/Shell/Shell.c
View File

@ -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" ") != NULL) { if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") != NULL) {
StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions, StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
@ -1102,7 +1102,7 @@ ProcessCommandLine(
return (EFI_OUT_OF_RESOURCES); 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 the argument
// //
if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") != NULL) { if (StrStr (gEfiShellParametersProtocol->Argv[LoopVar], L" ") != NULL) {
StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions, StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
@ -1176,7 +1176,7 @@ LocateStartupScript (
} }
// //
// Try to find 'Startup.nsh' in the execution path defined by the envrionment variable PATH. // Try to find 'Startup.nsh' in the execution path defined by the environment variable PATH.
// //
if ((StartupScriptPath == NULL) || EFI_ERROR (ShellIsFile (StartupScriptPath))) { if ((StartupScriptPath == NULL) || EFI_ERROR (ShellIsFile (StartupScriptPath))) {
SHELL_FREE_NON_NULL (StartupScriptPath); SHELL_FREE_NON_NULL (StartupScriptPath);
@ -2251,7 +2251,7 @@ SetLastError(
} }
/** /**
Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec. Converts the command line to its post-processed form. this replaces variables and alias' per UEFI Shell spec.
@param[in,out] CmdLine pointer to the command line to update @param[in,out] CmdLine pointer to the command line to update

2
ShellPkg/Application/Shell/Shell.h
View File

@ -135,7 +135,7 @@ typedef struct {
extern SHELL_INFO ShellInfoObject; extern SHELL_INFO ShellInfoObject;
/** /**
Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec. Converts the command line to its post-processed form. this replaces variables and alias' per UEFI Shell spec.
@param[in,out] CmdLine pointer to the command line to update @param[in,out] CmdLine pointer to the command line to update

8
ShellPkg/Application/Shell/ShellEnvVar.c
View File

@ -118,7 +118,7 @@ FreeEnvironmentVariableList(
@param[in, out] ListHead The pointer to pointer to LIST ENTRY object for @param[in, out] ListHead The pointer to pointer to LIST ENTRY object for
storing this list. storing this list.
@retval EFI_SUCCESS the list was created sucessfully. @retval EFI_SUCCESS the list was created successfully.
**/ **/
EFI_STATUS EFI_STATUS
GetEnvironmentVariableList( GetEnvironmentVariableList(
@ -233,7 +233,7 @@ GetEnvironmentVariableList(
@param[in] ListHead The pointer to LIST_ENTRY from @param[in] ListHead The pointer to LIST_ENTRY from
GetShellEnvVarList(). GetShellEnvVarList().
@retval EFI_SUCCESS the list was Set sucessfully. @retval EFI_SUCCESS the list was Set successfully.
**/ **/
EFI_STATUS EFI_STATUS
SetEnvironmentVariableList( SetEnvironmentVariableList(
@ -266,7 +266,7 @@ SetEnvironmentVariableList(
FreeEnvironmentVariableList(&VarList.Link); FreeEnvironmentVariableList(&VarList.Link);
// //
// set all the variables fron the list // set all the variables from the list
// //
for ( Node = (ENV_VAR_LIST*)GetFirstNode(ListHead) for ( Node = (ENV_VAR_LIST*)GetFirstNode(ListHead)
; !IsNull(ListHead, &Node->Link) ; !IsNull(ListHead, &Node->Link)
@ -479,7 +479,7 @@ ShellAddEnvVarToList (
} }
// //
// 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. // a new node.
// //
LocalKey = AllocateCopyPool (StrSize(Key), Key); LocalKey = AllocateCopyPool (StrSize(Key), Key);

36
ShellPkg/Application/Shell/ShellEnvVar.h
View File

@ -43,14 +43,14 @@ IsVolatileEnv (
); );
/** /**
Delete a Non-Violatile environment variable. Delete a Non-Volatile environment variable.
This will use the Runtime Services call SetVariable to remove a non-violatile variable. This will use the Runtime Services call SetVariable to remove a non-volatile variable.
@param EnvVarName The name of the environment variable in question @param EnvVarName The name of the environment variable in question
@retval EFI_SUCCESS The variable was deleted sucessfully @retval EFI_SUCCESS The variable was deleted successfully
@retval other An error ocurred @retval other An error occurred
@sa SetVariable @sa SetVariable
**/ **/
#define SHELL_DELETE_ENVIRONMENT_VARIABLE(EnvVarName) \ #define SHELL_DELETE_ENVIRONMENT_VARIABLE(EnvVarName) \
@ -61,16 +61,16 @@ IsVolatileEnv (
NULL)) NULL))
/** /**
Set a Non-Violatile environment variable. Set a Non-Volatile environment variable.
This will use the Runtime Services call SetVariable to set a non-violatile variable. This will use the Runtime Services call SetVariable to set a non-volatile variable.
@param EnvVarName The name of the environment variable in question @param EnvVarName The name of the environment variable in question
@param BufferSize UINTN size of Buffer @param BufferSize UINTN size of Buffer
@param Buffer Pointer to value to set variable to @param Buffer Pointer to value to set variable to
@retval EFI_SUCCESS The variable was changed sucessfully @retval EFI_SUCCESS The variable was changed successfully
@retval other An error ocurred @retval other An error occurred
@sa SetVariable @sa SetVariable
**/ **/
#define SHELL_SET_ENVIRONMENT_VARIABLE_NV(EnvVarName,BufferSize,Buffer) \ #define SHELL_SET_ENVIRONMENT_VARIABLE_NV(EnvVarName,BufferSize,Buffer) \
@ -89,8 +89,8 @@ IsVolatileEnv (
@param BufferSize Pointer to the UINTN size of Buffer @param BufferSize Pointer to the UINTN size of Buffer
@param Buffer Pointer buffer to get variable value into @param Buffer Pointer buffer to get variable value into
@retval EFI_SUCCESS The variable's value was retrieved sucessfully @retval EFI_SUCCESS The variable's value was retrieved successfully
@retval other An error ocurred @retval other An error occurred
@sa SetVariable @sa SetVariable
**/ **/
#define SHELL_GET_ENVIRONMENT_VARIABLE(EnvVarName,BufferSize,Buffer) \ #define SHELL_GET_ENVIRONMENT_VARIABLE(EnvVarName,BufferSize,Buffer) \
@ -110,8 +110,8 @@ IsVolatileEnv (
@param BufferSize Pointer to the UINTN size of Buffer @param BufferSize Pointer to the UINTN size of Buffer
@param Buffer Pointer buffer to get variable value into @param Buffer Pointer buffer to get variable value into
@retval EFI_SUCCESS The variable's value was retrieved sucessfully @retval EFI_SUCCESS The variable's value was retrieved successfully
@retval other An error ocurred @retval other An error occurred
@sa SetVariable @sa SetVariable
**/ **/
#define SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(EnvVarName,Atts,BufferSize,Buffer) \ #define SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(EnvVarName,Atts,BufferSize,Buffer) \
@ -122,16 +122,16 @@ IsVolatileEnv (
Buffer)) Buffer))
/** /**
Set a Violatile environment variable. Set a Volatile environment variable.
This will use the Runtime Services call SetVariable to set a violatile variable. This will use the Runtime Services call SetVariable to set a volatile variable.
@param EnvVarName The name of the environment variable in question @param EnvVarName The name of the environment variable in question
@param BufferSize UINTN size of Buffer @param BufferSize UINTN size of Buffer
@param Buffer Pointer to value to set variable to @param Buffer Pointer to value to set variable to
@retval EFI_SUCCESS The variable was changed sucessfully @retval EFI_SUCCESS The variable was changed successfully
@retval other An error ocurred @retval other An error occurred
@sa SetVariable @sa SetVariable
**/ **/
#define SHELL_SET_ENVIRONMENT_VARIABLE_V(EnvVarName,BufferSize,Buffer) \ #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 object for @param[in, out] List The pointer to pointer to LIST_ENTRY object for
storing this list. storing this list.
@retval EFI_SUCCESS the list was created sucessfully. @retval EFI_SUCCESS the list was created successfully.
**/ **/
EFI_STATUS EFI_STATUS
GetEnvironmentVariableList( GetEnvironmentVariableList(
@ -164,7 +164,7 @@ GetEnvironmentVariableList(
@param[in] List The pointer to LIST_ENTRY from @param[in] List The pointer to LIST_ENTRY from
GetShellEnvVarList(). GetShellEnvVarList().
@retval EFI_SUCCESS The list was Set sucessfully. @retval EFI_SUCCESS The list was Set successfully.
**/ **/
EFI_STATUS EFI_STATUS
SetEnvironmentVariableList( SetEnvironmentVariableList(

20
ShellPkg/Application/Shell/ShellManParser.c
View File

@ -179,12 +179,12 @@ SearchPathForFile(
} }
/** /**
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the Parses through the MAN file specified by SHELL_FILE_HANDLE and returns the
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 then sections provided. If the end of the file or a .TH section is found then
return. return.
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
@param[in] Handle FileHandle to read from @param[in] Handle FileHandle to read from
@param[in] Sections name of command's sub sections to find @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. @param[in] Ascii TRUE if the file is ASCII, FALSE otherwise.
@retval EFI_OUT_OF_RESOURCES a memory allocation failed. @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
@retval EFI_SUCCESS the section was found and its description sotred in @retval EFI_SUCCESS the section was found and its description stored in
an alloceted buffer. an allocated buffer.
**/ **/
EFI_STATUS EFI_STATUS
ManFileFindSections( 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 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 return a if the "Brief Description" is desired, allocate a buffer for it and return a
copy. Upon a sucessful return the caller is responsible to free the memory in copy. Upon a successful return the caller is responsible to free the memory in
*BriefDesc *BriefDesc
Uses a simple state machine that allows "unlimited" whitespace before and after the Uses a simple state machine that allows "unlimited" whitespace before and 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 Short Description. allows "unlimited" whitespace and '0' and '1' characters before the Short Description.
The PCRE regex describing this functionality is: ^\s*\.TH\s+(\S)\s[\s01]*(.*)$ 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. where group 1 is the Command Name and group 2 is the Short Description.
@ -421,11 +421,11 @@ IsTitleHeader(
} }
/** /**
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the Parses through the MAN file specified by SHELL_FILE_HANDLE and returns the
"Brief Description" for the .TH section as specified by Command. If the "Brief Description" for the .TH section as specified by Command. If the
command section is not found return EFI_NOT_FOUND. command section is not found return EFI_NOT_FOUND.
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
@param[in] Handle FileHandle to read from @param[in] Handle FileHandle to read from
@param[in] Command name of command's section to find as entered on the @param[in] Command name of command's section to find as entered on the
@ -512,7 +512,7 @@ ManFileFindTitleSection(
information will be returned. If Sections is NULL, then all help text information information will be returned. If Sections is NULL, then all help text information
available will be returned. available will be returned.
if BriefDesc is NULL, then the breif description will not be savedd seperatly, if BriefDesc is NULL, then the breif description will not be saved separately,
but placed first in the main HelpText. but placed first in the main HelpText.
@param[in] ManFileName Points to the NULL-terminated UEFI Shell MAN file name. @param[in] ManFileName Points to the NULL-terminated UEFI Shell MAN file name.

10
ShellPkg/Application/Shell/ShellManParser.h
View File

@ -19,7 +19,7 @@
information will be returned. If Sections is NULL, then all help text information information will be returned. If Sections is NULL, then all help text information
available will be returned. available will be returned.
if BriefDesc is NULL, then the breif description will not be savedd seperatly, if BriefDesc is NULL, then the breif description will not be savedd separately,
but placed first in the main HelpText. but placed first in the main HelpText.
@param[in] ManFileName Points to the NULL-terminated UEFI Shell MAN file name. @param[in] ManFileName Points to the NULL-terminated UEFI Shell MAN file name.
@ -49,11 +49,11 @@ ProcessManFile(
/** /**
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the parses through the MAN file specified by SHELL_FILE_HANDLE and returns the
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 then sections provided. If the end of the file or a .TH section is found then
return. return.
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
@param[in] Handle FileHandle to read from @param[in] Handle FileHandle to read from
@param[in] Sections name of command's sub sections to find @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. @param[in] Ascii TRUE if the file is ASCII, FALSE otherwise.
@retval EFI_OUT_OF_RESOURCES a memory allocation failed. @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
@retval EFI_SUCCESS the section was found and its description sotred in @retval EFI_SUCCESS the section was found and its description stored in
an alloceted buffer. an allocated buffer.
**/ **/
EFI_STATUS EFI_STATUS
ManFileFindSections( ManFileFindSections(

26
ShellPkg/Application/Shell/ShellParametersProtocol.c
View File

@ -69,13 +69,13 @@ FindEndOfParameter(
This will also remove all remaining ^ characters after processing. This will also remove all remaining ^ characters after processing.
@param[in, out] Walker pointer to string of command line. Adjusted to @param[in, out] Walker pointer to string of command line. Adjusted to
reminaing command line on return remaining command line on return
@param[in, out] TempParameter pointer to string of command line item extracted. @param[in, out] TempParameter pointer to string of command line item extracted.
@param[in] Length buffer size of TempParameter. @param[in] Length buffer size of TempParameter.
@param[in] StripQuotation if TRUE then strip the quotation marks surrounding @param[in] StripQuotation if TRUE then strip the quotation marks surrounding
the parameters. the parameters.
@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 specified string @return EFI_NOT_FOUND A closing " could not be found on the specified string
**/ **/
EFI_STATUS EFI_STATUS
@ -126,7 +126,7 @@ DEBUG_CODE_END();
StrnCpyS(*TempParameter, Length / sizeof(CHAR16), (*Walker), NextDelim - *Walker); StrnCpyS(*TempParameter, Length / sizeof(CHAR16), (*Walker), NextDelim - *Walker);
// //
// 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 != CHAR_NULL) { if (*NextDelim != CHAR_NULL) {
(*TempParameter)[NextDelim - *Walker] = CHAR_NULL; (*TempParameter)[NextDelim - *Walker] = CHAR_NULL;
@ -184,7 +184,7 @@ DEBUG_CODE_END();
@param[in, out] Argv pointer to array of strings; one for each parameter @param[in, out] Argv pointer to array of strings; one for each parameter
@param[in, out] Argc pointer to number of strings in Argv array @param[in, out] Argc pointer to number of strings in Argv array
@return EFI_SUCCESS the operation was sucessful @return EFI_SUCCESS the operation was successful
@return EFI_OUT_OF_RESOURCES a memory allocation failed. @return EFI_OUT_OF_RESOURCES a memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -416,7 +416,7 @@ CreatePopulateInstallShellParametersProtocol (
} }
/** /**
frees all memory used by createion and installation of shell parameters protocol frees all memory used by creation and installation of shell parameters protocol
and if there was an old version installed it will restore that one. and if there was an old version installed it will restore that one.
@param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is
@ -466,7 +466,7 @@ CleanUpShellParametersProtocol (
} }
/** /**
Determin if a file name represents a unicode file. Determine if a file name represents a unicode file.
@param[in] FileName Pointer to the filename to open. @param[in] FileName Pointer to the filename to open.
@ -526,7 +526,7 @@ StripQuotes (
} }
/** /**
Calcualte the 32-bit CRC in a EFI table using the service provided by the Calculate the 32-bit CRC in a EFI table using the service provided by the
gRuntime service. gRuntime service.
@param Hdr Pointer to an EFI standard header @param Hdr Pointer to an EFI standard header
@ -651,7 +651,7 @@ WriteFileTag (
/** /**
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol Function will replace the current StdIn and StdOut in the ShellParameters protocol
structure by parsing NewCommandLine. The current values are returned to the structure by parsing NewCommandLine. The current values are returned to the
user. user.
@ -664,7 +664,7 @@ WriteFileTag (
@param[out] OldStdErr Pointer to old StdErr. @param[out] OldStdErr Pointer to old StdErr.
@param[out] SystemTableInfo Pointer to old system table information. @param[out] SystemTableInfo Pointer to old system table information.
@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. @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -1257,7 +1257,7 @@ UpdateStdInStdOutStdErr(
} }
/** /**
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol Function will replace the current StdIn and StdOut in the ShellParameters protocol
structure with StdIn and StdOut. The current values are de-allocated. structure with StdIn and StdOut. The current values are de-allocated.
@param[in, out] ShellParameters Pointer to parameter structure to modify. @param[in, out] ShellParameters Pointer to parameter structure to modify.
@ -1327,7 +1327,7 @@ RestoreStdInStdOutStdErr (
return (EFI_SUCCESS); return (EFI_SUCCESS);
} }
/** /**
Funcion will replace the current Argc and Argv in the ShellParameters protocol Function will replace the current Argc and Argv in the ShellParameters protocol
structure by parsing NewCommandLine. The current values are returned to the structure by parsing NewCommandLine. The current values are returned to the
user. user.
@ -1339,7 +1339,7 @@ RestoreStdInStdOutStdErr (
@param[out] OldArgv Pointer to old list of parameters. @param[out] OldArgv Pointer to old list of parameters.
@param[out] OldArgc Pointer to old number of items in Argv list. @param[out] OldArgc Pointer to old number of items in Argv list.
@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. @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -1375,7 +1375,7 @@ UpdateArgcArgv(
} }
/** /**
Funcion will replace the current Argc and Argv in the ShellParameters protocol Function will replace the current Argc and Argv in the ShellParameters protocol
structure with Argv and Argc. The current values are de-allocated and the structure with Argv and Argc. The current values are de-allocated and the
OldArgv must not be deallocated by the caller. OldArgv must not be deallocated by the caller.

20
ShellPkg/Application/Shell/ShellParametersProtocol.h
View File

@ -43,7 +43,7 @@ CreatePopulateInstallShellParametersProtocol (
); );
/** /**
frees all memory used by createion and installation of shell parameters protocol frees all memory used by creation and installation of shell parameters protocol
and if there was an old version installed it will restore that one. and if there was an old version installed it will restore that one.
@param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is
@ -60,7 +60,7 @@ CleanUpShellParametersProtocol (
); );
/** /**
Funcion will replace the current Argc and Argv in the ShellParameters protocol Function will replace the current Argc and Argv in the ShellParameters protocol
structure by parsing NewCommandLine. The current values are returned to the structure by parsing NewCommandLine. The current values are returned to the
user. user.
@ -70,7 +70,7 @@ CleanUpShellParametersProtocol (
@param[out] OldArgv pointer to old list of parameters @param[out] OldArgv pointer to old list of parameters
@param[out] OldArgc pointer to old number of items in Argv list @param[out] OldArgc pointer to old number of items in Argv list
@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. @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -83,7 +83,7 @@ UpdateArgcArgv(
); );
/** /**
Funcion will replace the current Argc and Argv in the ShellParameters protocol Function will replace the current Argc and Argv in the ShellParameters protocol
structure with Argv and Argc. The current values are de-allocated and the structure with Argv and Argc. The current values are de-allocated and the
OldArgv must not be deallocated by the caller. OldArgv must not be deallocated by the caller.
@ -108,7 +108,7 @@ typedef struct {
} SYSTEM_TABLE_INFO; } SYSTEM_TABLE_INFO;
/** /**
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol Function will replace the current StdIn and StdOut in the ShellParameters protocol
structure by parsing NewCommandLine. The current values are returned to the structure by parsing NewCommandLine. The current values are returned to the
user. user.
@ -121,7 +121,7 @@ typedef struct {
@param[out] OldStdErr Pointer to old StdErr. @param[out] OldStdErr Pointer to old StdErr.
@param[out] SystemTableInfo Pointer to old system table information. @param[out] SystemTableInfo Pointer to old system table information.
@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. @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -135,7 +135,7 @@ UpdateStdInStdOutStdErr(
); );
/** /**
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol Function will replace the current StdIn and StdOut in the ShellParameters protocol
structure with StdIn and StdOut. The current values are de-allocated. structure with StdIn and StdOut. The current values are de-allocated.
@param[in, out] ShellParameters Pointer to parameter structure to modify. @param[in, out] ShellParameters Pointer to parameter structure to modify.
@ -166,7 +166,7 @@ RestoreStdInStdOutStdErr (
@param[in, out] Argv pointer to array of strings; one for each parameter @param[in, out] Argv pointer to array of strings; one for each parameter
@param[in, out] Argc pointer to number of strings in Argv array @param[in, out] Argc pointer to number of strings in Argv array
@return EFI_SUCCESS the operation was sucessful @return EFI_SUCCESS the operation was successful
@return EFI_OUT_OF_RESOURCES a memory allocation failed. @return EFI_OUT_OF_RESOURCES a memory allocation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -188,13 +188,13 @@ ParseCommandLineToArgs(
function. function.
@param[in, out] Walker pointer to string of command line. Adjusted to @param[in, out] Walker pointer to string of command line. Adjusted to
reminaing command line on return remaining command line on return
@param[in, out] TempParameter pointer to string of command line item extracted. @param[in, out] TempParameter pointer to string of command line item extracted.
@param[in] Length Length of (*TempParameter) in bytes @param[in] Length Length of (*TempParameter) in bytes
@param[in] StripQuotation if TRUE then strip the quotation marks surrounding @param[in] StripQuotation if TRUE then strip the quotation marks surrounding
the parameters. the parameters.
@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 specified string @return EFI_NOT_FOUND A closing " could not be found on the specified string
**/ **/
EFI_STATUS EFI_STATUS

36
ShellPkg/Application/Shell/ShellProtocol.c
View File

@ -96,7 +96,7 @@ InternalShellProtocolIsSimpleFileSystemPresent(
/** /**
This function creates a mapping for a device path. This function creates a mapping for a device path.
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.
@param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping, @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
then the mapping will be deleted. then the mapping will be deleted.
@ -152,7 +152,7 @@ EfiShellSetMap(
} // for loop } // for loop
// //
// We didnt find one to delete // We didn't find one to delete
// //
return (EFI_NOT_FOUND); return (EFI_NOT_FOUND);
} }
@ -232,7 +232,7 @@ EfiShellGetDevicePathFromMap(
device path. If there is an exact match, the mapping is returned and *DevicePath device path. If there is an exact match, the mapping is returned and *DevicePath
points to the end-of-device-path node. points to the end-of-device-path node.
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. NULL-terminated string.
@param DevicePath On entry, points to a device path pointer. On @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. @param Attributes the File Attributes to use when creating a new file.
@retval EFI_SUCCESS the file is open and FileHandle is valid @retval EFI_SUCCESS the file is open and FileHandle is valid
@retval EFI_UNSUPPORTED the device path cotained non-path elements @retval EFI_UNSUPPORTED the device path contained non-path elements
@retval other an error ocurred. @retval other an error occurred.
**/ **/
EFI_STATUS EFI_STATUS
InternalOpenFileDevicePath( InternalOpenFileDevicePath(
@ -946,7 +946,7 @@ InternalOpenFileDevicePath(
Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle); Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle);
if (Handle1 != NULL) { if (Handle1 != NULL) {
// //
// chop off the begining part before the file system part... // chop off the beginning part before the file system part...
// //
///@todo BlockIo? ///@todo BlockIo?
Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,
@ -1064,14 +1064,14 @@ InternalOpenFileDevicePath(
already exists and is non-volatile then EFI_INVALID_PARAMETER is returned. already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
@param FileName Pointer to NULL-terminated file path @param FileName Pointer to NULL-terminated file path
@param FileAttribs The new file's attrbiutes. the different attributes are @param FileAttribs The new file's attributes. the different attributes are
described in EFI_FILE_PROTOCOL.Open(). described in EFI_FILE_PROTOCOL.Open().
@param FileHandle On return, points to the created file handle or directory's handle @param FileHandle On return, points to the created file handle or directory's handle
@retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle. @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_INVALID_PARAMETER One of the parameters has an invalid value.
@retval EFI_UNSUPPORTED could not open the file path @retval EFI_UNSUPPORTED could not open the file path
@retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not @retval EFI_NOT_FOUND the specified file could not be found on the device, or could not
file the file system on the device. file the file system on the device.
@retval EFI_NO_MEDIA the device has no medium. @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 @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] Node The node to copy from.
@param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise. @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
@retval NULL a memory allocation error ocurred @retval NULL a memory allocation error occurred
@return != NULL a pointer to the new node @return != NULL a pointer to the new node
**/ **/
EFI_SHELL_FILE_INFO* EFI_SHELL_FILE_INFO*
@ -1960,7 +1960,7 @@ InternalDuplicateShellFileInfo(
@param[in] Handle Handle member initial value. @param[in] Handle Handle member initial value.
@param[in] Info Info struct to copy. @param[in] Info Info struct to copy.
@retval NULL An error ocurred. @retval NULL An error occurred.
@return a pointer to the newly allocated structure. @return a pointer to the newly allocated structure.
**/ **/
EFI_SHELL_FILE_INFO * EFI_SHELL_FILE_INFO *
@ -2120,7 +2120,7 @@ EfiShellFindFilesInDir(
// //
ShellFileListItem = CreateAndPopulateShellFileInfo( ShellFileListItem = CreateAndPopulateShellFileInfo(
BasePath, BasePath,
EFI_SUCCESS, // success since we didnt fail to open it... EFI_SUCCESS, // success since we didn't fail to open it...
FileInfo->FileName, FileInfo->FileName,
NULL, // no handle since not open NULL, // no handle since not open
FileInfo); FileInfo);
@ -2706,7 +2706,7 @@ EfiShellGetEnvEx(
Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer); Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &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 // free the memory if we allocated any and return NULL
// //
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
@ -2927,7 +2927,7 @@ EfiShellGetCurDir(
directory is changed. directory is changed.
@param Dir Points to the NULL-terminated directory on the device specified by FileSystem. @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
@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 @retval EFI_NOT_FOUND The file system could not be found
**/ **/
EFI_STATUS EFI_STATUS
@ -3179,12 +3179,12 @@ EfiShellIsRootShell(
} }
/** /**
function to return a semi-colon delimeted list of all alias' in the current shell function to return a semi-colon delimited list of all alias' in the current shell
up to caller to free the memory. up to caller to free the memory.
@retval NULL No alias' were found @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' @return !NULL a list of all alias'
**/ **/
CHAR16 * CHAR16 *
@ -3287,7 +3287,7 @@ ToLower (
If Alias is NULL, ReturnedData points to a ';' If Alias is NULL, ReturnedData points to a ';'
delimited list of alias (e.g. delimited list of alias (e.g.
ReturnedData = "dir;del;copy;mfp") that is NULL-terminated. ReturnedData = "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 @retval NULL Alias was not a valid Alias
**/ **/
CONST CHAR16 * CONST CHAR16 *
@ -3612,7 +3612,7 @@ CreatePopulateInstallShellProtocol (
(VOID*)(&mShellProtocol)); (VOID*)(&mShellProtocol));
if (!EFI_ERROR(Status)) { if (!EFI_ERROR(Status)) {
// //
// we reinstalled sucessfully. log this so we can reverse it later. // we reinstalled successfully. log this so we can reverse it later.
// //
// //
@ -3759,7 +3759,7 @@ NotificationFunction(
feature's enabled state was not known when the shell initially launched. feature's enabled state was not known when the shell initially launched.
@retval EFI_SUCCESS The feature is enabled. @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 EFI_STATUS
InernalEfiShellStartMonitor( InernalEfiShellStartMonitor(

12
ShellPkg/Application/Shell/ShellProtocol.h
View File

@ -283,8 +283,8 @@ EfiShellBatchIsActive (
@param Attributes the File Attributes to use when creating a new file @param Attributes the File Attributes to use when creating a new file
@retval EFI_SUCCESS the file is open and FileHandle is valid @retval EFI_SUCCESS the file is open and FileHandle is valid
@retval EFI_UNSUPPORTED the device path cotained non-path elements @retval EFI_UNSUPPORTED the device path contained non-path elements
@retval other an error ocurred. @retval other an error occurred.
**/ **/
EFI_STATUS EFI_STATUS
InternalOpenFileDevicePath( InternalOpenFileDevicePath(
@ -309,7 +309,7 @@ InternalOpenFileDevicePath(
already exists and is non-volatile then EFI_INVALID_PARAMETER is returned. already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
@param FileName Pointer to NULL-terminated file path @param FileName Pointer to NULL-terminated file path
@param FileAttribs The new file's attrbiutes. the different attributes are @param FileAttribs The new file's attributes. the different attributes are
described in EFI_FILE_PROTOCOL.Open(). described in EFI_FILE_PROTOCOL.Open().
@param FileHandle On return, points to the created file handle or directory's handle @param FileHandle On return, points to the created file handle or directory's handle
@ -734,7 +734,7 @@ EfiShellGetCurDir(
directory is changed. directory is changed.
@param Dir Points to the NULL-terminated directory on the device specified by FileSystem. @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
@retval EFI_SUCCESS The operation was sucessful @retval EFI_SUCCESS The operation was successful
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
@ -818,7 +818,7 @@ EfiShellIsRootShell(
If Alias is NULL, ReturnedData points to a ';' If Alias is NULL, ReturnedData points to a ';'
delimited list of alias (e.g. delimited list of alias (e.g.
ReturnedData = "dir;del;copy;mfp") that is NULL-terminated. ReturnedData = "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 @retval NULL Alias was not a valid Alias
**/ **/
CONST CHAR16 * CONST CHAR16 *
@ -915,7 +915,7 @@ InternalEfiShellSetEnv(
feature's enabled state was not known when the shell initially launched. feature's enabled state was not known when the shell initially launched.
@retval EFI_SUCCESS The feature is enabled. @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 EFI_STATUS
InernalEfiShellStartMonitor( InernalEfiShellStartMonitor(

2
ShellPkg/Application/ShellCTestApp/README.txt
View File

@ -1,5 +1,5 @@
TestArgv.nsh is a very simple shell script to test how the interpreter parses TestArgv.nsh is a very simple shell script to test how the interpreter parses
the parameters. It uses ShellCTestApp.efi to dump the parameters passed from the the parameters. It uses ShellCTestApp.efi to dump the parameters passed from the
intepreter. interpreter.
TestArgv.log is the desired output created using "TestArgv.nsh > TestArgv.log". TestArgv.log is the desired output created using "TestArgv.nsh > TestArgv.log".