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

[mirror_edk2.git] / UnixPkg / UnixPkg.dsc

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