10138 2016-08-13 06:51:48 +0000 Small suggested version/revision-related clarifications 2016-08-22 23:03:23 +0000 1 1 9 Documentation Reference handbook 2.2 x86 Multiple RESOLVED FIXED 22 August 2016: RESOLVED Medium normal 2.2 M4 1 ulfalizer srifenbark bluelightning poky.doc.watcher poky.watcher sgw srifenbark --- --- Done (doc changes complete) oldest_to_newest 65173 0 ulfalizer 2016-08-13 06:51:48 +0000 Hello! Here's some more suggested changes. They try to make it clearer how the various version/revision-related variables connect. * Change the PKGV glossary entry to the following. "Recipe" is more specific than "OpenEmbedded build system" in this case. PKGV: The version of the output package(s) built by the recipe. By default, PKGV is set to [PV]. * Add the following paragraph to the PV glossary entry: PV is the default value of the [PKGV] variable. * Add the following paragraph to the PE glossary entry: PE is the default value of the [PKGE] variable. * Change the first note in the PR glossary entry to the following. The new link for "stamp" (note that it's lowercase now) actually explains what the stamps do, which the old one didn't. The 'shared state cache' link stays the same. PR: The OpenEmbedded build system does not need the aid of PR to know when to rebuild a recipe. The build system uses task [input checksums](http://www.yoctoproject.org/docs/2.2/bitbake-user-manual/bitbake-user-manual.html#checksums) along with the [stamp](http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#structure-build-tmp-stamps) and [shared state cache] mechanisms. Cheers, Ulf 65187 1 ulfalizer 2016-08-15 11:13:06 +0000 Guess the checksum link within the same manual could be used instead: http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#checksums Kinda ugly how that section is (more or less) duplicated in both manuals. Cheers, Ulf 65188 2 ulfalizer 2016-08-15 11:20:35 +0000 Hmm... I think I prefer the version in the BitBake User Manual though, so never mind. The one in the reference manual makes it sound like the checksums are only about the sstate cache, but they're also used to determine if non-sstate tasks should be rerun. Cheers, Ulf 65408 3 srifenbark 2016-08-22 17:55:40 +0000 Hi Ulf, Have not been able to get to these until now. Been busy in the Eclipse world :( See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PKGV for the PKGV change. See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PV for the PV change. See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PE for the PE change. See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PR for the PR note change. For the reference to "stamp", I left it unformatted as the actual name of the directory seems to be "stamps". So I figured it was a general reference to that particular mechanism. BTW - there is some duplication between the BitBake manual and the YP reference manual. One thing we do not do is reference from the BB manual into any YP manuals. We do, however, reference from YP manuals into the BB manual. Sometimes topics differ between the two manuals. I don't know if that is the case here. It might just be the same information with the BB version being better. I will look into that. Scott 65409 4 ulfalizer 2016-08-22 18:45:18 +0000 Hello, (In reply to comment #3) > Hi Ulf, > > Have not been able to get to these until now. Been busy in the Eclipse > world :( No worries. For a while I thought you were on vacation. :) > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PKGV > for the PKGV change. "The version of the package(s) built by the recipe" would be better since a recipe can build more than one package. "Output package" is a bit redundant in retrospect, so I removed the "output" part too. > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PV > for the PV change. Looks good to me. > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PE > for the PE change. Looks good. One more suggested change: To make the PKGE glossary entry consistent with PKGV, the beginning could be changed to this: The epoch of the package(s) built by the recipe. > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PR > for the PR note change. For the reference to "stamp", I left it unformatted > as the actual name of the directory seems to be "stamps". So I figured it > was a general reference to that particular mechanism. Yeah, that makes sense to me. The same change as mentioned above for PKGE could be made for PKGR too, changing the beginning to the following: The revision of the output package(s) built by the recipe. > BTW - there is some duplication between the BitBake manual and the YP > reference manual. One thing we do not do is reference from the BB manual > into any YP manuals. We do, however, reference from YP manuals into the BB > manual. Sometimes topics differ between the two manuals. I don't know if > that is the case here. It might just be the same information with the BB > version being better. I will look into that. I think it's mostly that the BB manual doesn't talk as much about the sstate cache. I guess that makes sense in a way, since most of the sstate logic is implemented at a higher level. BitBake itself only provides the basic setscene magic. I prefer the BB manual in this case, since task checksums aren't just for determining if sstate tasks need to be rerun. Cheers, Ulf 65422 5 srifenbark 2016-08-22 22:21:50 +0000 (In reply to comment #4) > Hello, > > (In reply to comment #3) > > Hi Ulf, > > > > Have not been able to get to these until now. Been busy in the Eclipse > > world :( > > No worries. For a while I thought you were on vacation. :) > > > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PKGV > > for the PKGV change. > > "The version of the package(s) built by the recipe" would be better since a > recipe can build more than one package. "Output package" is a bit redundant > in retrospect, so I removed the "output" part too. Ok - changed that. > > > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PV > > for the PV change. > > Looks good to me. > > > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PE > > for the PE change. > > Looks good. > > One more suggested change: To make the PKGE glossary entry consistent with > PKGV, the beginning could be changed to this: > > The epoch of the package(s) built by the recipe. Changed that also. > > > See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PR > > for the PR note change. For the reference to "stamp", I left it unformatted > > as the actual name of the directory seems to be "stamps". So I figured it > > was a general reference to that particular mechanism. > > Yeah, that makes sense to me. > > The same change as mentioned above for PKGE could be made for PKGR too, > changing the beginning to the following: > > The revision of the output package(s) built by the recipe. Changed that as well. > > > BTW - there is some duplication between the BitBake manual and the YP > > reference manual. One thing we do not do is reference from the BB manual > > into any YP manuals. We do, however, reference from YP manuals into the BB > > manual. Sometimes topics differ between the two manuals. I don't know if > > that is the case here. It might just be the same information with the BB > > version being better. I will look into that. > > I think it's mostly that the BB manual doesn't talk as much about the sstate > cache. I guess that makes sense in a way, since most of the sstate logic is > implemented at a higher level. BitBake itself only provides the basic > setscene magic. > > I prefer the BB manual in this case, since task checksums aren't just for > determining if sstate tasks need to be rerun. > > Cheers, > Ulf 65425 6 ulfalizer 2016-08-22 22:55:59 +0000 Getting slightly OCD now, but PKGR still says "output package(s)" rather than just "package(s)". :P Looks fine other than that, Ulf 65427 7 srifenbark 2016-08-22 23:00:33 +0000 Sorry man... see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PKGR 65428 8 ulfalizer 2016-08-22 23:02:24 +0000 LGTM :) 65430 9 srifenbark 2016-08-22 23:03:23 +0000 Set to RESOLVED and put doc flag to "done." scott