9671 2016-05-24 15:11:56 +0000 UPSTREAM_CHECK_* variables needs documentation 2016-06-09 16:33:15 +0000 1 1 9 Documentation Reference handbook 2.1 x86 Multiple RESOLVED FIXED 8 June 2016: RESOLVED Medium enhancement 2.2 M2 1 leonardo.sandoval.gonzalez srifenbark alex.kanavin bluelightning maxin.john poky.doc.watcher poky.watcher srifenbark --- --- Done (doc changes complete) oldest_to_newest 62423 0 leonardo.sandoval.gonzalez 2016-05-24 15:11:56 +0000 The variable mentioned on the summary is not documented. It was documented on a include file but finally removed as seen on [1]. The latter can be used as a base for documenting it on the reference manual. [1] http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121766.html 62433 1 alex.kanavin 2016-05-25 11:31:33 +0000 Actually, all three variables should be added. 62441 2 leonardo.sandoval.gonzalez 2016-05-25 14:37:07 +0000 (In reply to comment #1) > Actually, all three variables should be added. Great. I have updated the summary to indicate the set of related variables. 62718 3 srifenbark 2016-06-07 18:05:57 +0000 Hi, Here some very simple definitions for the three variables in the link. Please look these over and think about what the user might need to know in order to apply them. I just based things on that patch that removed the definitions. Also, I am not sure if the "_pn" part should be part of the variable name in the glossary or if that should be in the example only? I could use some explanation on that point. Here are the new definitions: * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_GITTAGREGEX_pn * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_REGEX_pn * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_URI_pn Thanks, Scott 62722 4 bluelightning 2016-06-07 20:54:54 +0000 We don't want _pn on the end of the variable name entries, that's part of the recipe name override. Also, we need to be clear up-front as we are with other class-specific variables that these variables are only used by distrodata.bbclass for checking for new upstream versions - at the moment you're implying that they are used in normal fetching, they definitely aren't. 62734 5 srifenbark 2016-06-07 22:23:41 +0000 Thanks Paul, See the latest here: * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_GITTAGREGEX * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_REGEX * http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_URI Scott 62760 6 alex.kanavin 2016-06-08 10:58:15 +0000 "For recipes inheriting the distrodata class, the UPSTREAM_CHECK_GITTAGREGEX variable causes the OpenEmbedded build system to use Git tabs to determine which upstream release version to fetch when fetching source code from an upstream Git repository." Replace with "For recipes inheriting the distrodata class, a check for what the latest upstream version is can be performed by calling 'bitbake -c checkpkg'. When source code is provided from git repositories, the latest upstream version is determined by picking the latest tag from the list of all repository tags. UPSTREAM_CHECK_GITTAGREGEX can be used to provide a regular expression to filter only the relevant tags, in case the default filter doesn't work correctly". "For recipes inheriting the distrodata class, the UPSTREAM_CHECK_URI variable causes the package checking system to get the latest version of the package when source files are fetched from an upstream Git repository." Replace with "For recipes inheriting the distrodata class, a check for what the latest upstream version is can be performed by calling 'bitbake -c checkpkg'. When the source code is provided from tarballs, the latest version is determined by fetching the directory listing where the tarball is and attempting to find a later tarball. When this approach does not work, UPSTREAM_CHECK_URI can be used to provide a different URI that contains the link to the latest tarball". Also, drop '-recipe' suffix from all three variables. 62762 7 bluelightning 2016-06-08 11:06:11 +0000 Also, recipes don't inherit distrodata, distrodata is supposed to be enabled globally through INHERIT +=. Thus it would be more appropriate to say "When using the distrodata class ..." 62771 8 srifenbark 2016-06-08 15:29:18 +0000 (In reply to comment #6) > "For recipes inheriting the distrodata class, the UPSTREAM_CHECK_GITTAGREGEX > variable causes the OpenEmbedded build system to use Git tabs to determine > which upstream release version to fetch when fetching source code from an > upstream Git repository." > > Replace with "For recipes inheriting the distrodata class, a check for what > the latest upstream version is can be performed by calling 'bitbake -c > checkpkg'. When source code is provided from git repositories, the latest > upstream version is determined by picking the latest tag from the list of > all repository tags. UPSTREAM_CHECK_GITTAGREGEX can be used to provide a > regular expression to filter only the relevant tags, in case the default > filter doesn't work correctly". I used this as a base. We try to keep things as active as possible for the writing style. Look it over and make sure that the changes I made did not alter any technical meaning. > > "For recipes inheriting the distrodata class, the UPSTREAM_CHECK_URI > variable causes the package checking system to get the latest version of the > package when source files are fetched from an upstream Git repository." > > Replace with "For recipes inheriting the distrodata class, a check for what > the latest upstream version is can be performed by calling 'bitbake -c > checkpkg'. When the source code is provided from tarballs, the latest > version is determined by fetching the directory listing where the tarball is > and attempting to find a later tarball. When this approach does not work, > UPSTREAM_CHECK_URI can be used to provide a different URI that contains the > link to the latest tarball". Same thing here. > > Also, drop '-recipe' suffix from all three variables. Dropped from the examples 62772 9 srifenbark 2016-06-08 15:33:09 +0000 So there are some new versions up now... Let me know of further changes. Thanks, Scott 62780 10 alex.kanavin 2016-06-08 17:29:12 +0000 "For recipes that use the distrodata class, this variable causes the OpenEmbedded build system to check for what the latest upstream version is by calling bitbake -c checkpkg." That is not correct. The variable itself does not cause OE build system to check anything. The check happens when the user calls 'bitbake -c checkpkg' and distrodata class is in use globally (not in recipes individually). The variable can be used to adjust the default behavior, but it is not required as such to perform the check. Let's try again: "When distrodata class is enabled globally, a user can perform a check for what the latest upstream version is by calling 'bitbake -c checkpkg <recipe>'. If the recipe source code is provided from git repositories, OE build system determines the latest upstream version by picking the latest tag from the list of all repository tags. You can use the UPSTREAM_CHECK_GITTAGREGEX variable to provide a regular expression to filter only the relevant tags should the default filter not work correctly." "Use the UPSTREAM_CHECK_REGEX variable to specify a different regular expression instead of the default one when the package checking system is parsing the page found using UPSTREAM_CHECK_URI." "When distrodata class is enabled globally, a user can perform a check for what the latest upstream version is by calling 'bitbake -c checkpkg <recipe>'. If the source code is provided from tarballs, the latest version is determined by fetching the directory listing where the tarball is and attempting to find a later tarball. When this approach does not work, you can use UPSTREAM_CHECK_URI to provide a different URI that contains the link to the latest tarball. " 62781 11 srifenbark 2016-06-08 17:52:49 +0000 (In reply to comment #10) > "For recipes that use the distrodata class, this variable causes the > OpenEmbedded build system to check for what the latest upstream version is > by calling bitbake -c checkpkg." > > That is not correct. The variable itself does not cause OE build system to > check anything. The check happens when the user calls 'bitbake -c checkpkg' > and distrodata class is in use globally (not in recipes individually). The > variable can be used to adjust the default behavior, but it is not required > as such to perform the check. My bad... I had that messed up saying the variable caused the OE build system to do that. I have another version based on your suggestions: http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_GITTAGREGEX > > Let's try again: > > "When distrodata class is enabled globally, a user can perform a check for > what the latest upstream version is by calling 'bitbake -c checkpkg > <recipe>'. If the recipe source code is provided from git repositories, OE > build system determines the latest upstream version by picking the latest > tag from the list of all repository tags. You can use the > UPSTREAM_CHECK_GITTAGREGEX variable to provide a regular expression to > filter only the relevant tags should the default filter not work correctly." > > "Use the UPSTREAM_CHECK_REGEX variable to specify a different regular > expression instead of the default one when the package checking system is > parsing the page found using UPSTREAM_CHECK_URI." So I am assuming you wanted this second one for the UPSTREAM_CHECK_REGEX variable and not part of the first one? If not let me know. http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_REGEX > > "When distrodata class is enabled globally, a user can perform a check for > what the latest upstream version is by calling 'bitbake -c checkpkg > <recipe>'. If the source code is provided from tarballs, the latest version > is determined by fetching the directory listing where the tarball is and > attempting to find a later tarball. When this approach does not work, you > can use UPSTREAM_CHECK_URI to provide a different URI that contains the link > to the latest tarball. " See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_URI. 62783 12 alex.kanavin 2016-06-08 18:06:39 +0000 Almost there :) I would only amend the first sentence in _GITTAGREGEX and _URI: "When the distrodata class is enabled globally, you can perform a check for what the latest upstream version is by calling bitbake -c checkpkg. " to say that it's checking the upstream source code version and is used per-recipe: "When the distrodata class is enabled globally, you can perform a per-recipe check for what the latest upstream source code version is by calling bitbake -c checkpkg <recipe>. " 62784 13 srifenbark 2016-06-08 18:20:06 +0000 Ok - Hopefully we have it now... http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_GITTAGREGEX http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_REGEX http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-UPSTREAM_CHECK_URI Thanks --- let me know. 62786 14 alex.kanavin 2016-06-08 18:21:50 +0000 Yep, looks good now. 62843 15 srifenbark 2016-06-09 16:33:15 +0000 Thanks, Updating the bug to RESOLVED and setting the Doc flag to "Done". Scott