* [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions
@ 2019-12-02 17:40 Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER Philippe Mathieu-Daudé
` (3 more replies)
0 siblings, 4 replies; 6+ messages in thread
From: Philippe Mathieu-Daudé @ 2019-12-02 17:40 UTC (permalink / raw)
To: devel; +Cc: Ray Ni, Zhichao Gao, Philippe Mathieu-Daude
Complete the list of values the functios ParseCommandLineToArgs()
and UpdateArgcArgv() can return.
The documentation was found to be incomplete while reviewing BZ#2395:
https://edk2.groups.io/g/devel/message/51512
Regards,
Phil.
Philippe Mathieu-Daude (2):
ShellPkg: Document ParseCommandLineToArgs returns
EFI_INVALID_PARAMETER
ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
ShellPkg/Application/Shell/ShellParametersProtocol.h | 2 ++
ShellPkg/Application/Shell/ShellParametersProtocol.c | 2 ++
2 files changed, 4 insertions(+)
--
2.21.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER
2019-12-02 17:40 [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Philippe Mathieu-Daudé
@ 2019-12-02 17:40 ` Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 2/2] ShellPkg: Document UpdateArgcArgv " Philippe Mathieu-Daudé
` (2 subsequent siblings)
3 siblings, 0 replies; 6+ messages in thread
From: Philippe Mathieu-Daudé @ 2019-12-02 17:40 UTC (permalink / raw)
To: devel; +Cc: Ray Ni, Zhichao Gao, Philippe Mathieu-Daude
ShellParametersProtocol::ParseCommandLineToArgs() 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 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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
2019-12-02 17:40 [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER Philippe Mathieu-Daudé
@ 2019-12-02 17:40 ` Philippe Mathieu-Daudé
2019-12-04 1:46 ` [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Gao, Zhichao
[not found] ` <15DD07CBE3EDEC2C.30367@groups.io>
3 siblings, 0 replies; 6+ messages in thread
From: Philippe Mathieu-Daudé @ 2019-12-02 17:40 UTC (permalink / raw)
To: devel; +Cc: Ray Ni, Zhichao Gao, Philippe Mathieu-Daude
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions
2019-12-02 17:40 [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 2/2] ShellPkg: Document UpdateArgcArgv " Philippe Mathieu-Daudé
@ 2019-12-04 1:46 ` Gao, Zhichao
[not found] ` <15DD07CBE3EDEC2C.30367@groups.io>
3 siblings, 0 replies; 6+ messages in thread
From: Gao, Zhichao @ 2019-12-04 1:46 UTC (permalink / raw)
To: Philippe Mathieu-Daude, devel@edk2.groups.io; +Cc: Ni, Ray
Series, Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Thanks,
Zhichao
> -----Original Message-----
> From: Philippe Mathieu-Daude [mailto:philmd@redhat.com]
> Sent: Tuesday, December 3, 2019 1:41 AM
> To: devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>;
> Philippe Mathieu-Daude <philmd@redhat.com>
> Subject: [PATCH 0/2] ShellPkg: Document the use of
> EFI_INVALID_PARAMETER by two functions
>
> Complete the list of values the functios ParseCommandLineToArgs() and
> UpdateArgcArgv() can return.
>
> The documentation was found to be incomplete while reviewing BZ#2395:
> https://edk2.groups.io/g/devel/message/51512
>
> Regards,
>
> Phil.
>
> Philippe Mathieu-Daude (2):
> ShellPkg: Document ParseCommandLineToArgs returns
> EFI_INVALID_PARAMETER
> ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
>
> ShellPkg/Application/Shell/ShellParametersProtocol.h | 2 ++
> ShellPkg/Application/Shell/ShellParametersProtocol.c | 2 ++
> 2 files changed, 4 insertions(+)
>
> --
> 2.21.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [edk2-devel] [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions
[not found] ` <15DD07CBE3EDEC2C.30367@groups.io>
@ 2019-12-19 5:00 ` Gao, Zhichao
2019-12-19 14:09 ` Philippe Mathieu-Daudé
0 siblings, 1 reply; 6+ messages in thread
From: Gao, Zhichao @ 2019-12-19 5:00 UTC (permalink / raw)
To: devel@edk2.groups.io, Gao, Zhichao, Philippe Mathieu-Daude; +Cc: Ni, Ray
Sorry for missing do the script check. The patch #1 's title length is too long. We should make sure the title length is less than 72 (not include 72).
Can you change that and resend the patch set?
Thanks,
Zhichao
> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Gao, Zhichao
> Sent: Wednesday, December 4, 2019 9:47 AM
> To: Philippe Mathieu-Daude <philmd@redhat.com>; devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: Re: [edk2-devel] [PATCH 0/2] ShellPkg: Document the use of
> EFI_INVALID_PARAMETER by two functions
>
> Series, Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
>
> Thanks,
> Zhichao
>
> > -----Original Message-----
> > From: Philippe Mathieu-Daude [mailto:philmd@redhat.com]
> > Sent: Tuesday, December 3, 2019 1:41 AM
> > To: devel@edk2.groups.io
> > Cc: Ni, Ray <ray.ni@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>;
> > Philippe Mathieu-Daude <philmd@redhat.com>
> > Subject: [PATCH 0/2] ShellPkg: Document the use of
> > EFI_INVALID_PARAMETER by two functions
> >
> > Complete the list of values the functios ParseCommandLineToArgs() and
> > UpdateArgcArgv() can return.
> >
> > The documentation was found to be incomplete while reviewing BZ#2395:
> > https://edk2.groups.io/g/devel/message/51512
> >
> > Regards,
> >
> > Phil.
> >
> > Philippe Mathieu-Daude (2):
> > ShellPkg: Document ParseCommandLineToArgs returns
> > EFI_INVALID_PARAMETER
> > ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
> >
> > ShellPkg/Application/Shell/ShellParametersProtocol.h | 2 ++
> > ShellPkg/Application/Shell/ShellParametersProtocol.c | 2 ++
> > 2 files changed, 4 insertions(+)
> >
> > --
> > 2.21.0
>
>
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [edk2-devel] [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions
2019-12-19 5:00 ` [edk2-devel] " Gao, Zhichao
@ 2019-12-19 14:09 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 6+ messages in thread
From: Philippe Mathieu-Daudé @ 2019-12-19 14:09 UTC (permalink / raw)
To: Gao, Zhichao, devel@edk2.groups.io; +Cc: Ni, Ray
On 12/19/19 6:00 AM, Gao, Zhichao wrote:
> Sorry for missing do the script check. The patch #1 's title length is too long. We should make sure the title length is less than 72 (not include 72).
> Can you change that and resend the patch set?
Will do.
>
> Thanks,
> Zhichao
>
>> -----Original Message-----
>> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>> Gao, Zhichao
>> Sent: Wednesday, December 4, 2019 9:47 AM
>> To: Philippe Mathieu-Daude <philmd@redhat.com>; devel@edk2.groups.io
>> Cc: Ni, Ray <ray.ni@intel.com>
>> Subject: Re: [edk2-devel] [PATCH 0/2] ShellPkg: Document the use of
>> EFI_INVALID_PARAMETER by two functions
>>
>> Series, Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
>>
>> Thanks,
>> Zhichao
>>
>>> -----Original Message-----
>>> From: Philippe Mathieu-Daude [mailto:philmd@redhat.com]
>>> Sent: Tuesday, December 3, 2019 1:41 AM
>>> To: devel@edk2.groups.io
>>> Cc: Ni, Ray <ray.ni@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>;
>>> Philippe Mathieu-Daude <philmd@redhat.com>
>>> Subject: [PATCH 0/2] ShellPkg: Document the use of
>>> EFI_INVALID_PARAMETER by two functions
>>>
>>> Complete the list of values the functios ParseCommandLineToArgs() and
>>> UpdateArgcArgv() can return.
>>>
>>> The documentation was found to be incomplete while reviewing BZ#2395:
>>> https://edk2.groups.io/g/devel/message/51512
>>>
>>> Regards,
>>>
>>> Phil.
>>>
>>> Philippe Mathieu-Daude (2):
>>> ShellPkg: Document ParseCommandLineToArgs returns
>>> EFI_INVALID_PARAMETER
>>> ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER
>>>
>>> ShellPkg/Application/Shell/ShellParametersProtocol.h | 2 ++
>>> ShellPkg/Application/Shell/ShellParametersProtocol.c | 2 ++
>>> 2 files changed, 4 insertions(+)
>>>
>>> --
>>> 2.21.0
>>
>>
>>
>
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-12-19 14:09 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-12-02 17:40 [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER Philippe Mathieu-Daudé
2019-12-02 17:40 ` [PATCH 2/2] ShellPkg: Document UpdateArgcArgv " Philippe Mathieu-Daudé
2019-12-04 1:46 ` [PATCH 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions Gao, Zhichao
[not found] ` <15DD07CBE3EDEC2C.30367@groups.io>
2019-12-19 5:00 ` [edk2-devel] " Gao, Zhichao
2019-12-19 14:09 ` Philippe Mathieu-Daudé
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox