From dcbb35eb6ca9133f6858a5945901154dd8bec732 Mon Sep 17 00:00:00 2001 From: xli24 Date: Tue, 10 Feb 2009 08:58:47 +0000 Subject: [PATCH] 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 --- .../IntelFrameworkModulePkg.dsc | 19 ++++++++++-- IntelFrameworkPkg/IntelFrameworkPkg.dsc | 19 ++++++++++-- MdeModulePkg/MdeModulePkg.dsc | 19 ++++++++++-- MdePkg/MdePkg.dsc | 19 ++++++++++++ Nt32Pkg/Nt32Pkg.dsc | 30 ++++++++++--------- OptionRomPkg/OptionRomPkg.dsc | 19 ++++++++++-- UnixPkg/UnixPkg.dsc | 30 ++++++++++--------- 7 files changed, 115 insertions(+), 40 deletions(-) diff --git a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc index a307a2b66a..3326b00ed3 100644 --- a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc +++ b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dsc @@ -184,11 +184,24 @@ [PcdsFixedAtBuild.IPF] gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000 -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.common] IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf diff --git a/IntelFrameworkPkg/IntelFrameworkPkg.dsc b/IntelFrameworkPkg/IntelFrameworkPkg.dsc index e99d917dd6..4f910f9cf7 100644 --- a/IntelFrameworkPkg/IntelFrameworkPkg.dsc +++ b/IntelFrameworkPkg/IntelFrameworkPkg.dsc @@ -51,11 +51,24 @@ gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable|FALSE gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable|FALSE -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.common] IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc index 0073dce81e..cf7685ed1b 100644 --- a/MdeModulePkg/MdeModulePkg.dsc +++ b/MdeModulePkg/MdeModulePkg.dsc @@ -240,11 +240,24 @@ [PcdsFixedAtBuild.IPF] gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000 -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.common] MdeModulePkg/Application/HelloWorld/HelloWorld.inf diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc index 56234a151a..23b8f2865c 100644 --- a/MdePkg/MdePkg.dsc +++ b/MdePkg/MdePkg.dsc @@ -48,6 +48,25 @@ [PcdsFixedAtBuild.IPF] gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000 +################################################################################################### +# +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. +# +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### + [Components.common] MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf MdePkg/Library/BaseCpuLib/BaseCpuLib.inf diff --git a/Nt32Pkg/Nt32Pkg.dsc b/Nt32Pkg/Nt32Pkg.dsc index 68e6a66a7c..dae2d0ab88 100644 --- a/Nt32Pkg/Nt32Pkg.dsc +++ b/Nt32Pkg/Nt32Pkg.dsc @@ -368,11 +368,24 @@ gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|10 -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.IA32] ## @@ -532,14 +545,3 @@ # EdkCompatibilityPkg\Foundation\Library\Dxe\PrintLite\PrintLib.inf # EdkCompatibilityPkg\Foundation\Library\Dxe\GraphicsLite\Graphics.inf -###################################################################################### -# -# Following binaries are specified in FDF file and built in Firmware Volumes. -# The are not included in DSC file because DSC only specifies modules to build. -# -###################################################################################### -## -## EdkShellBinPkg/FullShell/Ia32/Shell_Full.efi -## FatBinPkg/EnhancedFatDxe/Ia32/Fat.efi -## MdeModulePkg/Logo/Logo.bmp -## diff --git a/OptionRomPkg/OptionRomPkg.dsc b/OptionRomPkg/OptionRomPkg.dsc index 6a65ebc0be..1e040f68b0 100644 --- a/OptionRomPkg/OptionRomPkg.dsc +++ b/OptionRomPkg/OptionRomPkg.dsc @@ -80,11 +80,24 @@ gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue|0x0 gOptionRomPkgTokenSpaceGuid.PcdDriverSupportedEfiVersion|0x0002000a # EFI_2_10_SYSTEM_TABLE_REVISION -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.common] OptionRomPkg/AtapiPassThruDxe/AtapiPassThruDxe.inf diff --git a/UnixPkg/UnixPkg.dsc b/UnixPkg/UnixPkg.dsc index 7b6a2a09f6..a93e88c918 100644 --- a/UnixPkg/UnixPkg.dsc +++ b/UnixPkg/UnixPkg.dsc @@ -389,11 +389,24 @@ gEfiUnixPkgTokenSpaceGuid.PcdUnixMemorySize|L"64!64"|VOID*|10 gEfiUnixPkgTokenSpaceGuid.PcdUnixSerialPort|L"/dev/ttyS0!/dev/ttyS1"|VOID*|20 -################################################################################ +################################################################################################### # -# Components Section - list of all EDK II Modules needed by this Platform. +# Components Section - list of the modules and components that will be processed by compilation +# tools and the EDK II tools to generate PE32/PE32+/Coff image files. # -################################################################################ +# Note: The EDK II DSC file is not used to specify how compiled binary images get placed +# into firmware volume images. This section is just a list of modules to compile from +# source into UEFI-compliant binaries. +# It is the FDF file that contains information on combining binary files into firmware +# volume images, whose concept is beyond UEFI and is described in PI specification. +# Binary modules do not need to be listed in this section, as they should be +# specified in the FDF file. For example: Shell binary (Shell_Full.efi), FAT binary (Fat.efi), +# Logo (Logo.bmp), and etc. +# There may also be modules listed in this section that are not required in the FDF file, +# When a module listed here is excluded from FDF file, then UEFI-compliant binary will be +# generated for it, but the binary will not be put into any firmware volume. +# +################################################################################################### [Components.IA32] ## # SEC Phase modules @@ -493,14 +506,3 @@ PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf } -###################################################################################### -# -# Following binaries are specified in FDF file and built in Firmware Volumes. -# The are not included in DSC file because DSC only specifies modules to build. -# -###################################################################################### -## -## EdkShellBinPkg/FullShell/Ia32/Shell_Full.efi -## FatBinPkg/EnhancedFatDxe/Ia32/Fat.efi -## MdeModulePkg/Logo/Logo.bmp -## -- 2.39.2