On Mon, Aug 18, 2014 at 2:25 AM, Gao, Liming <liming....@intel.com> wrote: > Jordan: > > The commit message is just Mike description.
Are you saying it will look like this? == Commit message start == [MdePkg] INF/DEC file updates to EDK II packages 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. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Gao, Liming <liming....@intel.com> == Commit message end == Regarding the first line "[MdePkg] INF/DEC file updates to EDK II packages" I think this better fits the recommended format: "MdePkg: INF/DEC file updates to EDK II packages" But, this still leaves the patch subject as unusably vague. Instead, if the patch was broken down more, you probably could produce a usable subject line for your commit message. Regarding the rest of the commit message, you can see it is quite long. Long is not necessarily bad, but it is also not focused on a single change or bug fix. I think this is because you are trying to do 6 things in a single patch. > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Gao, Liming <liming....@intel.com> > > My change mainly are in INF and DEC (Item 1 and 4). Even if we separate them, > the patch is still big. For Item 2&3, 5&6, new UNI files will be added. I > have created ZIP for them. > For UNI file, this has been discussed. UNI files will be changed from > svn:mime-type = application/octect-stream to svn:mime-type = > text/plain;encoding=UTF-16LE. > For second patch, I will send it soon. Sorry for confuse. When git send-email sends out multiple patches, it replies the remaining patches to the first message. So, you get two nice properties from git send-email: 1. The messages all arrive at about the same time 2. In a threaded email view, the whole series in grouped -Jordan > -----Original Message----- > From: Jordan Justen [mailto:jljus...@gmail.com] > Sent: Monday, August 18, 2014 3:57 PM > To: Gao, Liming; Dong, Guo > Cc: edk2-devel@lists.sourceforge.net > Subject: Re: [edk2] [Patch 1/2] [MdePkg] INF/DEC file updates to EDK II > packages > > What is the commit message for this patch? > > It looks like this was missing the Contributed-under and Signed-off-by too. > > On Wed, Aug 13, 2014 at 7:13 PM, Gao, Liming <liming....@intel.com> wrote: >> Hi, all >> >> Could you help review this patch? It includes the following changes >> 1-6 for MdePkg. > > Why are you including 6 changes in a single patch? > >> The patch is a little big. > > Maybe that is because you have 6 changes include in a single patch? :) > >> For new added UNI file, I zip them together. > > Laszlo pointed out how to get .uni diffs for git. I wonder if it is possible > for svn too. > >> The second patch for below item 7 will be sent later > > Is this why you have 1/2 in the subject? > > That is really confusing, since I would expect to see 2/2 sent out along with > 1/2, and that they should be code reviewed together. > > -Jordan > >> 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 >> >> >> >> >> ---------------------------------------------------------------------- >> -------- >> >> _______________________________________________ >> edk2-devel mailing list >> edk2-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/edk2-devel >> ------------------------------------------------------------------------------ _______________________________________________ edk2-devel mailing list edk2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/edk2-devel
