From nobody Sun Apr 28 22:39:32 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+60694+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+60694+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1591207496; cv=none; d=zohomail.com; s=zohoarc; b=TN9i8PWCytVfuToMLrEI9GKs+686VPJUN+1XhSzeKxquIDU1CGeFttWr7IVB9lnejFfmPkNzu0kj3C7tFcJbj2K1RhzsEfduRnbzXYFIe0X6qm19AFv8yeHU+QqTGEbwI9V6AbIK/vSkG5s7qX/V6Hy3mXko5JULXh1hRRtSl/k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1591207496; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=q+AkbDApaeB4EhmnFK+3gyLdZMbwY1sIyeOpabcLiYg=; b=d642ZWYmj5pjNmRSEvuhTFJRvbLSzkcOOsHVPQU7fH9JVxw91KRouwveCtS71iFC+G4FOSdnfo5pm5fR5n/gF9RT0+gnDdbcTKkpWHwJ32pLKcqqnmxWl1d20ISKjpZYmLl8x2w89kNVF7my23fT9pejVIm2WSWcCvU8T1JDHYI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+60694+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1591207496784598.4843475125307; Wed, 3 Jun 2020 11:04:56 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id 2HlpYY1788612xwKRNA6lVEK; Wed, 03 Jun 2020 11:04:56 -0700 X-Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.120]) by mx.groups.io with SMTP id smtpd.web11.1693.1591207495817477770 for ; Wed, 03 Jun 2020 11:04:56 -0700 X-Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-124-Ia_iLjhKMBinI4YXpyE0yQ-1; Wed, 03 Jun 2020 14:04:42 -0400 X-MC-Unique: Ia_iLjhKMBinI4YXpyE0yQ-1 X-Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 2D799461; Wed, 3 Jun 2020 18:04:41 +0000 (UTC) X-Received: from lacos-laptop-7.usersys.redhat.com (ovpn-115-50.ams2.redhat.com [10.36.115.50]) by smtp.corp.redhat.com (Postfix) with ESMTP id 98EAE5D9CD; Wed, 3 Jun 2020 18:04:39 +0000 (UTC) From: "Laszlo Ersek" To: edk2-devel-groups-io Cc: Andrew Fish , Leif Lindholm , Michael Kinney , Pankaj Bansal , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= Subject: [edk2-devel] [edk2-InfSpecification PATCH] Clarify statement on package ordering Date: Wed, 3 Jun 2020 20:04:38 +0200 Message-Id: <20200603180438.25361-1-lersek@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,lersek@redhat.com X-Gm-Message-State: P6DUDEbJ4GceUukXI8e3FxoXx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1591207496; bh=q+AkbDApaeB4EhmnFK+3gyLdZMbwY1sIyeOpabcLiYg=; h=Cc:Content-Type:Date:From:Reply-To:Subject:To; b=BZ/8PlYH2lyWP/SVoZ3GthU8QHaPC5zJKiIVLzqJOgfyYYfjSFMnQ/Fq4g94mn8/NLp b7KdyZRAKG+nhnxTQGULRPkLQF4JU9Q/o0E6ueMXI7pPJnKh4J3Vtes12m5ryE5TuuGx6 O4qQoOo183HcZLD1PuiDpy/3tWP63nHdeJ4= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" 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=C3=A9 Suggested-by: Leif Lindholm Signed-off-by: Laszlo Ersek Reviewed-by: Michael D Kinney Reviewed-by: Philippe Mathieu-Daude --- 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.) =20 (2) Repo: https://github.com/lersek/edk2-InfSpecification Branch: pkgs_order =20 (3) Rendered view: =20 https://lersek.gitbook.io/laszlo-s-fork-of-the-edk-ii-module-inform= ation-inf/v/pkgs_order/3_edk_ii_inf_file_format/37_-packages-_sections#summ= ary 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 ED= K II module INF files. Each entry in this section contains a directory name, forward slash charac= ter and the name of the DEC file contained in the directory name. =20 -Packages must be listed in the order that may be required for specifying -include path statements for a compiler. For example, the _MdePkg/MdePkg.de= c_ -file must be listed before the `MdeModulePkg/MdeModulePkg.dec` file. If th= ere -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 specifi= es in +what order include path statements are generated for a compiler. This may = help +resolve header file name collisions between packages (although such collis= ions +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. =20 Each package filename must be listed only once per section. Package filena= mes listed in architectural sections are not permitted to be listed in the com= mon --=20 2.19.1.3.g30247aa5d201 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#60694): https://edk2.groups.io/g/devel/message/60694 Mute This Topic: https://groups.io/mt/74655419/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-