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

[mirror_edk2.git] / OptionRomPkg / OptionRomPkg.dsc

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