From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.120]) by mx.groups.io with SMTP id smtpd.web12.8246.1591251956164066763 for ; Wed, 03 Jun 2020 23:25:56 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=OurhcPkU; spf=pass (domain: redhat.com, ip: 205.139.110.120, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1591251955; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:autocrypt:autocrypt; bh=dQ0IIoRlGTuulpSIyaZLUzolK5qxoEXmDXSXN5irDaw=; b=OurhcPkUING7BnBlJxPQjhZKvAs6FCCRi6B0hoY545Vf5oJ1dBu2s+MAvmfzboXJRaQvQk pXP6ElAYAEi1IXF6J+9WQIEcnAGOpTD59Smpp596E7RAkrhURTo55jO2IE1LqouS80p9LA P4WxgILnoc1+XWUagHWtvIP6bFAQu6I= Received: from mail-wr1-f70.google.com (mail-wr1-f70.google.com [209.85.221.70]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-160-iKxAiWOxOhuOVj65ndHhrw-1; Thu, 04 Jun 2020 02:25:51 -0400 X-MC-Unique: iKxAiWOxOhuOVj65ndHhrw-1 Received: by mail-wr1-f70.google.com with SMTP id e7so1999319wrp.14 for ; Wed, 03 Jun 2020 23:25:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:autocrypt :message-id:date:user-agent:mime-version:in-reply-to :content-language:content-transfer-encoding; bh=dQ0IIoRlGTuulpSIyaZLUzolK5qxoEXmDXSXN5irDaw=; b=N4TuFboWOZYkgpB5bkCIVC7MfLqAbsbftsuCEWqazTSk+s/MXXPxi9t7ulpo9jFkNx aF/BoTnonuDnfqRi2zoHwFx0zwf7isGcnlU+asUa3E0wFi8hCkwtgpXmHfF2wK6Grv73 wWVbx17IJ+ZHcYFI0yK1EnzfkwiDwVih6JwuH75cD+uCgmlWXZ8txeTczZrrwdUymRV1 uGUoTnkoJmZiGvxjRJLYJAGGxxH6Ey7rn5j05LZG1J/nbHen5M+5n/ldFt4hMUglNHjP CyTUXmUvoGsRZqSHCVN4ZsWBZuVirPgQsBLA9euk46Mlz+O+ambwq7HsO2K8bEjTIt6T 8gXw== X-Gm-Message-State: AOAM532V8Hrq4iHsrMx+ixZOw0CeOP1vQpJOIMUWsDovvjOQDSxtu4+e QaYVAdysnSY9GRdK9Vj6eW8IwzVSvbCH5FqCSg9t9wPJ90XhaqlDY7VxOp3hPkCYdJlvYTNwUn7 TU3u+H77VtL1E5w== X-Received: by 2002:a7b:c0c8:: with SMTP id s8mr2574662wmh.134.1591251950012; Wed, 03 Jun 2020 23:25:50 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyDnDAp3tyrK53Jo9/rDOQSi9/2z3m9/loH9U0W0lD/Y19iZSI9K4FmzR5Sm44HFhsxFp20fQ== X-Received: by 2002:a7b:c0c8:: with SMTP id s8mr2574644wmh.134.1591251949786; Wed, 03 Jun 2020 23:25:49 -0700 (PDT) Return-Path: Received: from [192.168.1.43] (181.red-88-10-103.dynamicip.rima-tde.net. [88.10.103.181]) by smtp.gmail.com with ESMTPSA id t7sm6631818wrq.41.2020.06.03.23.25.48 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 03 Jun 2020 23:25:49 -0700 (PDT) Subject: Re: [edk2-InfSpecification PATCH] Clarify statement on package ordering To: Laszlo Ersek , edk2-devel-groups-io Cc: Andrew Fish , Leif Lindholm , Michael Kinney , Pankaj Bansal References: <20200603180438.25361-1-lersek@redhat.com> From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= Autocrypt: addr=philmd@redhat.com; keydata= mQINBDXML8YBEADXCtUkDBKQvNsQA7sDpw6YLE/1tKHwm24A1au9Hfy/OFmkpzo+MD+dYc+7 bvnqWAeGweq2SDq8zbzFZ1gJBd6+e5v1a/UrTxvwBk51yEkadrpRbi+r2bDpTJwXc/uEtYAB GvsTZMtiQVA4kRID1KCdgLa3zztPLCj5H1VZhqZsiGvXa/nMIlhvacRXdbgllPPJ72cLUkXf z1Zu4AkEKpccZaJspmLWGSzGu6UTZ7UfVeR2Hcc2KI9oZB1qthmZ1+PZyGZ/Dy+z+zklC0xl XIpQPmnfy9+/1hj1LzJ+pe3HzEodtlVA+rdttSvA6nmHKIt8Ul6b/h1DFTmUT1lN1WbAGxmg CH1O26cz5nTrzdjoqC/b8PpZiT0kO5MKKgiu5S4PRIxW2+RA4H9nq7nztNZ1Y39bDpzwE5Sp bDHzd5owmLxMLZAINtCtQuRbSOcMjZlg4zohA9TQP9krGIk+qTR+H4CV22sWldSkVtsoTaA2 qNeSJhfHQY0TyQvFbqRsSNIe2gTDzzEQ8itsmdHHE/yzhcCVvlUzXhAT6pIN0OT+cdsTTfif MIcDboys92auTuJ7U+4jWF1+WUaJ8gDL69ThAsu7mGDBbm80P3vvUZ4fQM14NkxOnuGRrJxO qjWNJ2ZUxgyHAh5TCxMLKWZoL5hpnvx3dF3Ti9HW2dsUUWICSQARAQABtDJQaGlsaXBwZSBN YXRoaWV1LURhdWTDqSAoUGhpbCkgPHBoaWxtZEByZWRoYXQuY29tPokCVQQTAQgAPwIbDwYL CQgHAwIGFQgCCQoLBBYCAwECHgECF4AWIQSJweePYB7obIZ0lcuio/1u3q3A3gUCXsfWwAUJ KtymWgAKCRCio/1u3q3A3ircD/9Vjh3aFNJ3uF3hddeoFg1H038wZr/xi8/rX27M1Vj2j9VH 0B8Olp4KUQw/hyO6kUxqkoojmzRpmzvlpZ0cUiZJo2bQIWnvScyHxFCv33kHe+YEIqoJlaQc JfKYlbCoubz+02E2A6bFD9+BvCY0LBbEj5POwyKGiDMjHKCGuzSuDRbCn0Mz4kCa7nFMF5Jv piC+JemRdiBd6102ThqgIsyGEBXuf1sy0QIVyXgaqr9O2b/0VoXpQId7yY7OJuYYxs7kQoXI 6WzSMpmuXGkmfxOgbc/L6YbzB0JOriX0iRClxu4dEUg8Bs2pNnr6huY2Ft+qb41RzCJvvMyu gS32LfN0bTZ6Qm2A8ayMtUQgnwZDSO23OKgQWZVglGliY3ezHZ6lVwC24Vjkmq/2yBSLakZE 6DZUjZzCW1nvtRK05ebyK6tofRsx8xB8pL/kcBb9nCuh70aLR+5cmE41X4O+MVJbwfP5s/RW 9BFSL3qgXuXso/3XuWTQjJJGgKhB6xXjMmb1J4q/h5IuVV4juv1Fem9sfmyrh+Wi5V1IzKI7 RPJ3KVb937eBgSENk53P0gUorwzUcO+ASEo3Z1cBKkJSPigDbeEjVfXQMzNt0oDRzpQqH2vp apo2jHnidWt8BsckuWZpxcZ9+/9obQ55DyVQHGiTN39hkETy3Emdnz1JVHTU0Q== Message-ID: <3a3ba60a-6090-4f05-e591-36e51467eeb1@redhat.com> Date: Thu, 4 Jun 2020 08:25:47 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.5.0 MIME-Version: 1.0 In-Reply-To: <20200603180438.25361-1-lersek@redhat.com> X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Hi Laszlo, On 6/3/20 8:04 PM, Laszlo Ersek wrote: > The description of [Packages] sections states, > >> 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. > > Clarify that the listing order in [Packages] is only relevant for > resolving header file name collisions between packages. Mention that such > collisions are generally not expected. Remove the example about MdePkg and > MdeModulePkg, because both of those are in edk2, and we'd certainly > address a collision between those packages explicitly (e.g., by renaming > one of the subject header files). > > Cc: Andrew Fish > Cc: Leif Lindholm > Cc: Michael Kinney > Cc: Pankaj Bansal > Cc: Philippe Mathieu-Daudé > Suggested-by: Leif Lindholm > Signed-off-by: Laszlo Ersek > --- > > Notes: > (1) This is the one shot I'm willing to take. If it's not accepted, > someone else will have to work on this. (I only meant to provide > some wording ideas under Leif's patch; I don't have time for > multiple iterations on an actual INF spec patch.) > > (2) Repo: https://github.com/lersek/edk2-InfSpecification > Branch: pkgs_order > > (3) Rendered view: > > https://lersek.gitbook.io/laszlo-s-fork-of-the-edk-ii-module-information-inf/v/pkgs_order/3_edk_ii_inf_file_format/37_-packages-_sections#summary > > 3_edk_ii_inf_file_format/37_[packages]_sections.md | 15 ++++++++++----- > 1 file changed, 10 insertions(+), 5 deletions(-) > > diff --git a/3_edk_ii_inf_file_format/37_[packages]_sections.md b/3_edk_ii_inf_file_format/37_[packages]_sections.md > index 17a8d91ec8aa..6f8b8b6dd250 100644 > --- a/3_edk_ii_inf_file_format/37_[packages]_sections.md > +++ b/3_edk_ii_inf_file_format/37_[packages]_sections.md > @@ -42,11 +42,16 @@ Defines the `[Packages]` section tag that is used in EDK II module INF files. > Each entry in this section contains a directory name, forward slash character > and the name of the DEC file contained in the directory name. > > -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. If there > -are PCDs listed in the generated "As Built" INF, the packages that declare any > -PCDs must be listed in this section. > +The order in which packages are listed may be relevant. Said order specifies in > +what order include path statements are generated for a compiler. This may help I'm obviously not a native English speaker, but I'd have use "may help [to] resolve ...". Regardless: Reviewed-by: Philippe Mathieu-Daude > +resolve header file name collisions between packages (although such collisions > +are normally not expected). 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. > + > +If there are PCDs listed in the generated "As Built" INF, the packages that > +declare any PCDs must be listed in this section. > > Each package filename must be listed only once per section. Package filenames > listed in architectural sections are not permitted to be listed in the common >