public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Philippe Mathieu-Daudé" <philmd@redhat.com>
To: devel@edk2.groups.io
Cc: Ray Ni <ray.ni@intel.com>, Zhichao Gao <zhichao.gao@intel.com>,
	Philippe Mathieu-Daude <philmd@redhat.com>
Subject: [PATCH v2 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER
Date: Thu, 19 Dec 2019 15:09:31 +0100	[thread overview]
Message-ID: <20191219140932.25428-2-philmd@redhat.com> (raw)
In-Reply-To: <20191219140932.25428-1-philmd@redhat.com>

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>
---
 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 df0316a03091..da103086ab9a 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 sucessful
+  @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.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index bcd8f0ae2112..83fe4eda3fb8 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 sucessful
+  @return EFI_INVALID_PARAMETER some parameters are invalid
   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.
 **/
 EFI_STATUS
-- 
2.21.0


  reply	other threads:[~2019-12-19 14:09 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-19 14:09 [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Philippe Mathieu-Daudé
2019-12-19 14:09 ` Philippe Mathieu-Daudé [this message]
2019-12-19 14:09 ` [PATCH v2 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER Philippe Mathieu-Daudé
2020-01-07  7:01 ` [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Gao, Zhichao
2020-01-07  7:09   ` Philippe Mathieu-Daudé
2020-01-07  7:37     ` Gao, Zhichao
2020-01-21 11:24       ` Philippe Mathieu-Daudé
2020-01-31  5:31         ` [edk2-devel] " Gao, Zhichao
2020-02-04 23:04           ` Philippe Mathieu-Daudé
2020-02-11 12:16             ` Philippe Mathieu-Daudé

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191219140932.25428-2-philmd@redhat.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox