On Mon, Aug 25, 2014 at 3:17 AM, Gao, Liming <liming....@intel.com> wrote: > Hi, all > > This patch is for below ITEM 7. INF/DEC are generated from UPT tool. > DEC_SPECIFICATION and INF_VERSION will be updated to 0x00010017. Please help > review them. > > MdePkg: Make sure order of DEC/INF content matches the order that UPT > generates in the XML -> INF conversion
This patch subject line is much longer than the recommended 70 character limit: https://github.com/tianocore/tianocore.github.io/wiki/Commit-Message-Format How about: MdePkg DEC/INF: Match format required by UPT These changes seem to arbitrarily match the 'order of some tool', but why is that required? What happens when someone edits these files, and doesn't get the order 'just right'? Is the order that UPT uses strict, or will it potentially change in the future, if for example, the version of some library being used by the tool decides to change the way it orders things. There seems to be other formatting happening, such as spaces removed from the copyright notice. All this rolled up into a single change seems to have produced something that is not reviewable in a reasonable amount of time. Another question I have is, were these changes the result of the output of the tool? I guess it would be easier to have some confidence in the output of a tool rather than all of these changes having been manually applied. Do you have the changes available in a branch to make it easy to test? (No, I would not want an svn branch to be added for this.) -Jordan > 1) Section Order in INF/DEC to match the ones generated from UPT > > 2) Guid value in section will be align. > > 3) Usage comments in section will be align. > > 4) One PCD section includes one PCD type. If one PCD supports more PCD > types, it will be listed in each PCD type section in DEC file. > > > > Contributed-under: TianoCore Contribution Agreement 1.0 > > Signed-off-by: Gao, Liming <liming....@intel.com> > > > > Thanks > > Liming > > From: Gao, Liming [mailto:liming....@intel.com] > Sent: Thursday, August 14, 2014 10:13 AM > To: edk2-devel@lists.sourceforge.net > Subject: [edk2] [Patch 1/2] [MdePkg] INF/DEC file updates to EDK II packages > > > > Hi, all > > Could you help review this patch? It includes the following changes 1-6 > for MdePkg. The patch is a little big. For new added UNI file, I zip them > together. > > > > The second patch for below item 7 will be sent later > > > > Thanks > > Liming > > From: Kinney, Michael D [mailto:michael.d.kin...@intel.com] > Sent: Thursday, August 07, 2014 5:32 AM > To: edk2-devel@lists.sourceforge.net > Subject: [edk2] INF/DEC file updates to EDK II packages > > > > Hello, > > > > I wanted to let everyone know about a number of patch reviews for EDK II > packages that will be sent out over the next couple of weeks. These patches > impact the order of content in INF/DEC files and comment blocks in INF/DEC > files, and should not have any build or functionality impacts. These > patches will address the following issues: > > > > 1) Usage information in INF file comment blocks are either incomplete > or incorrect. This includes usage information for > Protocols/PPIs/GUIDs/PCDs/HOBs/Events/BootModes. The syntax for usage > information in comment blocks is defined in the EDK II Module Information > (INF) Specification > > 2) Add MODULE_UNI_FILE to INF [Defines] section along with UNI file > that contains the localized Abstract and Description of a module. > > a. Addresses an information gap between INF files and the UEFI > Distribution Packaging Specification XML schema > > b. There will be an associated update to UPT in BaseTools to consume > MODULE_UNI_FILE and associated UNI file during UDP creation that performs > the INF -> XML conversion. > > c. There will be an associated update to UPT in BaseTools to produce > MODULE_UNI_FILE and associated UNI file during UDP installation that > performs the XML -> INF conversion. > > 3) Add [UserExtensions.TianoCore.”ExtraFiles”] section to INF files > along with associated UNI file that provides the localized Name of a module. > > a. [UserExtensions.TianoCore.”ExtraFiles”] provides an easy method for > a module to specify extra files not listed in [Sources] or [Binaries] > sections to be added to a UDP without having to list the files in the UPT > package information data file. > > b. There will be an associated update to UPT in BaseTools to package up > files listed in [UserExtensions.TianoCore.”ExtraFiles”] during UDP creation. > > c. UNI file contains localized name of a module to go along with the > localized Abstract and Description from the MODULE_UNI_FILE. > > 4) PCD information in DEC file comment blocks are either incomplete or > incorrect. This includes detailed description, @Prompt, @ValidRange, > @ValidList, @Expression, and [Error.<TokenSpaceGuid>] validation error > messages > > 5) Add PACKAGE_UNI_FILE to DEC [Defines] section along with UNI file > that contains the localized Abstract and Description of a package and > localized strings associated with PCDs. > > a. Addresses an information gap between DEC files and the UEFI > Distribution Packaging Specification XML schema > > b. There will be an associated update to UPT in BaseTools to consume > PACKAGE_UNI_FILE and associated UNI file during UDP creation that performs > the DEC -> XML conversion. > > c. There will be an associated update to UPT in BaseTools to produce > PACKAGE_UNI_FILE and associated UNI file during UDP installation that > performs the XML -> DEC conversion. > > 6) Add [UserExtensions.TianoCore.”ExtraFiles”] section to DEC files > along with associated UNI file that provides the localized Name of a > package. > > a. [UserExtensions.TianoCore.”ExtraFiles”] provides an easy method for > a package to specify extra files to be added to a UDP without having to list > the files in the UPT package information data file. > > b. There will be an associated update to UPT in BaseTools to package up > files listed in [UserExtensions.TianoCore.”ExtraFiles”] during UDP creation. > > c. UNI file contains localized name of a package to go along with the > localized Abstract and Description from the PACKAGE_UNI_FILE. > > 7) Make sure order of DEC/INF content matches the order that UPT > generates in the XML -> INF conversion > > a. This allows UDP packages installed by UPT to be compared against > EDK II trunk/branches using standard diff utilities. > > > > Patches for the following EDK II packages are being prepared > > 1) MdePkg > > 2) MdeModulePkg > > 3) IntelFrameworkPkg > > 4) IntelFrameworkModulePkg > > 5) FatPkg > > 6) ShellPkg > > 7) PcAtChipsetPkg > > 8) UefiCpuPkg > > 9) SourceLevelDebugPkg > > 10) CryptoPkg > > 11) SecurityPkg > > 12) NetworkPkg > > > > Best regards, > > > > Mike > > > > > ------------------------------------------------------------------------------ > Slashdot TV. > Video for Nerds. Stuff that matters. > http://tv.slashdot.org/ > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/edk2-devel > ------------------------------------------------------------------------------ Slashdot TV. Video for Nerds. Stuff that matters. http://tv.slashdot.org/ _______________________________________________ edk2-devel mailing list edk2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/edk2-devel
