Bug 4981

Summary: Add COREBASE to variable reference
Product: [Documentation] Reference Reporter: Laszlo Papp <lpapp>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: VERIFIED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: corneliux.stoicescu, poky.doc.watcher, poky.watcher, ross.burton, sgw, srifenbark
Version: unspecified   
Target Milestone: 1.5   
Hardware: x86   
OS: Multiple   
URL: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=a3623887a3cfd3df47a09b8fd337a2741b5aaa42
Whiteboard: 13 August 2013: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Laszlo Papp 2013-08-05 09:28:31 UTC
Based on 4980, this is a separate report.
Comment 1 Ross Burton 2013-08-05 09:33:54 UTC
If you're going to fork bugs, please also copy the relevant information.

"COREBASE: the location of the meta/ directory from oe-core."
Comment 2 Ross Burton 2013-08-05 09:45:19 UTC
Clarification: COREBASE is the directory that *contains* meta/.
Comment 3 Laszlo Papp 2013-08-05 09:48:14 UTC
In that case, it is the same as requested in 4980 unless there is any other trick involved.
Comment 4 Ross Burton 2013-08-05 09:50:39 UTC
It's polite to not force anyone to have to jump around bugs to find the information they're after.
Comment 5 Laszlo Papp 2013-08-05 09:53:45 UTC
No no, I mean COREBASE already covers the use case of 4980 as it would return the poky root.
Comment 6 Ross Burton 2013-08-05 09:58:40 UTC
Right, agreed.  I was just writing a comment there with examples.
Comment 7 Laszlo Papp 2013-08-05 10:03:30 UTC
Whoever writes the documentation, please make sure it cannot be misunderstood. It is _not_ the oe-core meta layer, but the parent of it, i.e. in case of poky, it is the poky root.
Comment 8 Ross Burton 2013-08-05 10:06:38 UTC
Incorrect.

meta/conf/layer.conf:COREBASE = '${@os.path.normpath("${LAYERDIR}/../")}'

It is explicitly the parent of the meta directory, and saying "the Poky root" makes no sense in Yocto builds that don't use Poky, and is wrong in situations where layers are not at the top level.
Comment 9 Laszlo Papp 2013-08-05 10:10:00 UTC
Actually, your code just confirms me correct. Please read it carefully again, and compare to what I wrote.

As for the poky, it is an example to understand it with a real-world scenario, so it definitely makes sense to mention in here to help with the understanding of the documentation writer.
Comment 10 Ross Burton 2013-08-05 10:11:46 UTC
Sorry, mis-read.  Yes, you're agreeing with my comment 2.
Comment 11 Scott Rifenbark 2013-08-05 12:12:20 UTC
Here is a draft of the variable entry for COREBASE:

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#var-COREBASE

Scott
Comment 12 Laszlo Papp 2013-08-05 12:13:34 UTC
I like it, thanks.
Comment 13 Scott Rifenbark 2013-08-05 12:18:01 UTC
Thanks Laszlo for raising the issue.  I will close this tomorrow after it sits a bit in this state. 

Scott
Comment 14 Scott Rifenbark 2013-08-13 06:03:22 UTC
No additional feedback.. closing the bug. 

Scott
Comment 15 Stoicescu Cornel 2013-10-01 13:45:29 UTC
COREBASE variable description was added to the Yocto reference manual.

Setting to VERIFIED.