diff options
| author | Qiu Shumin <shumin.qiu@intel.com> | 2014-05-22 08:32:50 +0000 |
|---|---|---|
| committer | shenshushi <shenshushi@6f19259b-4bc3-4df7-8a09-765794883524> | 2014-05-22 08:32:50 +0000 |
| commit | b5ce69c3daf4b8e32a183fd0e53b657c70d6998a (patch) | |
| tree | d4061d97fee3e2287c6b6acb6de5cfd861464462 /ShellPkg | |
| parent | f3fc9d8dc987f9b78aeefd5800833c4c5bb8acf0 (diff) | |
| download | edk2-platforms-b5ce69c3daf4b8e32a183fd0e53b657c70d6998a.tar.xz | |
Update the comments for function 'InternalShellExecuteDevicePath' in ShellProtocol.c to make it consistent with parameter names.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Qiu Shumin <shumin.qiu@intel.com>
Reviewed-by: Jaben carsey <Jaben.carsey@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15546 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg')
| -rw-r--r-- | ShellPkg/Application/Shell/ShellProtocol.c | 27 | ||||
| -rw-r--r-- | ShellPkg/Application/Shell/ShellProtocol.h | 25 |
2 files changed, 27 insertions, 25 deletions
diff --git a/ShellPkg/Application/Shell/ShellProtocol.c b/ShellPkg/Application/Shell/ShellProtocol.c index cfe2f409e4..e4680139d0 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.c +++ b/ShellPkg/Application/Shell/ShellProtocol.c @@ -1359,19 +1359,20 @@ EfiShellEnablePageBreak ( /**
internal worker function to load and run an image via device path.
- @param ParentImageHandle A handle of the image that is executing the specified
- command line.
- @param DevicePath device path of the file to execute
- @param CommandLine Points to the NULL-terminated UCS-2 encoded string
- containing the command line. If NULL then the command-
- line will be empty.
- @param Environment Points to a NULL-terminated array of environment
- variables with the format 'x=y', where x is the
- environment variable name and y is the value. If this
- is NULL, then the current shell environment is used.
-
- @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
- @param[out] ExitData ExitData as returned from gBS->StartImage
+ @param ParentImageHandle A handle of the image that is executing the specified
+ command line.
+ @param DevicePath device path of the file to execute
+ @param CommandLine Points to the NULL-terminated UCS-2 encoded string
+ containing the command line. If NULL then the command-
+ line will be empty.
+ @param Environment Points to a NULL-terminated array of environment
+ variables with the format 'x=y', where x is the
+ environment variable name and y is the value. If this
+ is NULL, then the current shell environment is used.
+
+ @param[out] StartImageStatus Returned status from gBS->StartImage.
+ @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
+ @param[out] ExitData ExitData as returned from gBS->StartImage
@retval EFI_SUCCESS The command executed successfully. The status code
returned by the command is pointed to by StatusCode.
diff --git a/ShellPkg/Application/Shell/ShellProtocol.h b/ShellPkg/Application/Shell/ShellProtocol.h index 7cc1b01947..c473977ae0 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.h +++ b/ShellPkg/Application/Shell/ShellProtocol.h @@ -433,18 +433,19 @@ EfiShellEnablePageBreak ( /**
internal worker function to run a command via Device Path
- @param ParentImageHandle A handle of the image that is executing the specified
- command line.
- @param DevicePath device path of the file to execute
- @param CommandLine Points to the NULL-terminated UCS-2 encoded string
- containing the command line. If NULL then the command-
- line will be empty.
- @param Environment Points to a NULL-terminated array of environment
- variables with the format 'x=y', where x is the
- environment variable name and y is the value. If this
- is NULL, then the current shell environment is used.
- @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
- @param[out] ExitData ExitData as returned from gBS->StartImage
+ @param ParentImageHandle A handle of the image that is executing the specified
+ command line.
+ @param DevicePath device path of the file to execute
+ @param CommandLine Points to the NULL-terminated UCS-2 encoded string
+ containing the command line. If NULL then the command-
+ line will be empty.
+ @param Environment Points to a NULL-terminated array of environment
+ variables with the format 'x=y', where x is the
+ environment variable name and y is the value. If this
+ is NULL, then the current shell environment is used.
+ @param[out] StartImageStatus Returned status from gBS->StartImage.
+ @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
+ @param[out] ExitData ExitData as returned from gBS->StartImage
@retval EFI_SUCCESS The command executed successfully. The status code
returned by the command is pointed to by StatusCode.
|