ref-manual: improve "devtool check-upgrade-status" details

- Mention "devtool latest-version recipe" to process a single version
- Explain that the mechanism is controlled by the UPSTREAM_CHECK*
  variables, which are not referred to anywhere else in the manuals,
  except in the variable index.

(From yocto-docs rev: eded237f1a1ec7df3f9910242bfa4b3818ff3e58)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Alexander Kanavin <alex.kanavin@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2021-09-15 11:04:32 +02:00
committed by Richard Purdie
parent b931182b5b
commit 6c5986ebfe

View File

@@ -328,23 +328,37 @@ Checking on the Upgrade Status of a Recipe
Upstream recipes change over time. Consequently, you might find that you Upstream recipes change over time. Consequently, you might find that you
need to determine if you can upgrade a recipe to a newer version. need to determine if you can upgrade a recipe to a newer version.
To check on the upgrade status of a recipe, use the To check on the upgrade status of a recipe, you can use the
``devtool check-upgrade-status`` command. The command displays a table ``devtool latest-version recipe`` command, which quickly shows the current
of your current recipe versions, the latest upstream versions, the email version and the latest version available upstream. To get a more global
address of the recipe's maintainer, and any additional information such picture, use the ``devtool check-upgrade-status`` command, which takes a
as commit hash strings and reasons you might not be able to upgrade a list of recipes as input, or no arguments, in which case it checks all
particular recipe. 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:: .. 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 - For the ``oe-core`` layer, recipe maintainers come from the
:yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>`
file. file.
- If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)`
rather than a rather than a tarball, the commit hash points to the commit that matches
tarball, the commit hash points to the commit that matches the the recipe's latest version tag, or in the absence of suitable tags,
recipe's latest version tag. 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 As with all ``devtool`` commands, you can get help on the individual
command:: command::
@@ -393,6 +407,10 @@ satisfied.
NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com> NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com>
NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com> NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com>
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: .. _devtool-upgrading-a-recipe:
Upgrading a Recipe Upgrading a Recipe