Re: [RFC] Fine-grained review ownership for MdeModulePkg

["Wu, Hao A" <hao.a.wu@intel.com>]

Hello all,

As suggested by Ray and Leif, modules (with wildcard) in MdeModulePkg are
classified to a list of features.

Please note that:
* The below list is a draft at this moment, please help to provide
  feedbacks/comments;
* Modules with no clear classification are listed under the 'Misc' section
  at the bottom of the list.

ACPI:
MdeModulePkg/Include/*/*Acpi*.h
MdeModulePkg/Universal/Acpi/

BDS:
MdeModulePkg/Include/Library/PlatformBootManagerLib.h
MdeModulePkg/Include/Library/UefiBootManagerLib.h
MdeModulePkg/Library/PlatformBootManagerLibNull/
MdeModulePkg/Library/UefiBootManagerLib/
MdeModulePkg/Universal/BdsDxe/
MdeModulePkg/Universal/BootManagerPolicyDxe/
MdeModulePkg/Universal/LoadFileOnFv2/
MdeModulePkg/Universal/SecurityStubDxe/Defer3rdPartyImageLoad.*

Console:
MdeModulePkg/Include/Guid/ConnectConInEvent.h
MdeModulePkg/Include/Guid/ConsoleInDevice.h
MdeModulePkg/Include/Guid/ConsoleOutDevice.h
MdeModulePkg/Include/Guid/StandardErrorDevice.h
MdeModulePkg/Include/Guid/TtyTerm.h
MdeModulePkg/Universal/Console/ConPlatformDxe/
MdeModulePkg/Universal/Console/ConSplitterDxe/
MdeModulePkg/Universal/Console/GraphicsConsoleDxe/
MdeModulePkg/Universal/Console/TerminalDxe/

Core (PEI, DXE and Runtime):
MdeModulePkg/Core/Dxe/*
MdeModulePkg/Core/Dxe/Dispatcher/
MdeModulePkg/Core/Dxe/DxeMain/
MdeModulePkg/Core/Dxe/Event/
MdeModulePkg/Core/Dxe/FwVol*/
MdeModulePkg/Core/Dxe/Hand/
MdeModulePkg/Core/Dxe/Image/
MdeModulePkg/Core/Dxe/Library/
MdeModulePkg/Core/Dxe/Misc/
MdeModulePkg/Core/Dxe/SectionExtraction/
MdeModulePkg/Core/DxeIplPeim/
MdeModulePkg/Core/Pei/*
MdeModulePkg/Core/Pei/BootMode/
MdeModulePkg/Core/Pei/CpuIo/
MdeModulePkg/Core/Pei/Dependency/
MdeModulePkg/Core/Pei/Dispatcher/
MdeModulePkg/Core/Pei/FwVol/
MdeModulePkg/Core/Pei/Hob/
MdeModulePkg/Core/Pei/Image/
MdeModulePkg/Core/Pei/PeiMain/
MdeModulePkg/Core/Pei/Ppi/
MdeModulePkg/Core/Pei/Security/
MdeModulePkg/Core/RuntimeDxe/
MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
MdeModulePkg/Include/Guid/EventExitBootServiceFailed.h
MdeModulePkg/Include/Guid/IdleLoopEvent.h
MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
MdeModulePkg/Include/Library/SecurityManagementLib.h
MdeModulePkg/Library/*SectionExtract*/
MdeModulePkg/Library/DxeSecurityManagementLib/
MdeModulePkg/Universal/PlatformDriOverrideDxe/
MdeModulePkg/Universal/SectionExtraction*/
MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.c

Debug:
MdeModulePkg/Include/Guid/DebugMask.h
MdeModulePkg/Include/Library/DebugAgentLib.h
MdeModulePkg/Include/Ppi/Debug.h
MdeModulePkg/Library/*Debug*/
MdeModulePkg/Universal/Debug*/

Decompress:
MdeModulePkg/Include/Guid/LzmaDecompress.h
MdeModulePkg/Library/*Decompress*/

Device:
MdeModulePkg/Bus/Ata/
MdeModulePkg/Bus/I2c/
MdeModulePkg/Bus/Isa/
MdeModulePkg/Bus/Pci/Ehci*/
MdeModulePkg/Bus/Pci/IdeBusPei/
MdeModulePkg/Bus/Pci/NonDiscoverablePciDeviceDxe/
MdeModulePkg/Bus/Pci/NvmExpress*/
MdeModulePkg/Bus/Pci/PciSioSerialDxe/
MdeModulePkg/Bus/Pci/SataControllerDxe/
MdeModulePkg/Bus/Pci/SdMmc*/
MdeModulePkg/Bus/Pci/Ufs*/
MdeModulePkg/Bus/Pci/Uhci*/
MdeModulePkg/Bus/Pci/Xhci*/
MdeModulePkg/Bus/Scsi/
MdeModulePkg/Bus/Sd/
MdeModulePkg/Bus/Ufs/
MdeModulePkg/Bus/Usb/
MdeModulePkg/Include/*/*Ata*.h
MdeModulePkg/Include/*/*NonDiscoverableDevice*.h
MdeModulePkg/Include/*/*NvmExpress*.h
MdeModulePkg/Include/*/*SerialPort*.h
MdeModulePkg/Include/*/*SdMmc*.h
MdeModulePkg/Include/*/*Ufs*.h
MdeModulePkg/Include/*/*Usb*.h
MdeModulePkg/Include/Guid/S3StorageDeviceInitList.h
MdeModulePkg/Include/Guid/RecoveryDevice.h
MdeModulePkg/Include/Guid/UsbKeyBoardLayout.h
MdeModulePkg/Include/Ppi/StorageSecurityCommand.h
MdeModulePkg/Include/Protocol/Ps2Policy.h
MdeModulePkg/Library/BaseSerialPortLib16550/
MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/
MdeModulePkg/Universal/SerialDxe/

Disk:
MdeModulePkg/Universal/Disk/

EBC:
MdeModulePkg/Include/*/*Ebc*.h
MdeModulePkg/Include/Protocol/DebuggerConfiguration.h
MdeModulePkg/Universal/EbcDxe/

Firmware Update:
MdeModulePkg/Application/CapsuleApp/
MdeModulePkg/Include/*/*Capsule*.h
MdeModulePkg/Include/Library/DisplayUpdateProgressLib.h
MdeModulePkg/Include/Library/FmpAuthenticationLib.h
MdeModulePkg/Include/Protocol/EsrtManagement.h
MdeModulePkg/Include/Protocol/FirmwareManagementProgress.h
MdeModulePkg/Library/DisplayUpdateProgressLib*/
MdeModulePkg/Library/DxeCapsuleLib*/
MdeModulePkg/Library/FmpAuthenticationLibNull/
MdeModulePkg/Universal/Capsule*/
MdeModulePkg/Universal/Esrt*/

Graphic:
MdeModulePkg/Include/*/*Logo*.h
MdeModulePkg/Include/Library/BmpSupportLib.h
MdeModulePkg/Include/Library/FrameBufferBltLib.h
MdeModulePkg/Library/BaseBmpSupportLib/
MdeModulePkg/Library/BootLogoLib/
MdeModulePkg/Library/FrameBufferBltLib/
MdeModulePkg/Logo/
MdeModulePkg/Universal/Console/GraphicsOutputDxe/

HII/UI:
MdeModulePkg/Application/BootManagerMenuApp/
MdeModulePkg/Application/UiApp/
MdeModulePkg/Include/*/*FileExplorer*.h
MdeModulePkg/Include/*/*FormBrowser*.h
MdeModulePkg/Include/*/*Hii*.h
MdeModulePkg/Include/Library/CustomizedDisplayLib.h
MdeModulePkg/Include/Protocol/DisplayProtocol.h
MdeModulePkg/Library/*FileExplorer*/
MdeModulePkg/Library/*Hii*/
MdeModulePkg/Library/*UiLib/
MdeModulePkg/Library/CustomizedDisplayLib/
MdeModulePkg/Universal/DisplayEngineDxe/
MdeModulePkg/Universal/FileExplorerDxe/
MdeModulePkg/Universal/Hii*/
MdeModulePkg/Universal/SetupBrowserDxe/

IPMI:
MdeModulePkg/Include/*/*Ipmi*.h
MdeModulePkg/Library/*Ipmi*/

Memory Management:
MdeModulePkg/Application/MemoryProfileInfo/
MdeModulePkg/Core/Dxe/Gcd/
MdeModulePkg/Core/Dxe/Mem/
MdeModulePkg/Core/Pei/Memory/
MdeModulePkg/Include/*/*Mem*.h
MdeModulePkg/Include/*/*IoMmu*.h
MdeModulePkg/Library/*MemoryAllocation*/
MdeModulePkg/Universal/MemoryTest/

PCD:
MdeModulePkg/Application/DumpDynPcd/
MdeModulePkg/Include/*/*Pcd*.h
MdeModulePkg/Universal/PCD/

PCI Bus:
MdeModulePkg/Bus/Pci/IncompatiblePciDeviceSupportDxe/
MdeModulePkg/Bus/Pci/PciBusDxe/
MdeModulePkg/Bus/Pci/PciHostBridgeDxe/
MdeModulePkg/Core/Pei/PciCfg2/
MdeModulePkg/Include/Library/PciHostBridgeLib.h
MdeModulePkg/Library/PciHostBridgeLibNull/
MdeModulePkg/Universal/PcatSingleSegmentPciCfg2Pei/

Performance:
MdeModulePkg/Include/*/*Perf*.h
MdeModulePkg/Library/*Perf*/

Reset:
MdeModulePkg/Core/Pei/Reset/
MdeModulePkg/Include/*/*Reset*.h
MdeModulePkg/Library/*Reset*/
MdeModulePkg/Universal/ResetSystem*/

S3:
MdeModulePkg/Include/*/*BootScript*.h
MdeModulePkg/Include/*/*LockBox*.h
MdeModulePkg/Include/*/*S3*.h
MdeModulePkg/Library/*LockBox*/
MdeModulePkg/Library/*S3*/
MdeModulePkg/Universal/LockBox/

SMBIOS:
MdeModulePkg/Universal/Smbios*/

SMM:
MdeModulePkg/Application/SmiHandlerProfileInfo/
MdeModulePkg/Core/PiSmmCore/
MdeModulePkg/Include/*/*Smi*.h
MdeModulePkg/Include/*/*Smm*.h
MdeModulePkg/Library/*Smi*/
MdeModulePkg/Library/*Smm*/
MdeModulePkg/Universal/SmmCommunicationBufferDxe/

Status Code:
MdeModulePkg/Core/Pei/StatusCode/
MdeModulePkg/Include/*/*StatusCode*.h
MdeModulePkg/Library/*StatusCode*/
MdeModulePkg/Universal/*StatusCode*/

Variable:
MdeModulePkg/Application/VariableInfo/
MdeModulePkg/Include/*/*FaultTolerantWrite*.h
MdeModulePkg/Include/*/*Var*.h
MdeModulePkg/Include/Guid/SystemNvDataGuid.h
MdeModulePkg/Include/Protocol/SwapAddressRange.h
MdeModulePkg/Library/*Var*/
MdeModulePkg/Universal/FaultTolerantWrite*/
MdeModulePkg/Universal/Variable/

Misc:
MdeModulePkg/Application/HelloWorld/
MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h
MdeModulePkg/Include/Guid/MtcVendor.h
MdeModulePkg/Include/Guid/ZeroGuid.h
MdeModulePkg/Include/Library/CpuExceptionHandlerLib.h
MdeModulePkg/Include/Library/PlatformHookLib.h
MdeModulePkg/Include/Library/RecoveryLib.h
MdeModulePkg/Include/Library/SortLib.h
MdeModulePkg/Include/Library/TpmMeasurementLib.h
MdeModulePkg/Include/Protocol/Dpc.h
MdeModulePkg/Include/Protocol/LoadPe32Image.h
MdeModulePkg/Include/Protocol/PeCoffImageEmulator.h
MdeModulePkg/Include/Protocol/Print2.h
MdeModulePkg/Library/BaseHobLibNull/
MdeModulePkg/Library/BasePlatformHookLibNull/
MdeModulePkg/Library/BaseSortLib/
MdeModulePkg/Library/CpuExceptionHandlerLibNull/
MdeModulePkg/Library/DxePrintLibPrint2Protocol/
MdeModulePkg/Library/PeiRecoveryLibNull/
MdeModulePkg/Library/PlatformHookLibSerialPortPpi/
MdeModulePkg/Library/TpmMeasurementLibNull/
MdeModulePkg/Library/UefiSortLib/
MdeModulePkg/Universal/DevicePathDxe/
MdeModulePkg/Universal/DriverHealthManagerDxe/
MdeModulePkg/Universal/DriverSampleDxe/
MdeModulePkg/Universal/FvSimpleFileSystemDxe/
MdeModulePkg/Universal/LegacyRegion2Dxe/
MdeModulePkg/Universal/Metronome/
MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/
MdeModulePkg/Universal/PrintDxe/
MdeModulePkg/Universal/RegularExpressionDxe/
MdeModulePkg/Universal/TimestampDxe/
MdeModulePkg/Universal/WatchdogTimerDxe/


Best Regards,
Hao Wu


> -----Original Message-----
> From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> Sent: Tuesday, June 11, 2019 5:52 PM
> To: Wu, Hao A
> Cc: devel@edk2.groups.io; lersek@redhat.com; Kinney, Michael D; Andrew
> Fish; Justen, Jordan L; Ard Biesheuvel; Gao, Liming; Yao, Jiewen; Zeng, Star
> Subject: Re: [RFC] Fine-grained review ownership for MdeModulePkg
> 
> Hi Wu Hao,
> 
> I am working on a proposal (and proof-of-concept) machine readable
> Maintainers.txt format, and a GetMaintainer.py script, based on the
> format used by QEMU.
> 
> One of the key features of that format is the F: tag, which specifes a
> filesytem path (with wildcard support).
> 
> While this is just an RFC in progress (to be sent out later in week),
> if you could take that into account, and figure out which paths
> correspond to which areas of responsibility, that would make a test
> run of the script much easier.
> 
> For my part, I would suggest adding (not just for MdeModulePkg)
> F: */ARM/*
> F: */AARCH64/*
> as maintained by myself and Ard.
> 
> Best Regards,
> 
> Leif
> 
> On Mon, Jun 10, 2019 at 08:06:23AM +0000, Wu, Hao A wrote:
> > Hello all,
> >
> > Driven by the issue raised and discussions with thread:
> > https://edk2.groups.io/g/devel/topic/31907735#42076
> >
> > This RFC proposal is raised to work out a fine-grained review ownership
> > for MdeModulePkg.
> >
> > The goal is to update the 'MdeModulePkg' section in file Maintainers.txt
> > to resemble the format like the 'OvmfPkg' section. Several reviewers will
> > be listed to take the ownership to review patches for a specific feature
> > in the package.
> >
> > In order to get the list of reviewers, a 2-step process will be adopted:
> > 1. Work out a list that contains major features in MdeModulePkg.
> > 2. Call for owners for every item in the list.
> >
> > For 1, a coarse feature list is:
> > Acpi
> > Bds
> > Capsule
> > Compress
> > Console
> > Core (PeiCore, DxeCore, PiSmmCore, etc. Mainly content in
> MdeModulePkg/Core/ folder)
> > Device (peripheral & storage)
> > Disk
> > EBC
> > HII
> > MemoryManagement (include memory test, memory allocation, memory
> profile, etc.)
> > PCD
> > PCI bus
> > Reset
> > S3 (including LockBox)
> > SMBIOS
> > SMM
> > Status Code
> > UI
> > Variable
> > Misc (all the components that do not fit in the above items)
> >
> > Once we think the granularity of the above list is fine and there is no
> > significant feature missing, I will update such list to include the
> > modules that belong to a specific feature. So adjustments can be done to
> > work out the final feature list.
> >
> > The proposal here is far from mature, so any feedback/suggestion will be
> > appreciated.
> >
> >
> > Best Regards,
> > Hao Wu
> >
> >