[PATCH] ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize

[PATCH] ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize

[Ruiyu Ni]

When Dynamic command drivers links to ShellLib, the ShellLib
constructor shouldn't be called because the Shell and ShellParameters
protocols don't exist when the driver starts.
So it's required to set PcdShellLibAutoInitialize to FALSE for
dynamic command drivers.
Update the comments in DEC file to describe such requirement
for this PCD.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
---
 ShellPkg/ShellPkg.dec | 1 +
 1 file changed, 1 insertion(+)

diff --git a/ShellPkg/ShellPkg.dec b/ShellPkg/ShellPkg.dec
index 5859c49033..48d50b87b3 100644
--- a/ShellPkg/ShellPkg.dec
+++ b/ShellPkg/ShellPkg.dec
@@ -81,6 +81,7 @@ [PcdsFeatureFlag]
 [PcdsFixedAtBuild]
   ## This flag is used to control initialization of the shell library
   #  This should be FALSE for compiling the shell application itself only.
+  #  This should be FALSE for compiling the dynamic command drivers.
   gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005
 
   ## This is the max buffer for ShellLib and internal Shell printings.
-- 
2.15.0.gvfs.1.preview.4

Re: [PATCH] ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize

[Carsey, Jaben]

Apologies for delay.  I missed the email on first pass.

Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

> -----Original Message-----
> From: Ni, Ruiyu
> Sent: Wednesday, November 29, 2017 12:22 AM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>
> Subject: [PATCH] ShellPkg/ShellPkg.dec: Change comments for
> PcdShellLibAutoInitialize
> Importance: High
> 
> When Dynamic command drivers links to ShellLib, the ShellLib
> constructor shouldn't be called because the Shell and ShellParameters
> protocols don't exist when the driver starts.
> So it's required to set PcdShellLibAutoInitialize to FALSE for
> dynamic command drivers.
> Update the comments in DEC file to describe such requirement
> for this PCD.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Jaben Carsey <jaben.carsey@intel.com>
> ---
>  ShellPkg/ShellPkg.dec | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/ShellPkg/ShellPkg.dec b/ShellPkg/ShellPkg.dec
> index 5859c49033..48d50b87b3 100644
> --- a/ShellPkg/ShellPkg.dec
> +++ b/ShellPkg/ShellPkg.dec
> @@ -81,6 +81,7 @@ [PcdsFeatureFlag]
>  [PcdsFixedAtBuild]
>    ## This flag is used to control initialization of the shell library
>    #  This should be FALSE for compiling the shell application itself only.
> +  #  This should be FALSE for compiling the dynamic command drivers.
> 
> gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00
> 000005
> 
>    ## This is the max buffer for ShellLib and internal Shell printings.
> --
> 2.15.0.gvfs.1.preview.4

Re: [PATCH] ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize

[Ni, Ruiyu]

That's fine. Faster than me in the review response.

> -----Original Message-----
> From: Carsey, Jaben
> Sent: Saturday, December 2, 2017 1:00 AM
> To: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org
> Subject: RE: [PATCH] ShellPkg/ShellPkg.dec: Change comments for
> PcdShellLibAutoInitialize
> 
> Apologies for delay.  I missed the email on first pass.
> 
> Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
> 
> > -----Original Message-----
> > From: Ni, Ruiyu
> > Sent: Wednesday, November 29, 2017 12:22 AM
> > To: edk2-devel@lists.01.org
> > Cc: Carsey, Jaben <jaben.carsey@intel.com>
> > Subject: [PATCH] ShellPkg/ShellPkg.dec: Change comments for
> > PcdShellLibAutoInitialize
> > Importance: High
> >
> > When Dynamic command drivers links to ShellLib, the ShellLib
> > constructor shouldn't be called because the Shell and ShellParameters
> > protocols don't exist when the driver starts.
> > So it's required to set PcdShellLibAutoInitialize to FALSE for dynamic
> > command drivers.
> > Update the comments in DEC file to describe such requirement for this
> > PCD.
> >
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> > Cc: Jaben Carsey <jaben.carsey@intel.com>
> > ---
> >  ShellPkg/ShellPkg.dec | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/ShellPkg/ShellPkg.dec b/ShellPkg/ShellPkg.dec index
> > 5859c49033..48d50b87b3 100644
> > --- a/ShellPkg/ShellPkg.dec
> > +++ b/ShellPkg/ShellPkg.dec
> > @@ -81,6 +81,7 @@ [PcdsFeatureFlag]
> >  [PcdsFixedAtBuild]
> >    ## This flag is used to control initialization of the shell library
> >    #  This should be FALSE for compiling the shell application itself only.
> > +  #  This should be FALSE for compiling the dynamic command drivers.
> >
> > gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00
> > 000005
> >
> >    ## This is the max buffer for ShellLib and internal Shell printings.
> > --
> > 2.15.0.gvfs.1.preview.4