[PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Philippe Mathieu-Daudé]

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

v2:
- Shortened patch #1 subject to fit 72 chars
- Added Zhichao Gao R-b tag

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

[PATCH v2 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER

[Philippe Mathieu-Daudé]

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

[PATCH v2 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER

[Philippe Mathieu-Daudé]

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>
---
 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

Re: [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Gao, Zhichao]

Sorry for late response:

> -----Original Message-----
> From: Philippe Mathieu-Daude <philmd@redhat.com>
> Sent: Thursday, December 19, 2019 10:10 PM
> 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 v2 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
> 
> v2:
> - Shortened patch #1 subject to fit 72 chars

The subject should be less than 72 chars (do not include 72 chars).

Thanks,
Zhichao

> - Added Zhichao Gao R-b tag
> 
> 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

Re: [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Philippe Mathieu-Daudé]

Hi Zhichao,

On 1/7/20 8:01 AM, Gao, Zhichao wrote:
> Sorry for late response:
> 
>> -----Original Message-----
>> From: Philippe Mathieu-Daude <philmd@redhat.com>
>> Sent: Thursday, December 19, 2019 10:10 PM
>> 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 v2 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
>>
>> v2:
>> - Shortened patch #1 subject to fit 72 chars
> 
> The subject should be less than 72 chars (do not include 72 chars).

What is the rationale for this restriction? Some tool limitation?

Re: [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Gao, Zhichao]

> -----Original Message-----
> From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com]
> Sent: Tuesday, January 7, 2020 3:10 PM
> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: Re: [PATCH v2 0/2] ShellPkg: Document the use of
> EFI_INVALID_PARAMETER by two functions
> 
> Hi Zhichao,
> 
> On 1/7/20 8:01 AM, Gao, Zhichao wrote:
> > Sorry for late response:
> >
> >> -----Original Message-----
> >> From: Philippe Mathieu-Daude <philmd@redhat.com>
> >> Sent: Thursday, December 19, 2019 10:10 PM
> >> 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 v2 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
> >>
> >> v2:
> >> - Shortened patch #1 subject to fit 72 chars
> >
> > The subject should be less than 72 chars (do not include 72 chars).
> 
> What is the rationale for this restriction? Some tool limitation?

Yes. There is a patch check tool in BaseTools\Scripts\ PatchCheck.py. And the patch #1 can't pass the check.

Thanks,
Zhichao

Re: [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Philippe Mathieu-Daudé]

Hi Zhichao,

On 1/7/20 8:37 AM, Gao, Zhichao wrote:
>> -----Original Message-----
>> From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com]
>> Sent: Tuesday, January 7, 2020 3:10 PM
>> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
>> Cc: Ni, Ray <ray.ni@intel.com>
>> Subject: Re: [PATCH v2 0/2] ShellPkg: Document the use of
>> EFI_INVALID_PARAMETER by two functions
>>
>> On 1/7/20 8:01 AM, Gao, Zhichao wrote:
>>>> -----Original Message-----
>>>> From: Philippe Mathieu-Daude <philmd@redhat.com>
>>>> Sent: Thursday, December 19, 2019 10:10 PM
>>>> 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 v2 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
>>>>
>>>> v2:
>>>> - Shortened patch #1 subject to fit 72 chars
>>>
>>> The subject should be less than 72 chars (do not include 72 chars).
>>
>> What is the rationale for this restriction? Some tool limitation?
> 
> Yes. There is a patch check tool in BaseTools\Scripts\ PatchCheck.py. And the patch #1 can't pass the check.

Since the patch "BaseTools/PatchCheck.py: Ignore CR and LF characters in 
subject length" got merged as commit 2649a735b24, can you retry to merge 
this patch?

Thanks,

Phil.

Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Gao, Zhichao]

Hi,

I have tried with the commit. It pass the check.

Thanks,
Zhichao

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Philippe Mathieu-Daudé
> Sent: Tuesday, January 21, 2020 7:24 PM
> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of
> EFI_INVALID_PARAMETER by two functions
> 
> Hi Zhichao,
> 
> On 1/7/20 8:37 AM, Gao, Zhichao wrote:
> >> -----Original Message-----
> >> From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com]
> >> Sent: Tuesday, January 7, 2020 3:10 PM
> >> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
> >> Cc: Ni, Ray <ray.ni@intel.com>
> >> Subject: Re: [PATCH v2 0/2] ShellPkg: Document the use of
> >> EFI_INVALID_PARAMETER by two functions
> >>
> >> On 1/7/20 8:01 AM, Gao, Zhichao wrote:
> >>>> -----Original Message-----
> >>>> From: Philippe Mathieu-Daude <philmd@redhat.com>
> >>>> Sent: Thursday, December 19, 2019 10:10 PM
> >>>> 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 v2 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
> >>>>
> >>>> v2:
> >>>> - Shortened patch #1 subject to fit 72 chars
> >>>
> >>> The subject should be less than 72 chars (do not include 72 chars).
> >>
> >> What is the rationale for this restriction? Some tool limitation?
> >
> > Yes. There is a patch check tool in BaseTools\Scripts\ PatchCheck.py. And the
> patch #1 can't pass the check.
> 
> Since the patch "BaseTools/PatchCheck.py: Ignore CR and LF characters in
> subject length" got merged as commit 2649a735b24, can you retry to merge this
> patch?
> 
> Thanks,
> 
> Phil.
> 
> 
> 

Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Philippe Mathieu-Daudé]

On 1/31/20 6:31 AM, Gao, Zhichao wrote:
> Hi,
> 
> I have tried with the commit. It pass the check.

Good news, thanks for checking :)

Is there anything else I should do to get this series applied?

Thanks,

Phil.

>> -----Original Message-----
>> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>> Philippe Mathieu-Daudé
>> Sent: Tuesday, January 21, 2020 7:24 PM
>> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
>> Cc: Ni, Ray <ray.ni@intel.com>
>> Subject: Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of
>> EFI_INVALID_PARAMETER by two functions
>>
>> Hi Zhichao,
>>
>> On 1/7/20 8:37 AM, Gao, Zhichao wrote:
>>>> -----Original Message-----
>>>> From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com]
>>>> Sent: Tuesday, January 7, 2020 3:10 PM
>>>> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
>>>> Cc: Ni, Ray <ray.ni@intel.com>
>>>> Subject: Re: [PATCH v2 0/2] ShellPkg: Document the use of
>>>> EFI_INVALID_PARAMETER by two functions
>>>>
>>>> On 1/7/20 8:01 AM, Gao, Zhichao wrote:
>>>>>> -----Original Message-----
>>>>>> From: Philippe Mathieu-Daude <philmd@redhat.com>
>>>>>> Sent: Thursday, December 19, 2019 10:10 PM
>>>>>> 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 v2 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
>>>>>>
>>>>>> v2:
>>>>>> - Shortened patch #1 subject to fit 72 chars
>>>>>
>>>>> The subject should be less than 72 chars (do not include 72 chars).
>>>>
>>>> What is the rationale for this restriction? Some tool limitation?
>>>
>>> Yes. There is a patch check tool in BaseTools\Scripts\ PatchCheck.py. And the
>> patch #1 can't pass the check.
>>
>> Since the patch "BaseTools/PatchCheck.py: Ignore CR and LF characters in
>> subject length" got merged as commit 2649a735b24, can you retry to merge this
>> patch?
>>
>> Thanks,
>>
>> Phil.
>>
>>
>> 
> 

Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of EFI_INVALID_PARAMETER by two functions

[Philippe Mathieu-Daudé]

On 2/5/20 12:04 AM, Philippe Mathieu-Daudé wrote:
> On 1/31/20 6:31 AM, Gao, Zhichao wrote:
>> Hi,
>>
>> I have tried with the commit. It pass the check.
> 
> Good news, thanks for checking :)
> 
> Is there anything else I should do to get this series applied?

I see these patches were merged as ddb7050c6843 and 7f9e354a01d7 (my 
name mojibaked unfortunately). Thank to the anonymous maintainer who 
merged it!

> Thanks,
> 
> Phil.
> 
>>> -----Original Message-----
>>> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>>> Philippe Mathieu-Daudé
>>> Sent: Tuesday, January 21, 2020 7:24 PM
>>> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
>>> Cc: Ni, Ray <ray.ni@intel.com>
>>> Subject: Re: [edk2-devel] [PATCH v2 0/2] ShellPkg: Document the use of
>>> EFI_INVALID_PARAMETER by two functions
>>>
>>> Hi Zhichao,
>>>
>>> On 1/7/20 8:37 AM, Gao, Zhichao wrote:
>>>>> -----Original Message-----
>>>>> From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com]
>>>>> Sent: Tuesday, January 7, 2020 3:10 PM
>>>>> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
>>>>> Cc: Ni, Ray <ray.ni@intel.com>
>>>>> Subject: Re: [PATCH v2 0/2] ShellPkg: Document the use of
>>>>> EFI_INVALID_PARAMETER by two functions
>>>>>
>>>>> On 1/7/20 8:01 AM, Gao, Zhichao wrote:
>>>>>>> -----Original Message-----
>>>>>>> From: Philippe Mathieu-Daude <philmd@redhat.com>
>>>>>>> Sent: Thursday, December 19, 2019 10:10 PM
>>>>>>> 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 v2 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
>>>>>>>
>>>>>>> v2:
>>>>>>> - Shortened patch #1 subject to fit 72 chars
>>>>>>
>>>>>> The subject should be less than 72 chars (do not include 72 chars).
>>>>>
>>>>> What is the rationale for this restriction? Some tool limitation?
>>>>
>>>> Yes. There is a patch check tool in BaseTools\Scripts\ 
>>>> PatchCheck.py. And the
>>> patch #1 can't pass the check.
>>>
>>> Since the patch "BaseTools/PatchCheck.py: Ignore CR and LF characters in
>>> subject length" got merged as commit 2649a735b24, can you retry to 
>>> merge this
>>> patch?
>>>
>>> Thanks,
>>>
>>> Phil.
>>>
>>>
>>> 
>>