Re: [edk2] [RFC] EDK II: Add Maintainers.txt file

Subject: Re: [edk2] [RFC] EDK II: Add Maintainers.txt file

From: "Carsey, Jaben" <jaben.carsey@intel.com>

To: "edk2-devel@lists.sourceforge.net" <edk2-devel@lists.sourceforge.net>

Date: 2014-09-09 22:36:33

I like it.

-----Original Message-----
From: Laszlo Ersek [mailto:lersek@redhat.com] 
Sent: Tuesday, September 09, 2014 2:03 AM
To: edk2-devel@lists.sourceforge.net
Subject: Re: [edk2] [RFC] EDK II: Add Maintainers.txt file

some comments

On 09/09/14 07:43, Jordan Justen wrote:
> This file's content is partially based on the QEMU project's
> MAINTAINERS file.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Jordan Justen 
> ---
> 
>  All: It seems like there was a positive response to this idea. How
>  does this look for a starting point?
> 
>  Maintainers.txt | 150 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 150 insertions(+)
>  create mode 100644 Maintainers.txt
> 
> diff --git a/Maintainers.txt b/Maintainers.txt
> new file mode 100644
> index 0000000..48501d3
> --- /dev/null
> +++ b/Maintainers.txt
> @@ -0,0 +1,150 @@
> +EDK II Maintainers
> +==================
> +
> +This file provides information about the primary maintainers for
> +EDK II.
> +
> +In general, you should not privately email the maintainer. You should
> +email the edk2-devel list, but you can also Cc the maintainer.
> +
> +Descriptions of section entries:
> +
> +  L: Mailing list that is relevant to this area (default is edk2-devel)
> +     Patches and questions should be sent the email list

I'm not a native speaker, but I'd say "sent to the email list". Also,
consider adding a period (or two).

> +  M: Cc address for patches and questions (ie, the package maintainer)
> +  W: Web-page with status/info
> +  T: SCM tree type and location.  Type is one of: git, svn.
> +  S: Status, one of the following:
> +     Supported:  Someone is actually paid to look after this.
> +     Maintained: Someone actually looks after it.
> +     Odd Fixes:  It has a maintainer but they don't have time to do
> +                 much other than throw the odd patch in. See below.
> +     Orphan:     No current maintainer [but maybe you could take the
> +                 role as you write your new code].
> +     Obsolete:   Old code. Something tagged obsolete generally means
> +                 it has been replaced by a better system and you
> +                 should be using that.
> +
> +EDK II
> +------
> +W: http://tianocore.github.io/edk2/
> +L: https://lists.sourceforge.net/lists/listinfo/edk2-devel
> +T: git - https://github.com/tianocore/edk2.git
> +T: git - https://bitbucket.org/tianocore/edk2.git
> +T: git - http://git.code.sf.net/p/tianocore/edk2
> +T: svn - https://svn.code.sf.net/p/edk2/code/trunk/edk2
> +
> +Responsible Disclosure, Reporting Security Issues
> +-------------------------------------------------
> +W: https://github.com/tianocore/tianocore.github.io/wiki/Security

I didn't know this page (or the
 email address) existed.
Attests the utility of this file.

> +
> +EDK II Releases:
> +----------------
> +UDK2014
> +W: http://tianocore.github.io/udk2014/
> +S: Supported
> +
> +EDK II Packages:
> +----------------
> +AppPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/AppPkg
> +
> +ArmPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/ArmPkg
> +
> +ArmPlatformPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/ArmPlatformPkg
> +
> +BaseTools
> +W: https://github.com/tianocore/tianocore.github.io/wiki/BaseTools
> +
> +BeagleBoardPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/BeagleBoardPkg
> +
> +CryptoPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/CryptoPkg
> +
> +DuetPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/DuetPkg
> +
> +EdkCompatibilityPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/EdkCompatibilityPkg
> +
> +EdkShellBinPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/EdkShellBinPkg
> +
> +EdkShellPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/EdkShellPkg

This needs a custom T entry:

T: svn - https://svn.code.sf.net/p/efi-shell/code/trunk/Shell/

> +
> +EmbeddedPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/EmbeddedPkg
> +
> +EmulatorPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
> +M: Jordan Justen 
> +M: Andrew Fish 
> +S: Maintained
> +
> +FatBinPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/FatBinPkg

I would mention FatPkg here, with the appropriate T links:

T: svn - https://svn.code.sf.net/p/edk2-fatdriver2/code/trunk/FatPkg/
T: git - https://github.com/tianocore/edk2-FatPkg
T: git - ...

> +
> +IntelFrameworkModulePkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFrameworkModulePkg
> +
> +IntelFrameworkPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFrameworkPkg
> +
> +IntelFspPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFspPkg
> +
> +IntelFspWrapperPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFspWrapperPkg
> +
> +MdeModulePkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/MdeModulePkg
> +
> +MdePkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/MdePkg
> +
> +NetworkPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/NetworkPkg
> +
> +Nt32Pkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/Nt32Pkg
> +
> +Omap35xxPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/Omap35xxPkg
> +
> +OptionRomPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/OptionRomPkg
> +
> +OvmfPkg
> +W: http://tianocore.github.io/ovmf/
> +M: Jordan Justen 
> +M: Laszlo Ersek 
> +S: Maintained

looks good (and thanks!)

> +
> +PcAtChipsetPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/PcAtChipsetPkg
> +
> +PerformancePkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/PerformancePkg
> +
> +SecurityPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/SecurityPkg
> +
> +ShellBinPkg, ShellPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/ShellPkg

Contracting ShellBinPkg and ShellPkg to the same line probably makes
sense, but then FatBinPkg (+ FatPkg) and EdkShellBinPkg (+ EdkShellPkg)
should follow suit, no?

> +
> +SourceLevelDebugPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/SourceLevelDebugPkg
> +
> +StdLib, StdLibPrivateInternalFiles
> +W: https://github.com/tianocore/tianocore.github.io/wiki/StdLib
> +
> +UefiCpuPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/UefiCpuPkg
> +
> +UnixPkg
> +W: https://github.com/tianocore/tianocore.github.io/wiki/UnixPkg
> +S: Obsolete (Use EmulatorPkg instead)
> 

Seems okay to me otherwise.

Thanks
Laszlo

------------------------------------------------------------------------------
Want excitement?
Manually upgrade your production database.
When you want reliability, choose Perforce.
Perforce version control. Predictably reliable.
http://pubads.g.doubleclick.net/gampad/clk?id=157508191&iu=/4140/ostg.clktrk
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/edk2-devel

------------------------------------------------------------------------------
Want excitement?
Manually upgrade your production database.
When you want reliability, choose Perforce.
Perforce version control. Predictably reliable.
http://pubads.g.doubleclick.net/gampad/clk?id=157508191&iu=/4140/ostg.clktrk
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/edk2-devel