From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.81]) by mx.groups.io with SMTP id smtpd.web12.6031.1591706001958913447 for ; Tue, 09 Jun 2020 05:33:22 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=PRJCJWr1; spf=pass (domain: redhat.com, ip: 207.211.31.81, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1591706001; 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; bh=740kMPThv67o/wptQ0OwUCaK30to+Kkv5DmzrES+2wc=; b=PRJCJWr1bjqIRoT5y7PgD6I6GAbijoYQURVuo6TCLINauhHGgH3PRUWGNjcIBWp8UZ9K5R Z3DtTXBjYfHZ+YtDI7wrHpbdh0e25uSymGZ/6+5pPhXmhrEDpMM3QdsPios9+YUbK7Iecd DYNL5WizNMibFuD5jNT9sEFvG8YLfnY= 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-433-cmxIPm4kMmyE6xGVMCfMIA-1; Tue, 09 Jun 2020 08:33:15 -0400 X-MC-Unique: cmxIPm4kMmyE6xGVMCfMIA-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id CC0C21005510; Tue, 9 Jun 2020 12:33:13 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-113-127.ams2.redhat.com [10.36.113.127]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4DB3C768AE; Tue, 9 Jun 2020 12:33:12 +0000 (UTC) Subject: Re: [edk2-InfSpecification PATCH] Clarify statement on package ordering To: =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , edk2-devel-groups-io Cc: Andrew Fish , Leif Lindholm , Michael Kinney , Pankaj Bansal References: <20200603180438.25361-1-lersek@redhat.com> <3a3ba60a-6090-4f05-e591-36e51467eeb1@redhat.com> From: "Laszlo Ersek" Message-ID: <87e06c52-3c58-a179-3958-662a210e54af@redhat.com> Date: Tue, 9 Jun 2020 14:33:11 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <3a3ba60a-6090-4f05-e591-36e51467eeb1@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 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 On 06/04/20 08:25, Philippe Mathieu-Daudé wrote: > 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 ...". https://en.wiktionary.org/wiki/help#Etymology_2 "He helped his grandfather cook breakfast." "The white paint on the walls helps make the room look brighter." """ Usage notes In uses 1, 2 and 3, this is a catenative verb that takes the /to infinitive/. It can also take the bare infinitive with no change in meaning. """ I tend to use the bare infinitive with "help". > Regardless: > Reviewed-by: Philippe Mathieu-Daude Thanks! Laszlo > >> +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 >> >