[edk2-rfc] [edk2-platforms] Add Features directory

[edk2-rfc] [edk2-platforms] Add Features directory

[Kubacki, Michael A]

Hello,

This RFC proposes adding a new directory to edk2-platforms called
"Features". The purpose of this directory is to add support code
for platform features. Intel would like to maintain features in the
form of feature packages in which a feature may be composed of
multiple libraries, modules, and/or other resources in the package.
The features Intel would like to support are generally intended to
be generic and compatible across a large number (if not all) of
Intel's open source platform code. Collaboration to expand support
of feature code is also welcome.

Reason for the new directory:
Currently some feature packages have started being maintained in
Platform/Intel such as DebugFeaturePkg. However, it would be
preferable to separate basic platform support packages such as
that in KabylakeOpenBoardPkg from generic feature packages.
This is especially true as the number of board support packages
and feature packages increase in Platform/Intel. The creation of
the Features directory would align with the logical separation of
package paths for other pieces needed to build an Intel firmware
in edk2-platforms:
  1. Basic platform support code: Platform/Intel
  2. Silicon initialization support code: Silicon/Intel
  3. Advanced feature support code: Features/Intel

The advanced feature is a concept introduced in EDK II Minimum
Platform. This concept is briefly described in the Platform/Intel
Readme.md:
https://github.com/tianocore/edk2-platforms/blob/master/Platform/Intel/Readme.md

On a related note, a preview of how the Features/Intel directory
might be used is available in the following fork:
https://github.com/makubacki/edk2-platforms/tree/advanced_feature_reorg

For this RFC, the request is simply for the creation of
edk2-platforms/Features to hold feature content.

Thanks,
Michael

Re: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory

[Ni, Ray]

[-- Attachment #1: Type: text/plain, Size: 457 bytes --]

Basically I think the "/Features" directory is a good idea. It separates the common features from the concrete platforms.
Minor comment: Given today here are "Drivers", "Platform" and "Silicon" under the root of edk2-platforms repo, do you think that it's better to use "/Feature" to align existing names?

I also wanted to change "Drivers" to "Driver" (https://edk2.groups.io/g/devel/message/47203?p=,,,20,0,0,0::Created,,OptionRomPkg,20,2,0,33080721)

[-- Attachment #2: Type: text/html, Size: 669 bytes --]

Re: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory

[Kubacki, Michael A]

[-- Attachment #1: Type: text/plain, Size: 848 bytes --]

I think the plural name is more intuitive since there will be more than one feature but I don’t have a strong preference.

Thanks,
Michael

From: Ni, Ray <ray.ni@intel.com>
Sent: Thursday, November 21, 2019 12:05 AM
To: Kubacki; Kubacki, Michael A <michael.a.kubacki@intel.com>; devel@edk2.groups.io
Subject: Re: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory


Basically I think the "/Features" directory is a good idea. It separates the common features from the concrete platforms. Minor comment: Given today here are "Drivers", "Platform" and "Silicon" under the root of edk2-platforms repo, do you think that it's better to use "/Feature" to align existing names?

I also wanted to change "Drivers" to "Driver" (https://edk2.groups.io/g/devel/message/47203?p=,,,20,0,0,0::Created,,OptionRomPkg,20,2,0,33080721)

[-- Attachment #2: Type: text/html, Size: 3463 bytes --]

Re: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory

[Ni, Ray]

[-- Attachment #1: Type: text/plain, Size: 1254 bytes --]

I am fine as long as the names are consistent, either all singular or all plural.

From: Kubacki, Michael A <michael.a.kubacki@intel.com>
Sent: Friday, November 22, 2019 7:12 AM
To: Ni, Ray <ray.ni@intel.com>; devel@edk2.groups.io
Subject: RE: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory

I think the plural name is more intuitive since there will be more than one feature but I don’t have a strong preference.

Thanks,
Michael

From: Ni, Ray <ray.ni@intel.com<mailto:ray.ni@intel.com>>
Sent: Thursday, November 21, 2019 12:05 AM
To: Kubacki; Kubacki, Michael A <michael.a.kubacki@intel.com<mailto:michael.a.kubacki@intel.com>>; devel@edk2.groups.io<mailto:devel@edk2.groups.io>
Subject: Re: [edk2-devel] [edk2-rfc] [edk2-platforms] Add Features directory


Basically I think the "/Features" directory is a good idea. It separates the common features from the concrete platforms. Minor comment: Given today here are "Drivers", "Platform" and "Silicon" under the root of edk2-platforms repo, do you think that it's better to use "/Feature" to align existing names?

I also wanted to change "Drivers" to "Driver" (https://edk2.groups.io/g/devel/message/47203?p=,,,20,0,0,0::Created,,OptionRomPkg,20,2,0,33080721)

[-- Attachment #2: Type: text/html, Size: 4544 bytes --]