[edk2-devel] [PATCH 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER

Philippe Mathieu-Daudé posted 2 patches 7 weeks ago

[edk2-devel] [PATCH 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER

Posted by Philippe Mathieu-Daudé 7 weeks ago
ShellParametersProtocol::UpdateArgcArgv() can return
a EFI_INVALID_PARAMETER value. Document it.

Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
---
 ShellPkg/Application/Shell/ShellParametersProtocol.h | 1 +
 ShellPkg/Application/Shell/ShellParametersProtocol.c | 1 +
 2 files changed, 2 insertions(+)

diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h
index da103086ab9a..721cb34f5835 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 sucessful, 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.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index 83fe4eda3fb8..4555a9639d95 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -1341,6 +1341,7 @@ RestoreStdInStdOutStdErr (
   @param[out] OldArgc                    Pointer to old number of items in Argv list.
 
   @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.
+  @return   EFI_INVALID_PARAMETER       Some parameters are invalid.
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.
 **/
 EFI_STATUS
-- 
2.21.0


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#51553): https://edk2.groups.io/g/devel/message/51553
Mute This Topic: https://groups.io/mt/65090011/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-