summaryrefslogtreecommitdiffstats
path: root/ShellPkg/Include
diff options
context:
space:
mode:
Diffstat (limited to 'ShellPkg/Include')
-rw-r--r--ShellPkg/Include/Library/BcfgCommandLib.h2
-rw-r--r--ShellPkg/Include/Library/HandleParsingLib.h2
-rw-r--r--ShellPkg/Include/Library/ShellCommandLib.h6
-rw-r--r--ShellPkg/Include/Library/ShellLib.h30
-rw-r--r--ShellPkg/Include/Protocol/EfiShellEnvironment2.h10
5 files changed, 25 insertions, 25 deletions
diff --git a/ShellPkg/Include/Library/BcfgCommandLib.h b/ShellPkg/Include/Library/BcfgCommandLib.h
index ec5579ce61..649fe00f98 100644
--- a/ShellPkg/Include/Library/BcfgCommandLib.h
+++ b/ShellPkg/Include/Library/BcfgCommandLib.h
@@ -18,7 +18,7 @@
@param[in] SystemTable the EFI System Table pointer
@param[in] Name the profile name to use
- @retval EFI_SUCCESS the shell command handlers were installed sucessfully
+ @retval EFI_SUCCESS the shell command handlers were installed successfully
@retval EFI_UNSUPPORTED the shell level required was not found.
**/
EFI_STATUS
diff --git a/ShellPkg/Include/Library/HandleParsingLib.h b/ShellPkg/Include/Library/HandleParsingLib.h
index 8193be94a4..b86d69cb0e 100644
--- a/ShellPkg/Include/Library/HandleParsingLib.h
+++ b/ShellPkg/Include/Library/HandleParsingLib.h
@@ -20,7 +20,7 @@
@param[in] TheName The Guid's name
@param[in] Lang RFC4646 language code list or NULL
- @retval EFI_SUCCESS The operation was sucessful
+ @retval EFI_SUCCESS The operation was successful
@retval EFI_ACCESS_DENIED There was a duplicate
@retval EFI_OUT_OF_RESOURCES A memory allocation failed
**/
diff --git a/ShellPkg/Include/Library/ShellCommandLib.h b/ShellPkg/Include/Library/ShellCommandLib.h
index 7a97b203f1..0b185e3e57 100644
--- a/ShellPkg/Include/Library/ShellCommandLib.h
+++ b/ShellPkg/Include/Library/ShellCommandLib.h
@@ -70,7 +70,7 @@ CONST CHAR16 *
the command built into shell.
@param[in] SystemTable The pointer to the system table.
- @retval RETURN_SUCCESS The shell command was sucessful.
+ @retval RETURN_SUCCESS The shell command was successful.
@retval RETURN_UNSUPPORTED The command is not supported.
**/
typedef
@@ -544,7 +544,7 @@ ShellCommandFindMapItem (
@param[in] Flags The Flags attribute for this map item.
@param[in] Path TRUE to update path, FALSE to skip this step (should only be TRUE during initialization).
- @retval EFI_SUCCESS The addition was sucessful.
+ @retval EFI_SUCCESS The addition was successful.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
**/
@@ -563,7 +563,7 @@ ShellCommandAddMapItemAndUpdatePath (
Also sets up the default path environment variable if Type is FileSystem.
- @retval EFI_SUCCESS All map names were created sucessfully.
+ @retval EFI_SUCCESS All map names were created successfully.
@retval EFI_NOT_FOUND No protocols were found in the system.
@return Error returned from gBS->LocateHandle().
diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h
index 10cf7f4fef..f41bc4851c 100644
--- a/ShellPkg/Include/Library/ShellLib.h
+++ b/ShellPkg/Include/Library/ShellLib.h
@@ -300,7 +300,7 @@ ShellWriteFile (
@param[in] FileHandle The file handle to close.
- @retval EFI_SUCCESS The file handle was closed sucessfully.
+ @retval EFI_SUCCESS The file handle was closed successfully.
@retval INVALID_PARAMETER One of the parameters has an invalid value.
**/
EFI_STATUS
@@ -318,7 +318,7 @@ ShellCloseFile (
@param[in] FileHandle The file handle to delete.
- @retval EFI_SUCCESS The file was closed sucessfully.
+ @retval EFI_SUCCESS The file was closed successfully.
@retval EFI_WARN_DELETE_FAILURE The handle was closed, but the file was not
deleted.
@retval INVALID_PARAMETER One of the parameters has an invalid value.
@@ -342,9 +342,9 @@ ShellDeleteFile (
@param[in] FileHandle The file handle on which the position is being set.
- @param[in] Position The byte position from the begining of the file.
+ @param[in] Position The byte position from the beginning of the file.
- @retval EFI_SUCCESS Operation completed sucessfully.
+ @retval EFI_SUCCESS Operation completed successfully.
@retval EFI_UNSUPPORTED The seek request for non-zero is not valid on
directories.
@retval INVALID_PARAMETER One of the parameters has an invalid value.
@@ -365,9 +365,9 @@ ShellSetFilePosition (
if FileHandle is a directory.
@param[in] FileHandle The open file handle on which to get the position.
- @param[out] Position The byte position from the begining of the file.
+ @param[out] Position The byte position from the beginning of the file.
- @retval EFI_SUCCESS The operation completed sucessfully.
+ @retval EFI_SUCCESS The operation completed successfully.
@retval INVALID_PARAMETER One of the parameters has an invalid value.
@retval EFI_UNSUPPORTED The request is not valid on directories.
**/
@@ -466,7 +466,7 @@ ShellFindNextFile (
@param[in] FileHandle The file handle from which size is retrieved.
@param[out] Size The pointer to size.
- @retval EFI_SUCCESS The operation was completed sucessfully.
+ @retval EFI_SUCCESS The operation was completed successfully.
@retval EFI_DEVICE_ERROR Cannot access the file.
**/
EFI_STATUS
@@ -524,7 +524,7 @@ ShellGetEnvironmentVariable (
@param[in] EnvVal The Value of the environment variable
@param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
- @retval EFI_SUCCESS The operation completed sucessfully
+ @retval EFI_SUCCESS The operation completed successfully
@retval EFI_UNSUPPORTED This operation is not allowed in pre-UEFI 2.0 Shell environments.
**/
EFI_STATUS
@@ -559,7 +559,7 @@ ShellSetEnvironmentVariable (
in the form "x=y". If NULL, the current set is used.
@param[out] Status The status of the run command line.
- @retval EFI_SUCCESS The operation completed sucessfully. Status
+ @retval EFI_SUCCESS The operation completed successfully. Status
contains the status code returned.
@retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
@retval EFI_OUT_OF_RESOURCES Out of resources.
@@ -626,7 +626,7 @@ ShellSetPageBreakMode (
@param[in] OpenMode Mode to open files with.
@param[in, out] ListHead Head of linked list of results.
- @retval EFI_SUCCESS The operation was sucessful and the list head
+ @retval EFI_SUCCESS The operation was successful and the list head
contains the list of opened files.
@retval != EFI_SUCCESS The operation failed.
@@ -645,7 +645,7 @@ ShellOpenFileMetaArg (
@param[in, out] ListHead The pointer to free.
- @retval EFI_SUCCESS The operation was sucessful.
+ @retval EFI_SUCCESS The operation was successful.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
**/
EFI_STATUS
@@ -730,7 +730,7 @@ extern SHELL_PARAM_ITEM SfoParamList[];
@param[in] AutoPageBreak Will automatically set PageBreakEnabled.
@param[in] AlwaysAllowNumbers Will never fail for number based flags.
- @retval EFI_SUCCESS The operation completed sucessfully.
+ @retval EFI_SUCCESS The operation completed successfully.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
@retval EFI_VOLUME_CORRUPTED The command line was corrupt.
@@ -878,7 +878,7 @@ ShellCommandLineCheckDuplicate (
This function is intended for internal access for shell commands only.
- @retval EFI_SUCCESS The initialization was complete sucessfully.
+ @retval EFI_SUCCESS The initialization was complete successfully.
**/
EFI_STATUS
@@ -1249,7 +1249,7 @@ ShellPromptForResponse (
@param[in] HiiFormatHandle The format string Handle for getting from Hii.
@param[in, out] Response The pointer to Response, which will be populated upon return.
- @retval EFI_SUCCESS The operation was sucessful.
+ @retval EFI_SUCCESS The operation was successful.
@return other The operation failed.
@sa ShellPromptForResponse
@@ -1385,7 +1385,7 @@ ShellFileHandleReadLine (
@param[in] FileName Pointer to file name to delete.
- @retval EFI_SUCCESS the file was deleted sucessfully
+ @retval EFI_SUCCESS the file was deleted successfully
@retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
deleted
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
diff --git a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
index 8b7c86dc24..2f826be070 100644
--- a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
+++ b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
@@ -507,7 +507,7 @@ VOID
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
@param[in, out] Handle The pointer to pointer to Handle. It is set
- on a sucessful return.
+ on a successful return.
@retval EFI_SUCCESS The next handle in the handle database is *Handle.
@retval EFI_NOT_FOUND There is not another handle.
@@ -652,7 +652,7 @@ VOID
@param[in, out] ProtocolInfo The pointer to pointer to protocol information structure.
- @retval EFI_SUCCESS The next protocol's information was sucessfully returned.
+ @retval EFI_SUCCESS The next protocol's information was successfully returned.
@retval NULL There are no more protocols.
**/
typedef
@@ -684,7 +684,7 @@ EFI_STATUS
called after INIT_PROTOCOL_INFO_ENUMERATOR.
This function resets the list of protocols such that the next one in the
- list is the begining of the list.
+ list is the beginning of the list.
**/
typedef
VOID
@@ -809,7 +809,7 @@ EFI_DEVICE_PATH_PROTOCOL *
This function looks through the shell environment map for a map whose device
path matches the DevPath parameter. If one is found the Name is returned via
- Name parameter. If sucessful the caller must free the memory allocated for
+ Name parameter. If successful the caller must free the memory allocated for
Name.
This function will use the internal lock to prevent changes to the map during
@@ -817,7 +817,7 @@ EFI_DEVICE_PATH_PROTOCOL *
@param[in] DevPath The device path to search for a name for.
@param[in] ConsistMapping What state to verify map flag VAR_ID_CONSIST.
- @param[out] Name On sucessful return the name of that device path.
+ @param[out] Name On successful return the name of that device path.
@retval EFI_SUCCESS The DevPath was found and the name returned
in Name.