From: Ruiyu Ni <ruiyu.ni@intel.com>
Date: Wed, 29 Nov 2017 08:21:46 +0000 (+0800)
Subject: ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize
X-Git-Tag: edk2-stable201903~2942
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=7b5f102feac83249b0482bcfcf9bbb27fac7c6fd;hp=fd55a5be8b77be41bf4d58fc4d242bd51e25922d

ShellPkg/ShellPkg.dec: Change comments for PcdShellLibAutoInitialize

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>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
---

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 @@
 [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.