Re: [edk2-devel] [PATCH edk2-InfSpecification] Drop statement on package ordering

["Leif Lindholm" <leif@nuviainc.com>]

Hi Pankaj,

On Tue, Jun 02, 2020 at 13:37:30 +0000, Pankaj Bansal (OSS) wrote:
> > How about replacing
> > 
> > """
> > Packages must be listed in the order that may be required for specifying
> > include path statements for a compiler. For example, the MdePkg/MdePkg.dec_
> > file must be listed before the `MdeModulePkg/MdeModulePkg.dec` file.
> > """
> > 
> > with
> > 
> > """
> > The order in which packages are listed may be relevant. Said order
> > specifies in what order include path statements are generated for a
> > compiler. Normally, header file name collisions are not expected between
> > packages -- they are forbidden in edk2 proper --, but with a module INF
> > consuming both edk2-native and out-of-edk2 packages, header file names
> > may collide. For setting specific include path priorities, the packages
> > may be listed in matching order in the INF file. Listing a package
> > earlier will cause a compiler to consider include paths from that
> > package earlier.
> > """
> 
> Nicely summed up! it is much clearer now for anyone like me who
> wants to port edk2 for his platform.
> one more suggestion. should this be mentioned along with above
> explaination:
> "whenever possible use lexicographically ascending order"

My preference would be that we rework the coding style document to a
document that encompasses style of all contributions, and drop some of
the things that are not style related.

(For example, we already know that we're short on documentation on
Python contributions.)

/
    Leif