* [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule
@ 2020-06-17 9:03 Ni, Ray
2020-06-18 0:31 ` Dong, Eric
0 siblings, 1 reply; 2+ messages in thread
From: Ni, Ray @ 2020-06-17 9:03 UTC (permalink / raw)
To: devel; +Cc: Ray Ni, Eric Dong, Amy Chan, Rangasai V Chaganty, Isaac W Oram
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule
2020-06-17 9:03 [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule Ni, Ray
@ 2020-06-18 0:31 ` Dong, Eric
0 siblings, 0 replies; 2+ messages in thread
From: Dong, Eric @ 2020-06-18 0:31 UTC (permalink / raw)
To: Ni, Ray, devel@edk2.groups.io
Cc: Ray Ni, Chan, Amy, Chaganty, Rangasai V, Oram, Isaac W
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-06-18 0:31 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-06-17 9:03 [PATCH] Features/Intel/Readme.md: clarify feature package dependency rule Ni, Ray
2020-06-18 0:31 ` Dong, Eric
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox