Add comments in DSC files to explain the function and design of components section.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7490 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
index a307a2b66a6d6c6c2fea663a867a5a4cc1eded1f..3326b00ed3fb1654c09373f88f884df4b7a16984 100644 (file)
--- a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
+++ b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc
@@ -184,11 +184,24 @@
 [PcdsFixedAtBuild.IPF]\r
   gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000\r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 \r
 [Components.common]\r
   IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf\r

diff --git a/IntelFrameworkPkg/IntelFrameworkPkg.dsc b/IntelFrameworkPkg/IntelFrameworkPkg.dsc
index e99d917dd6ccd74b58ef4e110ddf6c86deb48dd3..4f910f9cf7a8dc0de64a0feb955c0e5be924d7c1 100644 (file)
--- a/IntelFrameworkPkg/IntelFrameworkPkg.dsc
+++ b/IntelFrameworkPkg/IntelFrameworkPkg.dsc
@@ -51,11 +51,24 @@
   gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable|FALSE\r
   gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable|FALSE\r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 [Components.common]\r
   IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf\r
   IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf\r

diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
index 0073dce81e3520aa694d963cf62ac12827a898c4..cf7685ed1bf5d1a008bdf8e03106ecb49b195eb6 100644 (file)
--- a/MdeModulePkg/MdeModulePkg.dsc
+++ b/MdeModulePkg/MdeModulePkg.dsc
@@ -240,11 +240,24 @@
 [PcdsFixedAtBuild.IPF]\r
   gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000\r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 \r
 [Components.common]\r
   MdeModulePkg/Application/HelloWorld/HelloWorld.inf\r

diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc
index 56234a151a671ea55eb0a8ff94ee8d1578661502..23b8f2865c657029059fb81a6a2b8ccdee31d371 100644 (file)
--- a/MdePkg/MdePkg.dsc
+++ b/MdePkg/MdePkg.dsc
@@ -48,6 +48,25 @@
 [PcdsFixedAtBuild.IPF]\r
   gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000\r
 \r
+###################################################################################################\r
+#\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
+#\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
+\r
 [Components.common]\r
   MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf\r
   MdePkg/Library/BaseCpuLib/BaseCpuLib.inf\r

diff --git a/Nt32Pkg/Nt32Pkg.dsc b/Nt32Pkg/Nt32Pkg.dsc
index 68e6a66a7c07051b2db3b4eeb17b2de7d856e328..dae2d0ab8812219fd7898112d246dba6ffe6e14c 100644 (file)
--- a/Nt32Pkg/Nt32Pkg.dsc
+++ b/Nt32Pkg/Nt32Pkg.dsc
@@ -368,11 +368,24 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|10\r
 \r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 \r
 [Components.IA32]\r
   ##\r
@@ -532,14 +545,3 @@
   #  EdkCompatibilityPkg\Foundation\Library\Dxe\PrintLite\PrintLib.inf\r
   #  EdkCompatibilityPkg\Foundation\Library\Dxe\GraphicsLite\Graphics.inf\r
 \r
-######################################################################################\r
-#\r
-# Following binaries are specified in FDF file and built in Firmware Volumes.\r
-# The are not included in DSC file because DSC only specifies modules to build.\r
-#\r
-######################################################################################\r
-##\r
-## EdkShellBinPkg/FullShell/Ia32/Shell_Full.efi\r
-## FatBinPkg/EnhancedFatDxe/Ia32/Fat.efi\r
-## MdeModulePkg/Logo/Logo.bmp\r
-##\r

diff --git a/OptionRomPkg/OptionRomPkg.dsc b/OptionRomPkg/OptionRomPkg.dsc
index 6a65ebc0be4185244ee85b89671f1db00ccfca3f..1e040f68b0682c5452f20f1ef82ac3cca489cf08 100644 (file)
--- a/OptionRomPkg/OptionRomPkg.dsc
+++ b/OptionRomPkg/OptionRomPkg.dsc
@@ -80,11 +80,24 @@
   gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue|0x0\r
   gOptionRomPkgTokenSpaceGuid.PcdDriverSupportedEfiVersion|0x0002000a # EFI_2_10_SYSTEM_TABLE_REVISION\r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 \r
 [Components.common]\r
   OptionRomPkg/AtapiPassThruDxe/AtapiPassThruDxe.inf\r

diff --git a/UnixPkg/UnixPkg.dsc b/UnixPkg/UnixPkg.dsc
index 7b6a2a09f6686e235e506027eaa2f0d123e1b5f1..a93e88c918e59399c22f2b41c20eb8e1ad1b7767 100644 (file)
--- a/UnixPkg/UnixPkg.dsc
+++ b/UnixPkg/UnixPkg.dsc
@@ -389,11 +389,24 @@
   gEfiUnixPkgTokenSpaceGuid.PcdUnixMemorySize|L"64!64"|VOID*|10\r
   gEfiUnixPkgTokenSpaceGuid.PcdUnixSerialPort|L"/dev/ttyS0!/dev/ttyS1"|VOID*|20\r
 \r
-################################################################################\r
+###################################################################################################\r
 #\r
-# Components Section - list of all EDK II Modules needed by this Platform.\r
+# Components Section - list of the modules and components that will be processed by compilation\r
+#                      tools and the EDK II tools to generate PE32/PE32+/Coff image files.\r
 #\r
-################################################################################\r
+# Note: The EDK II DSC file is not used to specify how compiled binary images get placed\r
+#       into firmware volume images. This section is just a list of modules to compile from\r
+#       source into UEFI-compliant binaries.\r
+#       It is the FDF file that contains information on combining binary files into firmware\r
+#       volume images, whose concept is beyond UEFI and is described in PI specification.\r
+#       Binary modules do not need to be listed in this section, as they should be\r
+#       specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi),\r
+#       Logo (Logo.bmp), and etc.\r
+#       There may also be modules listed in this section that are not required in the FDF file,\r
+#       When a module listed here is excluded from FDF file, then UEFI-compliant binary will be\r
+#       generated for it, but the binary will not be put into any firmware volume.\r
+#\r
+###################################################################################################\r
 [Components.IA32]\r
   ##\r
   #  SEC Phase modules\r
@@ -493,14 +506,3 @@
       PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf\r
   }\r
 \r
-######################################################################################\r
-#\r
-# Following binaries are specified in FDF file and built in Firmware Volumes.\r
-# The are not included in DSC file because DSC only specifies modules to build.\r
-#\r
-######################################################################################\r
-##\r
-## EdkShellBinPkg/FullShell/Ia32/Shell_Full.efi\r
-## FatBinPkg/EnhancedFatDxe/Ia32/Fat.efi\r
-## MdeModulePkg/Logo/Logo.bmp\r
-##\r