From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from cpanel8.indieserve.net (cpanel8.indieserve.net [199.212.143.3]) by mx.groups.io with SMTP id smtpd.web09.6158.1615888694111877935 for ; Tue, 16 Mar 2021 02:58:14 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: crashcourse.ca, ip: 199.212.143.3, mailfrom: rpjday@crashcourse.ca) Received: from cpeac202e043973-cmac202e043970.sdns.net.rogers.com ([174.114.107.13]:48848 helo=fedora) by cpanel8.indieserve.net with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94) (envelope-from ) id 1lM6Sl-00FPAO-Jq; Tue, 16 Mar 2021 05:58:12 -0400 Date: Tue, 16 Mar 2021 05:58:05 -0400 (EDT) From: "Robert P. J. Day" To: Quentin Schulz cc: YP docs mailing list Subject: Re: [docs] Description of BBPATH in BB user manual seems ... wrong In-Reply-To: <20210316090127.fcbule36mo4f7npd@qschulz> Message-ID: <3b1972be-a8e2-93da-1b39-f123c2c9d1d@crashcourse.ca> References: <20210315131042.lgjgjzdjtp2ofdey@qschulz> <20210316090127.fcbule36mo4f7npd@qschulz> MIME-Version: 1.0 X-OutGoing-Spam-Status: No, score=-1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - cpanel8.indieserve.net X-AntiAbuse: Original Domain - lists.yoctoproject.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - crashcourse.ca X-Get-Message-Sender-Via: cpanel8.indieserve.net: authenticated_id: rpjday+crashcourse.ca/only user confirmed/virtual account not confirmed X-Authenticated-Sender: cpanel8.indieserve.net: rpjday@crashcourse.ca X-Source: X-Source-Args: X-Source-Dir: Content-Type: multipart/mixed; boundary="8323328-261675694-1615888687=:8034" --8323328-261675694-1615888687=:8034 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8BIT On Tue, 16 Mar 2021, Quentin Schulz wrote: > On Mon, Mar 15, 2021 at 04:19:02PM -0400, Robert P. J. Day wrote: > > On Mon, 15 Mar 2021, Quentin Schulz wrote: > > > > > Hi Robert, > > > > > > On Mon, Mar 15, 2021 at 09:05:53AM -0400, Robert P. J. Day wrote: > > > > > > > > Section 3.4.1 of BB manual: > > > > > > > > https://docs.yoctoproject.org/bitbake/bitbake-user-manual/bitbake-user-manual-metadata.html#locating-include-and-class-files > > > > > > > > "BitBake uses the BBPATH variable to locate needed include and class > > > > files. Additionally, BitBake searches the current directory for > > > > include and require directives. > > > > > > > > ... snip .. > > > > > > > > "In order for include and class files to be found by BitBake, they > > > > need to be located in a “classes” subdirectory that can be found in > > > > BBPATH." > > > > > > > > first, is BBPATH not used for finding conf files as well? and the > > > > > > Yes it is. > > > > > > > wording of that second paragraph suggests that include files need to > > > > be in a classes subdirectory to be found, which i'm pretty sure isn't > > > > true. > > > > > > > > > > I think what was meant by "include" files are conf files.... which > > > (probably) technically are include files to Yocto PoV. > > > > > > Not entirely sure but I think Yocto includes all appropriate conf files > > > to create the "base" "environment" of all recipes. > > > > > > basically, stuff on top of bitbake.conf and what is the environment > > > being reset to between tasks/recipes. > > > > > > Those are guesses though. > > > > well, i think that wording in the BB user manual is at least a > > little misleading, but if others think it's sufficiently clear, i'll > > shut up about it. > > > > I agree with you. Don't know how to reword though. > > Something like what's in YP docs for example: > https://docs.yoctoproject.org/ref-manual/variables.html#term-BBPATH > > Where include files are replaced by configuration files. I guess we > could explicit BBPATH represents the parent directory of classes/ > and conf/ directories where bbclasses and configuration files such > as machine, distro, layer configuration files are. > > My 2¢ on this :) i'll give it some thought. in my experience, ambiguity like this is generally the result of not having laid the groundwork properly. after i went back and reviewed the early stuff, i've concluded that section 1.3, "Concepts": https://docs.yoctoproject.org/bitbake/bitbake-user-manual/bitbake-user-manual-intro.html#concepts could be reworded. really, that entire section could be rewritten as "Files", or at least there should be a section entitled "Files" that describes (with actual examples) the various file types and their relationships before going any further. anyway, i will ponder ... rday --8323328-261675694-1615888687=:8034--