Current package directory guidance doesn't give the exception for opensource project header file to stay out of package's Include directory (Bugzilla Bug 3133)

[tianocore-issues]

This issue was created automatically with bugzilla2github

Bugzilla Bug 3133

Date: 2020-12-21T10:02:48+00:00
From: @changab
To: @lgao4
CC: @lgao4

Last updated: 2020-12-21T21:01:44+00:00

[tianocore-issues]

Comment 14633

Date: 2020-12-21 10:02:48 +0000
From: @changab

• Industry Specification: ---
• Release Observed: EDK II Master
• Releases to Fix: EDK II Master
• Target OS: ---
• Bugzilla Assignee(s): @lgao4

In EDKII module writer's guide section 2.1.2, it says "The include directory contains all public header files that are exposed by this package and are used by this package and other packages". However, the opensource project header files are not under package's Include directory and the header file may be referred by the modules which are (or not) in the same package as the external opensource module. This violates the guidance in section 2.1.2. We should make the exception for the opensource library use case.

[tianocore-issues]

Comment 14636

Date: 2020-12-21 20:54:53 +0000
From: @lgao4

Here is edk2 module write guide doc git https://github.com/tianocore-docs/edk2-ModuleWriteGuide. It can be updated.

[tianocore-issues]

Comment 14637

Date: 2020-12-21 20:55:22 +0000
From: @lgao4

Here is edk2 module write guide doc git https://github.com/tianocore-docs/edk2-ModuleWriteGuide. It can be updated.

[tianocore-issues]

Comment 14643

Date: 2020-12-21 21:01:44 +0000
From: @lgao4

Liming takes it.