summaryrefslogtreecommitdiffstats
path: root/ShellPkg
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daud? <philmd@redhat.com>2019-12-03 01:40:50 +0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2020-02-11 02:12:45 +0000
commitddb7050c6843bf67a25639ba97432b03ab5929aa (patch)
treeb9373414641a6260421d4605a9b03ac1d5f22f54 /ShellPkg
parent66360134f8049cc70765cd3f119a5e2be2b67aa4 (diff)
downloadedk2-ddb7050c6843bf67a25639ba97432b03ab5929aa.tar.gz
edk2-ddb7050c6843bf67a25639ba97432b03ab5929aa.tar.bz2
edk2-ddb7050c6843bf67a25639ba97432b03ab5929aa.zip
ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER
ShellParametersProtocol::ParseCommandLineToArgs() can return a EFI_INVALID_PARAMETER value. Document it. Reviewed-by: Zhichao Gao <zhichao.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Diffstat (limited to 'ShellPkg')
-rw-r--r--ShellPkg/Application/Shell/ShellParametersProtocol.c1
-rw-r--r--ShellPkg/Application/Shell/ShellParametersProtocol.h1
2 files changed, 2 insertions, 0 deletions
diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index ef3966d3b0..db5fbc1baf 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -185,6 +185,7 @@ DEBUG_CODE_END();
@param[in, out] Argc pointer to number of strings in Argv array
@return EFI_SUCCESS the operation was successful
+ @return EFI_INVALID_PARAMETER some parameters are invalid
@return EFI_OUT_OF_RESOURCES a memory allocation failed.
**/
EFI_STATUS
diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h
index 398147c8bd..717552b533 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.h
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h
@@ -167,6 +167,7 @@ RestoreStdInStdOutStdErr (
@param[in, out] Argc pointer to number of strings in Argv array
@return EFI_SUCCESS the operation was successful
+ @return EFI_INVALID_PARAMETER some parameters are invalid
@return EFI_OUT_OF_RESOURCES a memory allocation failed.
**/
EFI_STATUS