Features/Intel/Readme.md: clarify feature package dependency rule

[edk2-devel] [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule

Posted by Ni, Ray 3 years, 10 months ago

From: Ray Ni <niruiyu@users.noreply.github.com>

Original statement only says depending on another feature package
is not allowed. It gives developers impression that board level
packages are allowed to depend on.

This patch clarifies the package dependency rule.

Signed-off-by: Ray Ni <ray.ni@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Amy Chan <amy.chan@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Cc: Isaac W Oram <isaac.w.oram@intel.com>
---
 Features/Intel/Readme.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Features/Intel/Readme.md b/Features/Intel/Readme.md
index 9729f90a41..1a03a4c0d2 100644
--- a/Features/Intel/Readme.md
+++ b/Features/Intel/Readme.md
@@ -17,8 +17,10 @@ document as needed.
 ### Advanced Feature Attributes
 Advanced features should be:
 * _Cohesive_, the feature should not contain any functionality unrelated to the feature.
-* _Complete_, the feature must have a complete design that minimizes dependencies. A feature package cannot directly
-  depend on another feature package.
+* _Complete_, the feature must have a complete design that minimizes dependencies. A feature package can only depend
+  on following packages:
+  * edk2 repo: `MdePkg`, `MdeModulePkg`, `UefiCpuPkg`, `FmpDevicePkg`, `SecurityPkg`, `NetworkPkg`, `ShellPkg`.
+  * edk2-platforms repo: `MinPlatformPkg`, `IntelSiliconPkg`.
 * _Easy to Integrate_, the feature should expose well-defined software interfaces to use and configure the feature.
   * It should also present a set of simple and well-documented standard EDK II configuration options such as PCDs to
   configure the feature.
-- 
2.25.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#61397): https://edk2.groups.io/g/devel/message/61397
Mute This Topic: https://groups.io/mt/74933867/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule

Posted by Dong, Eric 3 years, 10 months ago

Reviewed-by: Eric Dong <eric.dong@intel.com>

> -----Original Message-----
> From: Ni, Ray <ray.ni@intel.com>
> Sent: Wednesday, June 17, 2020 5:03 PM
> To: devel@edk2.groups.io
> Cc: Ray Ni <niruiyu@users.noreply.github.com>; Dong, Eric
> <eric.dong@intel.com>; Chan, Amy <amy.chan@intel.com>; Chaganty,
> Rangasai V <rangasai.v.chaganty@intel.com>; Oram, Isaac W
> <isaac.w.oram@intel.com>
> Subject: [PATCH] Features/Intel/Readme.md: clarify feature package
> dependency rule
> 
> From: Ray Ni <niruiyu@users.noreply.github.com>
> 
> Original statement only says depending on another feature package
> is not allowed. It gives developers impression that board level
> packages are allowed to depend on.
> 
> This patch clarifies the package dependency rule.
> 
> Signed-off-by: Ray Ni <ray.ni@intel.com>
> Cc: Eric Dong <eric.dong@intel.com>
> Cc: Amy Chan <amy.chan@intel.com>
> Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
> Cc: Isaac W Oram <isaac.w.oram@intel.com>
> ---
>  Features/Intel/Readme.md | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/Features/Intel/Readme.md b/Features/Intel/Readme.md
> index 9729f90a41..1a03a4c0d2 100644
> --- a/Features/Intel/Readme.md
> +++ b/Features/Intel/Readme.md
> @@ -17,8 +17,10 @@ document as needed.
>  ### Advanced Feature Attributes
> 
>  Advanced features should be:
> 
>  * _Cohesive_, the feature should not contain any functionality unrelated to
> the feature.
> 
> -* _Complete_, the feature must have a complete design that minimizes
> dependencies. A feature package cannot directly
> 
> -  depend on another feature package.
> 
> +* _Complete_, the feature must have a complete design that minimizes
> dependencies. A feature package can only depend
> 
> +  on following packages:
> 
> +  * edk2 repo: `MdePkg`, `MdeModulePkg`, `UefiCpuPkg`, `FmpDevicePkg`,
> `SecurityPkg`, `NetworkPkg`, `ShellPkg`.
> 
> +  * edk2-platforms repo: `MinPlatformPkg`, `IntelSiliconPkg`.
> 
>  * _Easy to Integrate_, the feature should expose well-defined software
> interfaces to use and configure the feature.
> 
>    * It should also present a set of simple and well-documented standard EDK
> II configuration options such as PCDs to
> 
>    configure the feature.
> 
> --
> 2.25.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#61448): https://edk2.groups.io/g/devel/message/61448
Mute This Topic: https://groups.io/mt/74933867/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-