summaryrefslogtreecommitdiffstats
path: root/ShellPkg
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daud? <philmd@redhat.com>2019-12-03 01:40:51 +0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2020-02-11 02:12:45 +0000
commit7f9e354a01d77f0b392832525ccffde95ce1e95b (patch)
treefcc4a20b13ed21c951291e6970093479d65ec942 /ShellPkg
parentddb7050c6843bf67a25639ba97432b03ab5929aa (diff)
downloadedk2-7f9e354a01d77f0b392832525ccffde95ce1e95b.tar.gz
edk2-7f9e354a01d77f0b392832525ccffde95ce1e95b.tar.bz2
edk2-7f9e354a01d77f0b392832525ccffde95ce1e95b.zip
ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
ShellParametersProtocol::UpdateArgcArgv() 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.c2
-rw-r--r--ShellPkg/Application/Shell/ShellParametersProtocol.h1
2 files changed, 3 insertions, 0 deletions
diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index db5fbc1baf..7e0c8ce42e 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -1340,7 +1340,9 @@ RestoreStdInStdOutStdErr (
@param[out] OldArgv Pointer to old list of parameters.
@param[out] OldArgc Pointer to old number of items in Argv list.
+
@retval EFI_SUCCESS Operation was successful, Argv and Argc are valid.
+ @return EFI_INVALID_PARAMETER Some parameters are invalid.
@retval 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 717552b533..c50250696a 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.h
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h
@@ -71,6 +71,7 @@ CleanUpShellParametersProtocol (
@param[out] OldArgc pointer to old number of items in Argv list
@retval EFI_SUCCESS operation was successful, Argv and Argc are valid
+ @return EFI_INVALID_PARAMETER some parameters are invalid
@retval EFI_OUT_OF_RESOURCES a memory allocation failed.
**/
EFI_STATUS