diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 5fd51569a3..3e06864f76 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst @@ -328,23 +328,37 @@ Checking on the Upgrade Status of a Recipe Upstream recipes change over time. Consequently, you might find that you need to determine if you can upgrade a recipe to a newer version. -To check on the upgrade status of a recipe, use the -``devtool check-upgrade-status`` command. The command displays a table -of your current recipe versions, the latest upstream versions, the email -address of the recipe's maintainer, and any additional information such -as commit hash strings and reasons you might not be able to upgrade a -particular recipe. +To check on the upgrade status of a recipe, you can use the +``devtool latest-version recipe`` command, which quickly shows the current +version and the latest version available upstream. To get a more global +picture, use the ``devtool check-upgrade-status`` command, which takes a +list of recipes as input, or no arguments, in which case it checks all +available recipes. This command will only print the recipes for which +a new upstream version is available. Each such recipe will have its current +version and latest upstream version, as well as the email of the maintainer +and any additional information such as the commit hash or reason for not +being able to upgrade it, displayed in a table. + +This upgrade checking mechanism relies on the optional :term:`UPSTREAM_CHECK_URI`, +:term:`UPSTREAM_CHECK_REGEX`, :term:`UPSTREAM_CHECK_GITTAGREGEX`, +:term:`UPSTREAM_CHECK_COMMITS` and :term:`UPSTREAM_VERSION_UNKNOWN` +variables in package recipes. .. note:: + - Most of the time, the above variables are unnecessary. They are only + required when upstream does something unusual, and default + mechanisms cannot find the new upstream versions. + - For the ``oe-core`` layer, recipe maintainers come from the :yocto_git:`maintainers.inc ` file. - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` - rather than a - tarball, the commit hash points to the commit that matches the - recipe's latest version tag. + rather than a tarball, the commit hash points to the commit that matches + the recipe's latest version tag, or in the absence of suitable tags, + to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1`` + in the recipe). As with all ``devtool`` commands, you can get help on the individual command:: @@ -393,6 +407,10 @@ satisfied. NOTE: busybox 1.29.2 1.30.0 Andrej Valek NOTE: dbus-test 1.12.10 1.12.12 Chen Qi +Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` +in a recipe when there's currently no way to determine its latest upstream +version. + .. _devtool-upgrading-a-recipe: Upgrading a Recipe